Edit a classroom slot

patch

https://app.360learning.com/api/v2/classrooms/{classroomId}/slots/{classroomSlotId}

🔑
Required OAuth scope: classrooms:write.

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

Path Params

classroomId

string

required

^[a-fA-F0-9]{24}$

The unique ID of the classroom.

classroomSlotId

string

required

^[a-fA-F0-9]{24}$

The unique ID of the classroom slot.

Body Params

name

string

length ≥ 1

The title of the classroom slot.

startDate

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)).

endDate

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)).

location

string

length ≥ 1

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

maxCapacity

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.

reportedDuration

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

timezone

string

length ≥ 1

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

virtual

boolean

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

notification

object

The notification configuration.

Headers

360-api-version

string

enum

required

The version of the API.

Allowed:

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Updates a specific classroom slot given its unique ID.

400The server cannot or will not process the request due to something that is perceived to be a client error.

401The given access token is either missing, invalid, has expired, or has been revoked.

403The given access token does not have the required OAuth scope to execute the request.

404The server cannot find the requested resource.

429The client has sent too many requests in a short amount of time.