Request
The primary key for each resource.
Body Params application/vnd.api+json
data
object (SurveyItem)Â
requiredThe primary key for each resource.
{
"data": {
"id": "FID001",
"type": "SurveyItem",
"attributes": {
"question": "string",
"options": [
{
"label": "string",
"value": "string"
}
],
"isRequired": true,
"isHidden": true,
"isReadOnly": true,
"defaultValue": "string"
},
"relationships": {}
}
}
Request samples
curl --location --request PATCH 'https://api.synap.ac/v3/survey-items/' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
"data": {
"id": "FID001",
"type": "SurveyItem",
"attributes": {
"question": "string",
"options": [
{
"label": "string",
"value": "string"
}
],
"isRequired": true,
"isHidden": true,
"isReadOnly": true,
"defaultValue": "string"
},
"relationships": {}
}
}'
Responses
data
object (SurveyItem)Â
optionalThe primary key for each resource.
{
"data": {
"id": "FID001",
"type": "SurveyItem",
"attributes": {
"type": "boolean",
"question": "string",
"options": [
{
"label": "string",
"value": "string"
}
],
"isRequired": true,
"isHidden": true,
"isReadOnly": true,
"defaultValue": "string"
},
"relationships": {
"page": {
"data": {
"id": "FID001",
"type": "SurveyPage"
}
}
}
}
}
Modified at 2025-07-08 10:51:21