UserProfiles Resource

The UserProfiles resource provides methods that allow you to manage a user’s profile.

Methods supported

Method	Description
get	GET `/restapi/v2.1/accounts/{accountId}/users/{userId}/profile` Retrieves the user profile for a specified user.
update	PUT `/restapi/v2.1/accounts/{accountId}/users/{userId}/profile` Updates the user profile information for the specified user.

Property	Type	Description
`address`	addressInformation	The user’s address.
`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 user’s job title. Limit: 100 characters.
`usageHistory`	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`	userInformation	Detailed information about the user.
`userProfileLastModifiedDate`	string	The date and time that the user’s profile was last modified.