Update Course

PATCH

/courses/{object_id}

Request

Path Params

object_id

string

required

The primary key for each resource.

Example:

FID001

Body Params application/vnd.api+json

data

object (Course)

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

Course

Example:

Course

attributes

object

optional

relationships

object

optional

Example

{
    "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

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

🟢200OK

application/vnd.api+json

Success

Body

data

object (Course)

optional

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

Course

Example:

Course

attributes

object

optional

relationships

object

optional

Example

{
    "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"
                }
            }
        }
    }
}

🟢204No Content

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-07-08 10:51:21

Get Course

Delete Course