Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
UserProfiles

Updates the user profile information for the specified user.

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.

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

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.

Request body

companyNamestring

The name of the user's company.

displayOrganizationInfostring

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

displayPersonalInfostring

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

displayProfilestring

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

displayUsageHistorystring

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

profileImageUristring

The URL for retrieving the user's profile image.

titlestring

The title of the user.

userProfileLastModifiedDatestring

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

Response

Successful response.