POST
/
v5
/
questions
curl --request POST \
  --url https://api.egp.scale.com/v5/questions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "type": "categorical",
  "title": "<string>",
  "prompt": "<string>",
  "choices": [
    {
      "label": "<string>",
      "value": "<string>",
      "audit_required": false
    }
  ],
  "ratingOptions": {
    "minLabel": "<string>",
    "maxLabel": "<string>",
    "scaleSteps": 123
  },
  "numberOptions": {
    "min": 123,
    "max": 123
  },
  "freeTextOptions": {
    "characterLimit": {
      "min": 50,
      "max": 1000
    }
  },
  "multi": true,
  "dropdown": true,
  "required": true,
  "conditions": [
    {}
  ],
  "default": "<any>"
}'
{
  "id": "<string>",
  "object": "question",
  "type": "categorical",
  "title": "<string>",
  "prompt": "<string>",
  "choices": [
    {
      "label": "<string>",
      "value": "<string>",
      "audit_required": false
    }
  ],
  "ratingOptions": {
    "minLabel": "<string>",
    "maxLabel": "<string>",
    "scaleSteps": 123
  },
  "numberOptions": {
    "min": 123,
    "max": 123
  },
  "freeTextOptions": {
    "characterLimit": {
      "min": 50,
      "max": 1000
    }
  },
  "multi": true,
  "dropdown": true,
  "required": true,
  "conditions": [
    {}
  ],
  "default": "<any>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by_user_id": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
type
enum<string>
required
Available options:
categorical,
free_text,
rating,
number
​
title
string
required
​
prompt
string
required
​
choices
object[]
​
ratingOptions
object
​
numberOptions
object
​
freeTextOptions
object
​
multi
boolean
​
dropdown
boolean
​
required
boolean
​
conditions
object[]
​
default
any

Response

200
application/json
Successful Response
​
id
string
required
​
type
enum<string>
required
Available options:
categorical,
free_text,
rating,
number
​
title
string
required
​
prompt
string
required
​
created_at
string
required
​
created_by_user_id
string
required
​
object
enum<string>
default:question
Available options:
question
​
choices
object[]
​
ratingOptions
object
​
numberOptions
object
​
freeTextOptions
object
​
multi
boolean
​
dropdown
boolean
​
required
boolean
​
conditions
object[]
​
default
any