Users: delete

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.

Request

HTTP request

DELETE /v2/accounts/{accountId}/users

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID Guid.

Optional Query Parameters
deletestring

Request Body

userInfoList

Responses

CodeDescriptionReference
200

Successful response.

GroupUsers
400

Error encountered.

errorDetails

SDK Method

Users::delete

Definitions

errorDetails
userInfo
userInfoList
GroupUsers

Examples

Generic JSON Request/Response
Generic XML Request/Response