Update an Existing Academic Period

PATCH

/academic-periods/{academicPeriodId}

Requires authenticated session. Requires manage:academic-period permission.

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

Body

🟠400bad-request

🟠401unauthorized

🟠403forbidden

🟠404record-not-found

🟠409conflict

🔴500server-error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/academic-periods/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "academicYear": "string",
    "semester": 1,
    "startDate": "2019-08-24",
    "endDate": "2019-08-24",
    "isActive": true
}'

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "meta": {
        "page": 0,
        "limit": 0,
        "total": 0
    },
    "errors": [
        {
            "code": "string",
            "field": "string",
            "message": "string"
        }
    ],
    "result": {
        "id": "string",
        "name": "string",
        "academicYear": "string",
        "semester": "1",
        "startDate": "2019-08-24T14:15:22.123Z",
        "endDate": "2019-08-24T14:15:22.123Z",
        "isActive": true
    }
}

Modified at 2026-05-01 04:13:11

Retrieve an Existing Academic Period

Delete an Existing Academic Period