Update user settings

POST /user/settings

Upserts supplied user settings and removes named setting keys for the current CRM user, then invokes the connector update hook when implemented. Connectors using the legacy update hook currently return an empty JSON object after the hook path; other connectors return the effective settings envelope.

Operation ID: postUserSettings
Authorization: BEARER or API key

Request body

User settings to upsert and setting keys to remove.

Required: Yes

Content type: application/json

Schema: UserSettingsUpdateRequest

{
  "userSettings": {
    "theme": {
      "value": "dark",
      "customizable": true,
      "defaultValue": "system",
      "options": [
        "system",
        "light",
        "dark"
      ]
    }
  },
  "settingKeysToRemove": [
    "legacySetting"
  ]
}

Responses

Status	Description	Body
200	Updated user settings. Legacy connector-hook failures can return an empty object.	UserSettingsEnvelope
400	Bad request, missing authentication, or connector error.	ErrorResponse, string