SETTINGS

Change one or more preferences

Partial update — only the keys present in values are touched. Validation is all-or-nothing: one invalid value rejects the whole request rather than saving half of it. Returns the full refreshed set so the client never has to merge. An unknown key answers 400 SETTING_UNKNOWN_KEY; a value outside its definition answers 400 SETTING_INVALID_VALUE.

patch/internal/api/settings/preferences

Request

  • Base URL
    https://api.signalshq.io (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL: /auth/login

Request body

valuesobject required

Preference key to new value. Only these keys are changed.

Example request

{
  "values": {
    "tax_return.form_1040sr.enabled": false
  }
}

Response

Successful Response

Changes

No recorded changes to this operation across all 1 revision of this API.