Sign in

v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB
Classrooms

Edit a classroom

🔑

Required OAuth scope: classrooms:write.

Edits specific fields of an existing classroom. Fields not included in the request payload remain unchanged.

patch/api/v2/classrooms/{classroomId}

Path parameters

classroomIdstring ObjectId required
Example:507f1f77bcf86cd799439011

The unique ID of the classroom.

Headers

360-api-version'v2.0' required

The version of the API.

Request body

namestring

The title of the classroom.

mediaIdsstring[]

The list of unique IDs of the medias assigned to this classroom. These attachments will be sent by email to registered learners.

messagestring nullable

Complementary information about the classroom. This information will be sent by email to registered learners.

trainingObjectivestring nullable

The training objective of the classroom.

Example request

{
  "name": "Security Conference",
  "mediaIds": [
    "507f1f77bcf86cd799439011"
  ],
  "message": "Be sure to have read all the attachments before the conference.",
  "trainingObjective": "Learn the security rules of the company."
}

Response

Returns the updated classroom.

groupIdstring ObjectId required

The unique ID of the creation group of the classroom.

_idstring ObjectId required

The unique ID of the classroom.

createdAtstring date-time

The date at which the classroom was created, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

namestring required

The title of the classroom.

mediaIdsstring[] required

The list of unique IDs of the medias assigned to this classroom. These attachments will be sent by email to registered learners.

messagestring

Complementary information about the classroom. This information will be sent by email to registered learners.

modifiedAtstring date-time

The date at which the classroom was last modified, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

trainingObjectivestring

The training objective of the classroom.

Example response

{
  "groupId": "507f1f77bcf86cd799439011",
  "_id": "507f1f77bcf86cd799439011",
  "name": "Security Conference",
  "mediaIds": [
    "507f1f77bcf86cd799439011"
  ],
  "message": "Be sure to have read all the attachments before the conference.",
  "trainingObjective": "Learn the security rules of the company."
}