Question Sets
Update Question Set
Question Sets
Question Sets
Update Question Set
PATCH
/
v5
/
question-sets
/
{question_set_id}
curl --request PATCH \
--url https://api.egp.scale.com/v5/question-sets/{question_set_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"name": "<string>",
"instructions": "<string>"
}'
{
"name": "<string>",
"instructions": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by_user_id": "<string>",
"archived_at": "2023-11-07T05:31:56Z",
"object": "question_set",
"questions": [
{
"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
},
"multi": true,
"dropdown": true,
"required": true,
"conditions": [
{}
],
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by_user_id": "<string>",
"object": "question",
"override_config": {
"required": false
}
}
]
}
Authorizations
Path Parameters
Response
200
application/json
Successful Response
Available options:
question_set
Questions in the question set
Available options:
categorical
, free_text
, rating
, number
Available options:
question
Specifies additional configurations to use for the question in the context of the question set. For example, {required: true}
sets the question as required. Writes to the question_id_to_config field on the response
Whether the question is required. False by default.
curl --request PATCH \
--url https://api.egp.scale.com/v5/question-sets/{question_set_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"name": "<string>",
"instructions": "<string>"
}'
{
"name": "<string>",
"instructions": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by_user_id": "<string>",
"archived_at": "2023-11-07T05:31:56Z",
"object": "question_set",
"questions": [
{
"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
},
"multi": true,
"dropdown": true,
"required": true,
"conditions": [
{}
],
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by_user_id": "<string>",
"object": "question",
"override_config": {
"required": false
}
}
]
}