Qodex.ai

Create Setting

POST {{protocol}}://{{instance_zuid}}.{{instances_api_url}}/{{instances_api_version}}/env/settings

Available request body property values.

namedescription
category[string] Required. Unique. This will appear in the manager-ui
keyFriendly[string] Required.
key[string] Required. Unique
value[boolean] Required.
admin[boolean] Required.
parselyAccess[boolean] Required.
dataType[string] Required. Values: checkbox, textarea, text, dropdown
options[string]
tips[string]

NOTE: - if dataType is set to "dropdown", options must contain a string value that follows this structure "key1:value1,key2:value2..." - if dataType is set to "checkbox", options must contain a string value that follows this structure "value1,value2"

Request Body

{"category"=>"Boop", "keyFriendly"=>"Beep", "key"=>"Beep", "value"=>"true", "admin"=>false, "parselyAccess"=>false, "dataType"=>"dropdown", "options"=>"key1:value1;key2:value2", "tips"=>"Here are some suggestions"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: Created

{"_meta":{"timestamp":"2021-08-25T19:02:35.866426699Z","totalResults":1,"start":0,"offset":0,"limit":1},"data":{"ID":41,"ZUID":"29-f8a3c1cdaa-rgr01h","category":"Boop","key":"Beep","keyFriendly":"Beep","value":"true","admin":false,"parsleyAccess":null,"dataType":"dropdown","options":"key1:value1;key2:value2","tips":"Here are some suggestions","createdAt":"2021-08-25T19:02:35.85924355Z","updatedAt":"2021-08-25T19:02:35.859251559Z"}}