Skip to main content

Reset the canvas of a room

Reset the canvas of a room

Path Parameters
slug string REQUIRED

The slug of the room

Request Body REQUIRED
resetOnDefault boolean

If the canvas have a default image, then true to reset to that image, false to reset to a blank canvas

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