Update a user's preferences

Updates a user's preferences. These preferences are tied to the OAuth client that generated the token making the request. The user preferences endpoints allow consumers of the API to store arbitrary JSON data, such as a user's font size preference or preferred display name. An account may have multiple preferences. Preferences, and the pertaining request body, may contain any arbitrary JSON data that the user would like to store.

Permissions and scopes

To call this operation, you need permissions, based on the model you're using:

  • Identity and access permissions. Your user needs a role with these permissions. Learn more.

    • Permissions: update_user_preferences
  • OAuth scopes. Your user needs these scopes assigned. Learn more.

    • Scopes: account:read_write
Path Params
string
enum
required

Enum Call either the v4 URL, or v4beta for operations still in Beta.

Allowed:
Body Params

Arbitrary JSON of your choosing. Overwrites any existing preferences for this user.

Total length cannot exceed 65,535 characters.

Responses

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/json