docusign.user-profiles.put-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.

Updates the user profile information for the specified user.

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
`base_url`	string	Yes	—	Docusign API root, e.g. https://<host>/api
`api_token`	string	No	—	Bearer token; omit to use the workflow's token env var
`accountid`	string	Yes	—	The external account number (int) or account ID GUID.
`userid`	string	Yes	—	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.
`address`	json	No	—	Contains address information.
`authenticationmethods`	list	No	—	Indicates the authentication methods that the user uses. These properties cannot be modified by the PUT operation.
`companyname`	string	No	—	The name of the user's company.
`displayorganizationinfo`	string	No	—	When true, the user's company and title information display on the ID card.
`displaypersonalinfo`	string	No	—	When true, the user's address and phone number display on the ID card.
`displayprofile`	string	No	—	When true, the user's ID card can be viewed from signed documents and envelope history.
`displayusagehistory`	string	No	—	When true, the user's usage information displays on the ID card.
`profileimageuri`	string	No	—	The URL for retrieving the user's profile image.
`title`	string	No	—	The title of the user.
`usagehistory`	json	No	—	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`	json	No	—	User information.
`userprofilelastmodifieddate`	string	No	—	The date and time that the user's profile was last modified.

Output Schema

Field	Type	Required	Default	Description
`base_url`	string	Yes	—	Docusign API root, e.g. https://<host>/api
`api_token`	string	No	—	Bearer token; omit to use the workflow's token env var
`accountid`	string	Yes	—	The external account number (int) or account ID GUID.
`userid`	string	Yes	—	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.
`address`	json	No	—	Contains address information.
`authenticationmethods`	list	No	—	Indicates the authentication methods that the user uses. These properties cannot be modified by the PUT operation.
`companyname`	string	No	—	The name of the user's company.
`displayorganizationinfo`	string	No	—	When true, the user's company and title information display on the ID card.
`displaypersonalinfo`	string	No	—	When true, the user's address and phone number display on the ID card.
`displayprofile`	string	No	—	When true, the user's ID card can be viewed from signed documents and envelope history.
`displayusagehistory`	string	No	—	When true, the user's usage information displays on the ID card.
`profileimageuri`	string	No	—	The URL for retrieving the user's profile image.
`title`	string	No	—	The title of the user.
`usagehistory`	json	No	—	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`	json	No	—	User information.
`userprofilelastmodifieddate`	string	No	—	The date and time that the user's profile was last modified.
`status_code`	integer	No	—	HTTP status code of the completed call
`response`	json	No	—	Parsed JSON response body
`failure_reason`	string	No	—	—
`failure_type`	string	No	—	—
`failed_at`	string	No	—	—
`failed_step`	string	No	—	—
`failed_layer`	string	No	—	—
`failed_at_state`	string	No	—	—
`error`	string	No	—	—
`error_type`	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
`pending`	Yes	No	—	`execute`	Waiting to call PUT /v2.1/accounts/{accountId}/users/{userId}/profile
`completed`	No	Yes	Yes	—	HTTP call succeeded
`failed`	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
`pending`	`execute`	`completed`	Perform PUT /v2.1/accounts/{accountId}/users/{userId}/profile
`*` (any state)	`fail`	`failed`	Record the failure reason

API Usage

bash

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.user-profiles.put-profile",
  "initial_data": {
    "base_url": "value",
    "accountid": "value",
    "userid": "value"
  }
}

docusign.user-profiles.put-profile ​

Overview ​

Input Schema ​

Output Schema ​

States ​

State Diagram ​

Transitions ​

API Usage ​