Create a new instance variable

Creates a new setting within the authenticated user’s institution. The institution and user fields are auto-populated from the auth context. A duplicate key within the same institution returns a 400 error.

POST /api/user/setting

Create a new instance variable

cURL

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

200

{
  "success": true,
  "data": {
    "_id": "687e71b293c797174458e6f2",
    "key": "variable-4",
    "value": "the value",
    "institution": "6631915765bb0a94cfd6ca99",
    "user": "6430d02554cd4e00403e8b05",
    "status": "active",
    "admin_only": true,
    "institution_shared": true,
    "editable_others": true,
    "created": "2023-11-07T05:31:56Z",
    "__v": 0
  },
  "message": "Setting created!"
}

Authorizations

x-access-token · string · header · required

JWT token passed in x-access-token header

Body

application/json

key · string · required

Setting key name (must be unique within the institution)

Example:

"variable-4"

value · string

Setting value (optional)

Example:

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

200

application/json

Setting successfully created

success · boolean

Example:

true

data · object

Show child attributes

message · string

Example:

"Setting created!"