v1

latestSwagger 2.02026-07-134146194.6 MB
Users

Closes one or more users in the account.

Closes one or more users in the account, preventing them from accessing account features. Users are not permanently deleted.

The request body requires only the IDs of the users to close:

{
    "users": [
        { "userId": "6b67a1ee-xxxx-xxxx-xxxx-385763624163" },
        { "userId": "b6c74c52-xxxx-xxxx-xxxx-457a81d88926" },
        { "userId": "464f7988-xxxx-xxxx-xxxx-781ee556ab7a" }
    ]
}

You can use Users:update to re-open a closed user.

delete/v2.1/accounts/{accountId}/users

Path parameters

accountIdstring required

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

Query parameters

deletestring

A list of groups to remove the user from. A comma-separated list of the following:

  • Groups
  • PermissionSet
  • SigningGroupsEmail

Request body

Response

Successful response.