Skip to main content
PUT
Update an instance variable

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Path Parameters

settingId
string
required

The unique identifier of the setting to update

Body

application/json

At least one property must be provided. Any subset of fields can be sent.

key
string

Setting key name

Example:

"variable-2"

value
string

Setting value

Example:

"variable value"

status
enum<string>

Setting status

Available options:
active,
inactive,
deleted
Example:

"active"

admin_only
boolean

Whether setting is admin-only

Example:

true

editable_others
boolean

Whether setting can be edited by others

Example:

true

institution_shared
boolean

Whether setting is shared across institution

Example:

true

Response

Setting successfully updated

success
boolean
Example:

true

message
string
Example:

"Setting updated!"