collab
post/api/rooms

Request

  • The document declares no server URL.
  • Auth: none declared

Request body

titlestring

Optional room title

visibility'OPEN' | 'VIEW_ONLY' | 'PRIVATE'

Room visibility (default: OPEN)

passwordstring

Optional password to protect room on creation

Response

idstring required
slugstring required
titlestring nullable
ownerIdstring required
createdAtstring date-time required
updatedAtstring date-time required
visibility'OPEN' | 'VIEW_ONLY' | 'PRIVATE' required
hasPasswordboolean required

Whether room has a password set (never exposes the hash)

encryptedboolean required

Whether board content is end-to-end encrypted with a key carried in the URL fragment. False for rooms created before this existed.

Changes