Skip to main content

Update a room

Update a room

Path Parameters
slug string REQUIRED

The slug of the room

Request Body REQUIRED
name string

The name of the room

description

The description of the room

iconURL

The URL of the room's icon

isPublic boolean

Whether the room is public or not. Defaults to false

studentsWhitelist undefined[]

The list of students allowed to join the room. Effective only if isPublic is false. Accepts both UIDs and logins. Defaults to an empty array

studentsBlacklist undefined[]

The list of students not allowed to join the room. Effective only if isPublic is true. Accepts both UIDs and logins. Defaults to an empty array

Responses
200

Successful response

Schema OPTIONAL
slug string
name string
description string
iconURL string
canvasDimensions number
isPublic boolean
studentsWhitelist number[]
studentsBlacklist number[]
ownerUid number
password string
hidden boolean
deleted boolean
createdAt date-time
401

Unauthorized

Schema OPTIONAL
code string OPTIONAL
message string OPTIONAL
403

Forbidden

Schema OPTIONAL
code string OPTIONAL
message string OPTIONAL
429

Too Many Requests

Schema OPTIONAL
code string OPTIONAL
message string OPTIONAL
500

Internal Server Error

Schema OPTIONAL
code string OPTIONAL
message string OPTIONAL