SchoolSet APIAcademic Years

Update an academic year

Updates the title, dates, or visibility of an active school academic year.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Path parameters

idintegerRequired
Academic year identifier to update.

Request

This endpoint expects an object.
titlestringOptional<=255 characters
start_atdateOptional
end_atdateOptional
is_visiblebooleanOptional

Response

The academic year was updated and returned.
statusstringOptional
messagestringOptional
dataobjectOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error