Updates user information for the specified user.
Changed onTo update user information for a specific user, submit a Users object with updated field values in the request body of this operation.
Request
- Base URLhttps://www.docusign.net/restapi
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
The external account number (int) or account ID GUID.
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
Request body
Access code provided to the user to activate the account.
The name of the user's company.
The two-letter code for the user's country.
The UTC DateTime when the item was created.
The default account ID associated with the user.
The user's email address.
This property cannot be updated via PUT requests.
Boolean value that specifies whether the user is enabled for updates from Docusign Connect.
The user's first name. Maximum Length: 50 characters.
The URI for retrieving the image of the user's initials.
When true, the user is an administrator.
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.
When true, National Association of Realtors (NAR) signature logos are enabled for the user.
The user's job title.
This property has been deprecated.
The user's last name. Maximum Length: 50 characters.
Boolean value that indicates whether the user is currently logged in or not.
The user's middle name. Limit: 50 characters.
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.
If password expiration is enabled, the date-time when the user's password expires.
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.
The name of the account permission profile.
Example: Account Administrator
The URL for retrieving the user's profile image.
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.
When true, specifies that an additional activation email be sent if user's log on fails before the account is activated.
An endpoint URI that you can use to retrieve the user's signature image.
The suffix for the user's name, such as Jr, IV, PhD, etc.
Limit: 50 characters.
The title of the user.
A URI containing the user ID.
The date and time that the user was added to the account.
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.
The name of the user.
The date and time that the user's profile was last modified.
Status of the user's account. One of:
- ActivationRequired
- ActivationSent
- Active
- Closed
- Disabled
The type of user, for example CompanyUser.
Response
Successful response.
Access code provided to the user to activate the account.
The name of the user's company.
The two-letter code for the user's country.
The UTC DateTime when the item was created.
The default account ID associated with the user.
The user's email address.
This property cannot be updated via PUT requests.
Boolean value that specifies whether the user is enabled for updates from Docusign Connect.
The user's first name. Maximum Length: 50 characters.
The URI for retrieving the image of the user's initials.
When true, the user is an administrator.
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.
When true, National Association of Realtors (NAR) signature logos are enabled for the user.
The user's job title.
This property has been deprecated.
The user's last name. Maximum Length: 50 characters.
Boolean value that indicates whether the user is currently logged in or not.
The user's middle name. Limit: 50 characters.
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.
If password expiration is enabled, the date-time when the user's password expires.
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.
The name of the account permission profile.
Example: Account Administrator
The URL for retrieving the user's profile image.
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.
When true, specifies that an additional activation email be sent if user's log on fails before the account is activated.
An endpoint URI that you can use to retrieve the user's signature image.
The suffix for the user's name, such as Jr, IV, PhD, etc.
Limit: 50 characters.
The title of the user.
A URI containing the user ID.
The date and time that the user was added to the account.
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.
The name of the user.
The date and time that the user's profile was last modified.
Status of the user's account. One of:
- ActivationRequired
- ActivationSent
- Active
- Closed
- Disabled
The type of user, for example CompanyUser.
Changes
- info
added the new optional
queryrequest parameterallow_all_languages
- info
- warning
deleted the
queryrequest parameterallow_all_languages
- warning