Skip to main content
PUT
Update a preference.

Authorizations

Authorization
string
header
required

Bearer JWT token or API Key (sk-*).

Path Parameters

preferenceId
string
required

Body

application/json
version
number
required

Optimistic locking version for the preference row.

Example:

3

name
string

Updated preference name.

Example:

"orders-grid-default"

desc
string

Updated preference description.

Example:

"Shared grid for support triage."

referenceType
string

Updated reference type for GRID preferences.

Example:

"orders"

reference
string

Updated reference id for GRID preferences.

Example:

"support-dashboard"

metadata
object

Replacement resource metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use.

Example:
global
boolean

Updated shared visibility flag.

Example:

false

default
boolean

Updated default-selection flag.

Example:

true

autoFit
boolean

Updated auto-fit flag applied when the preference is activated.

Example:

true

data
array[]

Updated preference payload items.

Example:

Response

OK.

Last modified on September 5, 2026