Docusign eSignature API
Docusign Developer CenterGet a developer account
HomeAPI ReferenceSDKsContext Plugin
User Profiles

Updates the user profile information for the specified user

PUT
/v2.1/accounts/{accountId}/users/{userId}/profile

Updates the user's detail information, profile information, privacy settings, and personal information in the user ID card.

You can also change a user's name by changing the information in the userDetails property. When changing a user's name, you can either change the information in the userName property OR change the information in firstName, middleName, lastName, suffixName, and title properties. Changes to firstName, middleName, lastName, suffixName, and title properties take precedence over changes to the userName property.

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.

userId*string

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.

Request Body

application/json

address?

Contains address information.

authenticationMethods?array<>

Indicates the authentication methods that the user uses. These properties cannot be modified by the PUT operation.

companyName?string

The name of the user's company.

displayOrganizationInfo?string

When true, the user's company and title information display on the ID card.

displayPersonalInfo?string

When true, the user's address and phone number display on the ID card.

displayProfile?string

When true, the user's ID card can be viewed from signed documents and envelope history.

displayUsageHistory?string

When true, the user's usage information displays on the ID card.

profileImageUri?string

The URL for retrieving the user's profile image.

title?string

The title of the user.

usageHistory?

A complex element consisting of:

  • lastSentDateTime - the date and time the user last sent an envelope.
  • lastSignedDateTime - the date and time the user last signed an envelope.
  • sentCount - the number of envelopes the user has sent.
  • signedCount - the number of envelopes the user has signed.
userDetails?

User information.

userProfileLastModifiedDate?string

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

Response Body

application/json

curl -X PUT "https://example.com/v2.1/accounts/string/users/string/profile" \  -H "Content-Type: application/json" \  -d '{}'
Empty

Retrieves the user profile for a specified user GET

Retrieves the user profile information, the privacy settings and personal information (address, phone number, etc.) for the specified user. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.

Retrieves the list of users for the specified account. You can filter the users list to get specific users GET

Retrieves the list of users for the specified account. The response returns the list of users for the account, with information about the result set. If the `additional_info` query is added to the endpoint and set to **true,** full user information is returned for each user.