Create Question

post https://api.egp.scale.com/v4/questions

Description

Creates a question

Details

This API can be used to create a question. To use this API, review the request schema and pass in all fields that are required to create a question.

Body Params

type

string

required

The type of question

title

string

required

prompt

string

required

choices

array of objects

List of choices for the question. Required for CATEGORICAL questions.

Choices

ratingOptions

object

Options for rating questions.

numberOptions

object

Options for number questions.

freeTextOptions

object

Options for free text questions.

multi

boolean

Whether the question allows multiple answers.

dropdown

boolean

Whether the question is displayed as a dropdown in the UI.

required

boolean

[To be deprecated in favor of question set question_id_to_config] Whether the question is required.

conditions

array of objects

Conditions for the question to be shown.

Conditions

default

string

The default value for the question.

account_id

string

required

The ID of the account that owns the given entity.

Headers

x-selected-account-id

string

Responses

Language

Credentials

Header

Request


xxxxxxxxxx
15
1
curl --request POST \
2
     --url https://api.egp.scale.com/v4/questions \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "type": "categorical",
8
  "freeTextOptions": {
9
    "characterLimit": {
10
      "min": 50,
11
      "max": 1000
12
    }
13
  }
14
}
15
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

422Validation Error