Adds or updates custom user settings for the specified user.

Note: Custom user settings are not the same as user account settings.

Custom settings provide a flexible way to store and retrieve custom user information that you can use in your own system.

Important: There is a limit on the size for all the custom user settings for a single user. The limit is 4,000 characters, which includes the XML and JSON structure for the settings.

Grouping Custom User Settings

You can group custom user settings when adding them. Grouping allows you to retrieve settings that are in a specific group, instead of retrieving all the user custom settings.

To group custom user settings, add the following information in the header, after Content-Type:

X-DocuSign-User-Settings-Key:group_name

Where the group_name is your designated name for the group of customer user settings. Grouping is shown in the Example Request Body below.

When getting or deleting grouped custom user settings, you must include the extra header information.

Grouping custom user settings is not required and if the extra header information is not included, the custom user settings are added normally and can be retrieved or deleted without including the additional header.

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID GUID.

userIdstring

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Administrator on the account, this can be another user the Admin user is accessing. Note: For Envelopes:listStatusChanges (GET /v2.1/accounts/{accountId}/envelopes), the user_id query parameter is not implemented and should not be used.

Request Body

UserCustomSettings

Responses

CodeDescriptionReference
200

Successful response.

UserCustomSettings
400

Error encountered.

errorDetails

SDK Method

Users::updateCustomSettings

Definitions

errorDetails

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

errorCodestring

A code associated with the error condition.

messagestring

A brief message describing the error condition.

nameValue

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

namestring

The name or key of a name/value pair.

originalValuestring

The initial value of the tab when it was sent to the recipient.

valuestring

The value field of a name/value pair.

UserCustomSettings

Users' custom settings

customSettings[nameValue]

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

Examples

Generic JSON Request/Response

Request
{
  "customSettings": [
    {}
  ]
}
Response
{
  "customSettings": [
    {}
  ]
}
Generic XML Request/Response

Request
<customSettingsInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <customSettings>
    <nameValue />
  </customSettings>
</customSettingsInformation> 
Response
<customSettingsInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <customSettings>
    <nameValue />
  </customSettings>
</customSettingsInformation> 
}} />