Request
The primary key for each resource.
Body Params application/vnd.api+json
data
object (CourseItemZip)Â
requiredThe primary key for each resource.
Allowed value:CourseItemZip
{
"data": {
"id": "FID001",
"type": "CourseItemZip",
"attributes": {
"title": "string",
"description": "string",
"customLabel": "string",
"isReviewRequired": true,
"shouldPreview": true,
"allowDownload": true
},
"relationships": {
"folder": {
"data": {
"id": "FID001",
"type": "CourseFolder"
}
},
"zip": {
"data": {
"id": "FID001",
"type": "Content"
}
}
}
}
}
Request samples
curl --location --request PATCH 'https://api.synap.ac/v3/course-item-zip/' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
"data": {
"id": "FID001",
"type": "CourseItemZip",
"attributes": {
"title": "string",
"description": "string",
"customLabel": "string",
"isReviewRequired": true,
"shouldPreview": true,
"allowDownload": true
},
"relationships": {
"folder": {
"data": {
"id": "FID001",
"type": "CourseFolder"
}
},
"zip": {
"data": {
"id": "FID001",
"type": "Content"
}
}
}
}
}'
Responses
data
object (CourseItemZip)Â
optionalThe primary key for each resource.
Allowed value:CourseItemZip
{
"data": {
"id": "FID001",
"type": "CourseItemZip",
"attributes": {
"title": "string",
"description": "string",
"customLabel": "string",
"type": "zip",
"isReviewRequired": true,
"shouldPreview": true,
"allowDownload": true
},
"relationships": {
"course": {
"data": {
"id": "FID001",
"type": "Course"
}
},
"folder": {
"data": {
"id": "FID001",
"type": "CourseFolder"
}
},
"zip": {
"data": {
"id": "FID001",
"type": "Content"
}
}
}
}
}
Modified at 2025-07-08 10:51:21