Skip to main content
PUT
/
api
/
user
/
setting
/
{settingId}
Update an instance variable
curl --request PUT \
  --url http://localhost:3000/api/user/setting/{settingId} \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "key": "variable-2",
  "value": "variable value ",
  "admin_only": true,
  "editable_others": true,
  "institution_shared": true
}
'
{
  "success": true,
  "message": "Setting updated!"
}

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
​
key
string
required

Setting key name

Example:

"variable-2"

​
value
string
required

Setting value

Example:

"variable value "

​
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

Whether the operation was successful

Example:

true

​
message
string

Success message

Example:

"Setting updated!"