Users

Update current user preferences

Changed on

Upserts the authenticated user's date_format, language, and/or parallel_agents. At least one field is required. Unknown format strings, languages, and non-boolean parallel_agents values are rejected. Any user_id in the body is ignored; the JWT user is always the target.

patch/users/me/preferences

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/users/me/preferences
  • Auth
    HTTP bearer

Request body

date_format'DD-MM-YYYY' | 'MM-DD-YYYY' | 'DD/MM/YY' | 'MM/DD/YY'
language'en' | 'de' | 'fr' | 'es'
parallel_agentsboolean

Example request

{
  "date_format": "MM-DD-YYYY",
  "language": "en"
}

Response

Preferences saved

messagestring

Example response

{
  "message": "OK",
  "data": {
    "date_format": "DD-MM-YYYY",
    "language": "en",
    "theme": "light"
  }
}

Changes

  • 2c5d7047f9e5Revision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

  • ecad689c5f93Revision changes
    • warning

      removed the request property

    • warning

      removed the optional property / from the response with the status