Request
The primary key for each resource.
Body Params application/vnd.api+json
The primary key for each resource.
{
"data": {
"id": "FID001",
"type": "Course",
"attributes": {
"name": "string",
"description": "string",
"isArchived": true,
"shortDescription": "string"
},
"relationships": {
"owner": {
"data": {
"id": "FID001",
"type": "User"
}
},
"subPortal": {
"data": {
"id": "FID001",
"type": "SubPortal"
}
},
"items": {
"data": [
{
"id": "FID001",
"type": "CourseItem"
}
]
},
"folders": {
"data": [
{
"id": "FID001",
"type": "CourseFolder"
}
]
},
"coverImage": {
"data": {
"id": "FID001",
"type": "File"
}
}
}
}
}
Request samples
curl --location --request PATCH 'https://api.synap.ac/v3/courses/' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
"data": {
"id": "FID001",
"type": "Course",
"attributes": {
"name": "string",
"description": "string",
"isArchived": true,
"shortDescription": "string"
},
"relationships": {
"owner": {
"data": {
"id": "FID001",
"type": "User"
}
},
"subPortal": {
"data": {
"id": "FID001",
"type": "SubPortal"
}
},
"items": {
"data": [
{
"id": "FID001",
"type": "CourseItem"
}
]
},
"folders": {
"data": [
{
"id": "FID001",
"type": "CourseFolder"
}
]
},
"coverImage": {
"data": {
"id": "FID001",
"type": "File"
}
}
}
}
}'
Responses
The primary key for each resource.
{
"data": {
"id": "FID001",
"type": "Course",
"attributes": {
"createdAt": "string",
"updatedAt": "string",
"name": "string",
"description": "string",
"isArchived": true,
"shortDescription": "string",
"versionNumber": 0,
"publishedAt": "string"
},
"relationships": {
"owner": {
"data": {
"id": "FID001",
"type": "User"
}
},
"subPortal": {
"data": {
"id": "FID001",
"type": "SubPortal"
}
},
"items": {
"data": [
{
"id": "FID001",
"type": "CourseItem"
}
]
},
"folders": {
"data": [
{
"id": "FID001",
"type": "CourseFolder"
}
]
},
"coverImage": {
"data": {
"id": "FID001",
"type": "File"
}
}
}
}
}
Modified at 2025-07-08 10:51:21