Docusign eSignature API
Docusign Developer CenterGet a developer account
HomeAPI ReferenceSDKsContext Plugin
Users

Updates user information for the specified user

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

To update user information for a specific user, submit a Users object with updated field values in the request body of this operation.

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.

Query Parameters

allow_all_languages?string

Request Body

application/json

User information.

activationAccessCode?string

Access code provided to the user to activate the account.

company?string

The name of the user's company.

connectConfigurations?array<>

Object representing the user's custom Connect configuration.

countryCode?string

The two-letter code for the user's country.

createdDateTime?string

The UTC DateTime when the item was created.

customSettings?array<>

The name/value pair information for the user custom setting.

defaultAccountId?string

The default account ID associated with the user.

email?string

The user's email address.

This property cannot be updated via PUT requests.

enableConnectForUser?string

Boolean value that specifies whether the user is enabled for updates from Docusign Connect.

errorDetails?

This object describes errors that occur. It is only valid for responses and ignored in requests.

firstName?string

The user's first name. Maximum Length: 50 characters.

forgottenPasswordInfo?

A complex element that has up to four Question/Answer pairs for forgotten password information.

groupList?array<>

A list of the group information for groups to add the user to. Use UserGroups: listGroups to get information about groups.

When setting a user's group, only the groupId is required.

hasRemoteNotary?boolean
homeAddress?

Contains address information.

initialsImageUri?string

The URI for retrieving the image of the user's initials.

isAdmin?string

When true, the user is an administrator.

isAlternateAdmin?string

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.

isManagedByScim?string
isMembershipManagedByScim?string
isNAREnabled?string

When true, National Association of Realtors (NAR) signature logos are enabled for the user.

jobTitle?string

The user's job title.

lastLogin?string

This property has been deprecated.

lastName?string

The user's last name. Maximum Length: 50 characters.

licenseStatus?string
licenseType?string
loginStatus?string

Boolean value that indicates whether the user is currently logged in or not.

middleName?string

The user's middle name. Limit: 50 characters.

password?string

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.

passwordExpiration?string

If password expiration is enabled, the date-time when the user's password expires.

permissionProfileId?string

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.

permissionProfileName?string

The name of the account permission profile.

Example: Account Administrator

profileImageUri?string

The URL for retrieving the user's profile image.

sendActivationEmail?string

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.

sendActivationOnInvalidLogin?string

When true, specifies that an additional activation email be sent if user's log on fails before the account is activated.

signatureImageUri?string

An endpoint URI that you can use to retrieve the user's signature image.

subscribe?string
suffixName?string

The suffix for the user's name, such as Jr, IV, PhD, etc.

Limit: 50 characters.

title?string

The title of the user.

uri?string

A URI containing the user ID.

userAddedToAccountDateTime?string

The date and time that the user was added to the account.

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.

userName?string

The name of the user.

userProfileLastModifiedDate?string

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

userSettings?

Properties that configure the settings for a user. Some elements of this object have a metadata property, which includes the following:

  • rights: The calling users permissions to edit this setting (can be editable or read_only)
  • uiHint: Internally used to build UIs (can be available or hidden)
  • options: The values supported for this setting (not all settings have this element)
userStatus?string

Status of the user's account. One of:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled
userType?string

The type of user, for example CompanyUser.

workAddress?

Contains address information.

Response Body

application/json

application/json

curl -X PUT "https://example.com/v2.1/accounts/string/users/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "activationAccessCode": "string",  "company": "string",  "connectConfigurations": [    {      "configurationtype": "string",      "connectId": "string",      "enabled": "string",      "hasAccess": "string",      "senderSearchableItems": [        "string"      ]    }  ],  "countryCode": "string",  "createdDateTime": "string",  "customSettings": [    {      "errorDetails": {        "errorCode": "string",        "message": "string"      },      "name": "string",      "originalValue": "string",      "value": "string"    }  ],  "defaultAccountId": "string",  "email": "string",  "enableConnectForUser": "string",  "errorDetails": {    "errorCode": "string",    "message": "string"  },  "firstName": "string",  "forgottenPasswordInfo": {    "forgottenPasswordAnswer1": "string",    "forgottenPasswordAnswer2": "string",    "forgottenPasswordAnswer3": "string",    "forgottenPasswordAnswer4": "string",    "forgottenPasswordQuestion1": "string",    "forgottenPasswordQuestion2": "string",    "forgottenPasswordQuestion3": "string",    "forgottenPasswordQuestion4": "string"  },  "groupList": [    {      "accessType": "string",      "dsGroupId": "string",      "errorDetails": {        "errorCode": "string",        "message": "string"      },      "groupId": "string",      "groupName": "string",      "groupType": "string",      "isManagedByScim": true,      "lastModifiedOn": "string",      "permissionProfileId": "string",      "userGroupType": "string",      "users": [        {          "accountId": "string",          "accountName": "string",          "activationAccessCode": "string",          "email": "string",          "errorDetails": {            "errorCode": "string",            "message": "string"          },          "ipAddress": "string",          "loginStatus": "string",          "membershipId": "string",          "sendActivationEmail": "string",          "uri": "string",          "userId": "string",          "userName": "string",          "userStatus": "string",          "userType": "string"        }      ],      "usersCount": "string"    }  ],  "hasRemoteNotary": true,  "homeAddress": {    "address1": "string",    "address2": "string",    "city": "string",    "country": "string",    "fax": "string",    "phone": "string",    "postalCode": "string",    "stateOrProvince": "string",    "zipPlus4": "string"  },  "initialsImageUri": "string",  "isAdmin": "string",  "isAlternateAdmin": "string",  "isManagedByScim": "string",  "isMembershipManagedByScim": "string",  "isNAREnabled": "string",  "jobTitle": "string",  "lastLogin": "string",  "lastName": "string",  "licenseStatus": "string",  "licenseType": "string",  "loginStatus": "string",  "middleName": "string",  "password": "string",  "passwordExpiration": "string",  "permissionProfileId": "string",  "permissionProfileName": "string",  "profileImageUri": "string",  "sendActivationEmail": "string",  "sendActivationOnInvalidLogin": "string",  "signatureImageUri": "string",  "subscribe": "string",  "suffixName": "string",  "title": "string",  "uri": "string",  "userAddedToAccountDateTime": "string",  "userId": "string",  "userName": "string",  "userProfileLastModifiedDate": "string",  "userSettings": {    "accountAgreementsAccessType": "string",    "accountManagementGranular": {      "canManageAccountSecuritySettings": "string",      "canManageAccountSettings": "string",      "canManageAdmins": "string",      "canManageConnect": "string",      "canManageDocumentRetention": "string",      "canManageEnvelopeTransfer": "string",      "canManageGroupsButNotUsers": "string",      "canManageJointAgreements": "string",      "canManageReporting": "string",      "canManageSharing": "string",      "canManageSigningGroups": "string",      "canManageStamps": "string",      "canManageUsers": "string",      "canViewUsers": "string"    },    "adminOnly": "string",    "allowAccessToAllAccountAgreements": "string",    "allowAutoTagging": "string",    "allowedDocumentTemplateLibraryAccess": "string",    "allowedOrchestrationAccess": "string",    "allowEnvelopeTransferTo": "string",    "allowEsealRecipients": "string",    "allowPowerFormsAdminToAccessAllPowerFormEnvelope": "string",    "allowRecipientLanguageSelection": "string",    "allowSendOnBehalfOf": "string",    "allowSupplementalDocuments": "string",    "allowTransactions": "string",    "anchorTagVersionedPlacementEnabled": "string",    "apiAccountWideAccess": "string",    "apiCanExportAC": "string",    "bulkSend": "string",    "canBulkUploadAgreements": "string",    "canChargeAccount": "string",    "canCreateTransaction": "string",    "canDeleteDocumentsInTransaction": "string",    "canDeleteTransaction": "string",    "canEditSharedAddressbook": "string",    "canLockEnvelopes": "string",    "canManageAccount": "string",    "canManageAgreementParties": "string",    "canManageDistributor": "string",    "canManageTemplates": "string",    "canSendAPIRequests": "string",    "canSendEnvelope": "string",    "canSendEnvelopesViaSMS": "string",    "canSignEnvelope": "string",    "canUseScratchpad": "string",    "canUseSmartContracts": "string",    "disableDocumentUpload": "string",    "disableOtherActions": "string",    "enableDSPro": "string",    "enableKeyTermsSuggestionsByDocumentType": "string",    "enableSequentialSigningAPI": "string",    "enableSequentialSigningUI": "string",    "enableSignerAttachments": "string",    "enableSignOnPaperOverride": "string",    "enableTransactionPoint": "string",    "enableVaulting": "string",    "expressSendOnly": "string",    "isManagedByScim": "string",    "isMembershipManagedByScim": "string",    "locale": "string",    "localePolicy": {      "addressFormat": "string",      "allowRegion": "string",      "calendarType": "string",      "cultureName": "string",      "currencyCode": "string",      "currencyNegativeFormat": "string",      "currencyPositiveFormat": "string",      "customDateFormat": "string",      "customSignDateFormat": "string",      "customSignTimeFormat": "string",      "customTimeFormat": "string",      "dateFormat": "string",      "effectiveAddressFormat": "string",      "effectiveCalendarType": "string",      "effectiveCurrencyCode": "string",      "effectiveCurrencyNegativeFormat": "string",      "effectiveCurrencyPositiveFormat": "string",      "effectiveCustomDateFormat": "string",      "effectiveCustomTimeFormat": "string",      "effectiveDateFormat": "string",      "effectiveInitialFormat": "string",      "effectiveNameFormat": "string",      "effectiveTimeFormat": "string",      "effectiveTimeZone": "string",      "initialFormat": "string",      "nameFormat": "string",      "signDateFormat": "string",      "signTimeFormat": "string",      "timeFormat": "string",      "timeZone": "string"    },    "manageClickwrapsMode": "string",    "modifiedBy": "string",    "modifiedDate": "string",    "modifiedPage": "string",    "newSendUI": "string",    "powerFormMode": "string",    "recipientViewedNotification": "string",    "sealIdentifiers": [      {        "sealDisplayName": "string",        "sealName": "string"      }    ],    "selfSignedRecipientEmailDocument": "string",    "senderEmailNotifications": {      "changedSigner": "string",      "clickwrapResponsesLimitNotificationEmail": "string",      "commentsOnlyPrivateAndMention": "string",      "commentsReceiveAll": "string",      "deliveryFailed": "string",      "envelopeComplete": "string",      "offlineSigningFailed": "string",      "powerformResponsesLimitNotificationEmail": "string",      "purgeDocuments": "string",      "recipientViewed": "string",      "senderEnvelopeDeclined": "string",      "withdrawnConsent": "string"    },    "signerEmailNotifications": {      "agentNotification": "string",      "carbonCopyNotification": "string",      "certifiedDeliveryNotification": "string",      "commentsOnlyPrivateAndMention": "string",      "commentsReceiveAll": "string",      "documentMarkupActivation": "string",      "envelopeActivation": "string",      "envelopeComplete": "string",      "envelopeCorrected": "string",      "envelopeDeclined": "string",      "envelopeVoided": "string",      "faxReceived": "string",      "offlineSigningFailed": "string",      "purgeDocuments": "string",      "reassignedSigner": "string",      "whenSigningGroupMember": "string"    },    "supplementalDocumentIncludeInDownload": "string",    "supplementalDocumentsMustAccept": "string",    "supplementalDocumentsMustRead": "string",    "supplementalDocumentsMustView": "string",    "templateActiveCreation": "string",    "templateApplyNotify": "string",    "templateAutoMatching": "string",    "templateMatchingSensitivity": "string",    "templatePageLevelMatching": "string",    "timezoneDST": "string",    "timezoneMask": "string",    "timezoneOffset": "string",    "timezoneSendingPref": "string",    "timezoneSigningPref": "string",    "transactionPointSiteNameURL": "string",    "transactionPointUserName": "string",    "vaultingMode": "string",    "webForms": "string"  },  "userStatus": "string",  "userType": "string",  "workAddress": {    "address1": "string",    "address2": "string",    "city": "string",    "country": "string",    "fax": "string",    "phone": "string",    "postalCode": "string",    "stateOrProvince": "string",    "zipPlus4": "string"  }}

Gets the user information for a specified user using a userId (GUID). To find a user based on their email address, use the list endpoint GET

Retrieves the user information for the specified user. For example: ```json { "userName": "Tania Morales", "userId": "6b67a1ee-xxxx-xxxx-xxxx-385763624163", "userType": "CompanyUser", "isAdmin": "False", "isNAREnabled": "false", "userStatus": "Active", "uri": "/users/6b67a1ee-xxxx-xxxx-xxxx-385763624163", "email": "examplename42@orobia.net", "createdDateTime": "2019-04-01T22:11:56.4570000Z", "userAddedToAccountDateTime": "0001-01-01T08:00:00.0000000Z", "firstName": "Tania", "lastName": "Morales", "jobTitle": "", "company": "Company", "permissionProfileId": "12345678", "permissionProfileName": "DocuSign Viewer", "userSettings": {. . .}, "sendActivationOnInvalidLogin": "false", "enableConnectForUser": "false", "groupList": [. . .], "workAddress": {. . .}, "homeAddress": {. . .}, "signatureImageUri": "/users/6b67a1ee-xxxx-xxxx-xxxx-385763624163/signatures/0304c47b-xxxx-xxxx-xxxx-c9673963bb50/signature_image", "initialsImageUri": "/users/6b67a1ee-xxxx-xxxx-xxxx-385763624163/signatures/0304c47b-xxxx-xxxx-xxxx-c9673963bb50/initials_image", "defaultAccountId": "f636f297-xxxx-xxxx-xxxx-8e7a14715950" } ```

Retrieves the user profile image for the specified user GET

Retrieves the user profile picture for the specified user. The `userId` path parameter must match the authenticated user's user ID, and the user must be a member of the specified account. | Return value | Meaning | | :---------------- | :----------------------------------------------------------------------------- | | `200 OK` | The response contains the profile image in the same format as it was uploaded. | | `404 Not found` | The user does not have a profile image. | | `400 Bad request` | There was an error in the request. The response has more information. |