Update an instance variable

Updates an existing setting by ID. Accepts any non-empty object as the request body; no specific fields are required. No institution ownership check is performed.

PUT /api/user/setting/{settingId}

Update an instance variable

cURL

curl --request PUT \
  --url https://pria.praxislxp.com/api/user/setting/{settingId} \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "key": "variable-2",
  "value": "variable value",
  "status": "active",
  "admin_only": true,
  "editable_others": true,
  "institution_shared": true
}
'

200

{
  "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

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

200

application/json

Setting successfully updated

success · boolean

Example:

true

message · string

Example:

"Setting updated!"