Users

Closes one or more users in the account

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

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.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

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

Query Parameters

delete?string

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

  • Groups
  • PermissionSet
  • SigningGroupsEmail

Response Body

application/json

application/json

curl -X DELETE "https://example.com/v2.1/accounts/string/users"
{  "endPosition": "string",  "nextUri": "string",  "previousUri": "string",  "resultSetSize": "string",  "startPosition": "string",  "totalSetSize": "string",  "users": [    {      "accountId": "string",      "accountName": "string",      "activationAccessCode": "string",      "email": "string",      "errorDetails": {        "errorCode": "string",        "message": "string"      },      "ipAddress": "string",      "loginStatus": "string",      "membershipId": "string",      "sendActivationEmail": "string",      "uri": "string",      "userId": "string",      "userName": "string",      "userStatus": "string",      "userType": "string"    }  ]}

Adds new users to the specified account POST

Adds new users to an account. The body of this request is an array of `newUsers` objects. For each new user, you must provide at least the `userName` and `email` properties. The maximum number of users you can create in one request is 500 users. The `userSettings` property specifies the actions users can perform. In the example below, Tal Mason will be able to send envelopes, and the activation email will be in French because the `locale` is set to `fr`. ``` POST /restapi/v2.1/accounts/{accountId}/users Content-Type: application/json ``` ``` { "newUsers": [ { "userName": "Claire Horace", "email": "claire@example.com" }, { "userName": "Tal Mason", "email": "talmason@example.com", "company": "TeleSel", "userSettings": { "locale": "fr", "canSendEnvelope": true } } ] } ``` A successful response is a `newUsers` array with information about the newly created users. If there was a problem in creating a user, that user entry will contain an `errorDetails` property that describes what went wrong. ```json { "newUsers": [ { "userId": "18f3be12-xxxx-xxxx-xxxx-883d8f9b8ade", "uri": "/users/18f3be12-xxxx-xxxx-xxxx-883d8f9b8ade", "email": "claire@example.com", "userName": "Claire Horace", "createdDateTime": "0001-01-01T08:00:00.0000000Z", "errorDetails": { "errorCode": "USER_ALREADY_EXISTS_IN_ACCOUNT", "message": "Username and email combination already exists for this account." } }, { "userId": "be9899a3-xxxx-xxxx-xxxx-2c8dd7156e33", "uri": "/users/be9899a3-xxxx-xxxx-xxxx-2c8dd7156e33", "email": "talmason@example.com", "userName": "Tal Mason", "userStatus": "ActivationSent", "createdDateTime": "2020-05-26T23:25:30.7330000Z" } ] } ```

Changes one or more users in the specified account PUT

This method updates the information about one or more account users.