Request
Body Params application/vnd.api+json
{
"data": {
"type": "Survey",
"attributes": {
"title": "string",
"description": "string",
"shortDescription": "string",
"isLibraryItem": true
},
"relationships": {}
}
}
Request samples
curl --location --request POST 'https://api.synap.ac/v3/surveys' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
"data": {
"type": "Survey",
"attributes": {
"title": "string",
"description": "string",
"shortDescription": "string",
"isLibraryItem": true
},
"relationships": {}
}
}'
Responses
The primary key for each resource.
{
"data": {
"id": "FID001",
"type": "Survey",
"attributes": {
"createdAt": "string",
"updatedAt": "string",
"title": "string",
"description": "string",
"shortDescription": "string",
"selfAssessment": {},
"totalItems": 0,
"isLibraryItem": true,
"isArchived": true
},
"relationships": {
"owner": {
"data": {
"id": "FID001",
"type": "User"
}
},
"subPortal": {
"data": {
"id": "FID001",
"type": "SubPortal"
}
},
"pages": {
"data": [
{
"id": "FID001",
"type": "SurveyPage"
}
]
}
}
}
}
Modified at 2025-07-08 10:51:21