Update class

Updates an existing class's details (title, topic, capacity, or year level).

PATCH /++update_class

Classes & Enrollment

Authentication

Requires an authenticated (logged-in) account. Also requires a registered Integrator subscription.

This endpoint requires the calling application to be registered as an Integrator. Every call must identify the registration via a registration_id parameter (or an X-Client-Id header), and authenticate using one of the following methods, selected with the subscription_method parameter:

referer — The request's HTTP Referer header must match one of the domains authorized for this Integrator registration.
ip — The request's source IP address must match one of the IP addresses authorized for this Integrator registration.
client_token — A client token issued at registration time is supplied with the request.

Request

Content type: application/json

Name	In	Type	Required	Description
`BODY`	body	string	No	—
`capacity`	body	string	No	—
`class_id`	body	string	No	—
`class_name`	body	string	No	—
`topic`	body	string	No	—
`teacher_id`	body	string	No	—
`year_level`	body	string	No	—
`joining_code`	body	string	No	—
`class_status`	body	string	No	—

Example request body

{
  "BODY": "example_value",
  "capacity": "example_value",
  "class_id": "12345",
  "class_name": "Sample Name",
  "topic": "example_value",
  "teacher_id": "12345",
  "year_level": "example_value",
  "joining_code": "example_value"
}

Responses

Status	Meaning
`200`	Successful response.
`400`	Invalid JSON body.
`409`	Conflict - the request could not be completed due to a conflict with existing data.
`500`	Class id not found
`401`	Unauthorized - missing or invalid Integrator authentication (registration_id/X-Client-Id, plus referer/IP/client_token).
`403`	Forbidden - the current user or Integrator registration does not have sufficient permissions.

Example response (illustrative - field names only, values are placeholders)

{
  "@id": "https://example.com/rest-api/sample-object",
  "id": "12345",
  "joining_code": "example_value"
}

Classes & Enrollment