Skip to navigation

UserCustomSettings Resource

View as Markdown

The UserCustomSettings resource provides methods that allow you to manage the custom settings for a user.

Custom settings are a flexible way to store and retrieve custom user information that can be used in your own system.

There is a limit on the size for all the custom user settings for a single user. All the custom user settings for a single user is limited to 4,000 characters, which includes the xml and json structure for the settings.

Methods supported

MethodDescription
deleteDEL /restapi/v2.1/accounts/{accountId}/users/{userId}/custom_settings
Deletes custom user settings for a specified user.
listGET /restapi/v2.1/accounts/{accountId}/users/{userId}/custom_settings
Retrieves the custom user settings for a specified user.
updatePUT /restapi/v2.1/accounts/{accountId}/users/{userId}/custom_settings
Adds or updates custom user settings for the specified user.

UserCustomSettings properties

PropertyTypeDescription
customSettingsarrayThe name/value pair information for the user custom setting.