Edit a classroom slot

Required OAuth scope: classrooms:write.

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

Path Params
string
required

The unique ID of the classroom.

string
required

The unique ID of the classroom slot.

Body Params
string
length ≥ 1

The title of the classroom slot.

date-time

The date and time when the classroom slot starts (must be before endDate), in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

date-time

The date and time when the classroom slot ends (must be after startDate), in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

string
length ≥ 1

The location of the classroom slot, being either a URL or a physical address.

number

The maximum number of registrations allowed in the slot. Learners won't be able to self-enroll on this slot if this number is reached.

number

The reported duration of the slot, in hours.

trainerIds
array of strings
length ≤ 20

The list of unique user IDs of trainers in charge of the slot (users must exist in the company).

trainerIds
string
length ≥ 1

The timezone of the slot in the format Continent[/Country]/City defined by TZ database.

boolean

True when the slot is a virtual classroom, false otherwise.

notification
object

The notification configuration.

Headers
string
enum
required

The version of the API.

Allowed:
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json