Skip to main content
PUT
Update Setting

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

key
string
required

Body

application/json

Request to update setting value.

value
any
required

Response

Successful Response

Full setting definition with current state.

key
string
required
name
string
required
category
SettingCategoryRef · object
required

Reference to category.

type
string
required
is_optional
boolean
required
has_override
boolean
required
current
any
original
any
read_only
boolean
default:false
choices
SettingChoice · object[]
hint
SettingHint · object | null

Setting hints and guidance.