Adds or updates custom user settings for the specified user

Server URLloading...

PUT

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

Send

Authorization

Path

Body

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.

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, include the X-DocuSign-User-Settings-Key header in the request:

X-DocuSign-User-Settings-Key:group_name

Where the group_name is your designated name for the group of customer user settings.

When getting or deleting grouped custom user settings, you must include the X-DocuSign-User-Settings-Key header information.

Grouping custom user settings is not required and if the X-DocuSign-User-Settings-Key header information is not included, the custom user settings are added normally and can be retrieved or deleted without including the X-DocuSign-User-Settings-Key header.

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

curl -X PUT "https://example.com/v2.1/accounts/string/users/string/custom_settings" \  -H "Content-Type: application/json" \  -d '{}'

{  "customSettings": [    {      "errorDetails": {        "errorCode": "string",        "message": "string"      },      "name": "string",      "originalValue": "string",      "value": "string"    }  ]}