This closes one or more user records in the account. Users are never deleted from an account, but closing a user prevents them from using account functions.
The response returns whether the API execution was successful (200 - OK) or if it failed. The response contains a user structure similar to the request and includes the user changes. If an error occurred during the DELETE operation for any of the users, the response for that user contains an errorDetails node with errorCode and message properties.
DELETE /v2/accounts/{accountId}/users| Parameter Name | Value | Description |
|---|---|---|
| Path Parameters | ||
| accountId | string | The external account number (int) or account ID Guid. |
| Optional Query Parameters | ||
| delete | string | |
| Code | Description | Reference |
|---|---|---|
| 200 | Successful response. | GroupUsers |
| 400 | Error encountered. | errorDetails |
This object describes errors that occur. It is only valid for responses, and ignored in requests. | ||
errorCode | string | An error code associated with the error. |
message | string | A short error message. |
activationAccessCode | string | |
email | string | |
errorDetails | errorDetails | |
loginStatus | string | |
sendActivationEmail | string | |
uri | string | |
userId | string | The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. Note: For GET /v2/accounts/{accountId}/envelopes |
userName | string | |
userStatus | string | Status of the user's account. One of:
|
userType | string | |
users | [userInfo] | |
Groups' users | ||
endPosition | string | The last position in the result set. |
nextUri | string | The URI for the next chunk of records based on the search request. It is |
previousUri | string | The URI for the prior chunk of records based on the search request. It is |
resultSetSize | string | The number of results returned in this response. |
startPosition | string | Starting position of the current result set. |
totalSetSize | string | The total number of items in the search's result set. It will always be greater than or equal to the value of the |
users | [userInfo] | |
{
"users": [
{
"userName": "sample string 1",
"userId": "sample string 2",
"email": "sample string 3",
"userType": "sample string 4",
"userStatus": "sample string 5",
"uri": "sample string 6",
"loginStatus": "sample string 7",
"sendActivationEmail": "sample string 8",
"activationAccessCode": "sample string 9"
}
]
}
{
"users": [
{
"userName": "sample string 1",
"userId": "sample string 2",
"email": "sample string 3",
"userType": "sample string 4",
"userStatus": "sample string 5",
"uri": "sample string 6",
"loginStatus": "sample string 7",
"sendActivationEmail": "sample string 8",
"activationAccessCode": "sample string 9",
"errorDetails": {
"errorCode": "sample string 1",
"message": "sample string 2"
}
}
],
"resultSetSize": "sample string 1",
"totalSetSize": "sample string 2",
"startPosition": "sample string 3",
"endPosition": "sample string 4",
"nextUri": "sample string 5",
"previousUri": "sample string 6"
}
<userInfoList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
<users>
<userInfo>
<activationAccessCode>sample string 9</activationAccessCode>
<email>sample string 3</email>
<loginStatus>sample string 7</loginStatus>
<sendActivationEmail>sample string 8</sendActivationEmail>
<uri>sample string 6</uri>
<userId>sample string 2</userId>
<userName>sample string 1</userName>
<userStatus>sample string 5</userStatus>
<userType>sample string 4</userType>
</userInfo>
</users>
</userInfoList> <usersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
<endPosition>sample string 4</endPosition>
<nextUri>sample string 5</nextUri>
<previousUri>sample string 6</previousUri>
<resultSetSize>sample string 1</resultSetSize>
<startPosition>sample string 3</startPosition>
<totalSetSize>sample string 2</totalSetSize>
<users>
<userInfo>
<activationAccessCode>sample string 9</activationAccessCode>
<email>sample string 3</email>
<errorDetails>
<errorCode>sample string 1</errorCode>
<message>sample string 2</message>
</errorDetails>
<loginStatus>sample string 7</loginStatus>
<sendActivationEmail>sample string 8</sendActivationEmail>
<uri>sample string 6</uri>
<userId>sample string 2</userId>
<userName>sample string 1</userName>
<userStatus>sample string 5</userStatus>
<userType>sample string 4</userType>
</userInfo>
</users>
</usersResponse>