Skip to main content
POST
Create a room

Authorizations

Authorization
string
header
required

Partner API key. Send as Authorization: Bearer sss_pk_....

Body

application/json
name
string
required

Display name shown to every party (e.g. a property address).

Required string length: 1 - 200
reference
string

Your internal file number.

Maximum string length: 200

Response

Room created.

roomCode
string

The room's bearer code — 40 lowercase hex characters.

roomUrl
string

Root-relative path to the shareable page, /rooms/{roomCode}.

name
string
reference
string | null
status
string
Example:

"open"

createdAt
string<date-time>