Users: closeMemberships

Required scopes: user_write

Closes a user's memberships.

Request

HTTP request

DELETE /v2/organizations/{organizationId}/users/{userId}/accounts

Parameters

Parameter NameValueDescription
Path Parameters
organizationIdstring

The organization ID Guid

userIdstring

The user ID Guid

Request Body

request

SDK Method

Users::closeMemberships

Definitions

DocuSign.API.Organizations.Web.Models.RestApi.Common.ErrorDetails

Errors.

errorstring

Short description of the error.

error_descriptionstring

A longer description of the error.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Request.DeleteMembershipsRequest

A list of accounts to close for a user.

accounts[DocuSign.API.Organizations.Web.Models.RestApi.v2.Request.DeleteMembershipRequest]

A list of accounts to close for a user.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Request.DeleteMembershipRequest

idstring

The ID of a user's account you want to close.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.DeleteMembershipsResponse

The results of closing a user's account.

successboolean

If true, the request to close the accounts succeeded.

accounts[DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.DeleteMembershipResponse]

A list of accounts that were closed.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.DeleteMembershipResponse

Results of closing accounts.

idstring

The ID of the account that could not be closed.

error_detailsDocuSign.API.Organizations.Web.Models.RestApi.Common.ErrorDetails

Error results.

}} />