Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
Users

Updates user information for the specified user.

To update user information for a specific user, submit a Users object with updated field values in the request body of this operation.

put/v2.1/accounts/{accountId}/users/{userId}

Path parameters

accountIdstring required

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

userIdstring required

The ID of the user to access.

Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.

Query parameters

allow_all_languagesstring

Request body

activationAccessCodestring

Access code provided to the user to activate the account.

companystring

The name of the user's company.

countryCodestring

The two-letter code for the user's country.

createdDateTimestring

The UTC DateTime when the item was created.

defaultAccountIdstring

The default account ID associated with the user.

emailstring

The user's email address.

This property cannot be updated via PUT requests.

enableConnectForUserstring

Boolean value that specifies whether the user is enabled for updates from Docusign Connect.

firstNamestring

The user's first name. Maximum Length: 50 characters.

hasRemoteNotaryboolean
initialsImageUristring

The URI for retrieving the image of the user's initials.

isAdminstring

When true, the user is an administrator.

isAlternateAdminstring

When true, the user is an alternate administrator. This user is not an administrator but will be set as such if all administrator memberships are closed.

isManagedByScimstring
isMembershipManagedByScimstring
isNAREnabledstring

When true, National Association of Realtors (NAR) signature logos are enabled for the user.

jobTitlestring

The user's job title.

lastLoginstring

This property has been deprecated.

lastNamestring

The user's last name. Maximum Length: 50 characters.

licenseStatusstring
licenseTypestring
loginStatusstring

Boolean value that indicates whether the user is currently logged in or not.

middleNamestring

The user's middle name. Limit: 50 characters.

passwordstring

The user's password.

This property is used only when adding a new user via a Users: create request. The value must conform to the password rules defined in the account Security Settings.

This property is not returned by GET requests and cannot be updated via PUT requests.

passwordExpirationstring

If password expiration is enabled, the date-time when the user's password expires.

permissionProfileIdstring

The ID of the permission profile.

Use AccountPermissionProfiles: list to get a list of permission profiles and their IDs.

You can also download a CSV file of all permission profiles and their IDs from the Settings > Permission Profiles page of your eSignature account page.

permissionProfileNamestring

The name of the account permission profile.

Example: Account Administrator

profileImageUristring

The URL for retrieving the user's profile image.

sendActivationEmailstring

This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following these steps.

sendActivationOnInvalidLoginstring

When true, specifies that an additional activation email be sent if user's log on fails before the account is activated.

signatureImageUristring

An endpoint URI that you can use to retrieve the user's signature image.

subscribestring
suffixNamestring

The suffix for the user's name, such as Jr, IV, PhD, etc.

Limit: 50 characters.

titlestring

The title of the user.

uristring

A URI containing the user ID.

userAddedToAccountDateTimestring

The date and time that the user was added to the account.

userIdstring

The ID of the user to access.

Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.

userNamestring

The name of the user.

userProfileLastModifiedDatestring

The date and time that the user's profile was last modified.

userStatusstring

Status of the user's account. One of:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled
userTypestring

The type of user, for example CompanyUser.

Response

Successful response.