Update a Course

PATCH

/courses/{courseId}

Requires authenticated session. Requires own:course permission on the course, or manage:course. Returns 400 when the course is REQUESTED or REJECTED — a pending or rejected request is read-only.

Request

Authorization

API Key

Add parameter in cookie

core.session_token

Example:

core.session_token: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Bodyapplication/json

🟠400bad-request

🟠401unauthorized

🟠403forbidden

🟠404record-not-found

🔴500server-error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/courses/' \
--header 'Content-Type: application/json' \
--data '{
    "description": "string",
    "coverImage": "string"
}'

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "meta": {
        "page": 0,
        "limit": 0,
        "total": 0
    },
    "errors": [
        {
            "code": "CR-100001",
            "field": "string",
            "message": "string"
        }
    ],
    "result": {
        "id": "string",
        "title": "string",
        "description": "string",
        "status": "REQUESTED",
        "coverImage": "string",
        "grade": 0,
        "academicYear": "string",
        "subject": {
            "id": "string",
            "name": "string",
            "code": "string"
        },
        "class": {
            "id": "string",
            "name": "string",
            "grade": 0,
            "academicYear": "string"
        },
        "owner": {
            "id": "string",
            "name": "string",
            "image": "string"
        },
        "isOwned": true,
        "isCoTeacher": true,
        "counts": {
            "students": 0,
            "materials": 0,
            "quizzes": 0,
            "assignments": 0
        },
        "myProgress": {
            "completed": 0,
            "total": 0
        },
        "createdAt": "2019-08-24T14:15:22.123Z",
        "updatedAt": "2019-08-24T14:15:22.123Z",
        "archivedAt": "2019-08-24T14:15:22.123Z",
        "requestNote": "string",
        "rejectionReason": "string",
        "reviewedAt": "2019-08-24T14:15:22.123Z",
        "teachers": [
            {
                "teacherId": "string",
                "name": "string",
                "email": "string",
                "image": "string",
                "isOwner": true,
                "addedAt": "2019-08-24T14:15:22.123Z"
            }
        ]
    }
}

Modified at 2026-07-25 07:30:01

Retrieve an Existing Course

Delete a Course