Skip to main content
POST
Create a new instance variable

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

Setting successfully created

success
boolean
Example:

true

data
object
message
string
Example:

"Setting created!"