Skip to main content
POST
/
api
/
rooms
Create a room
curl --request POST \
  --url https://signsealship.com/api/rooms \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "1428 Maple St — Refinance",
  "reference": "TC-88412"
}
'
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '1428 Maple St — Refinance', reference: 'TC-88412'})
};

fetch('https://signsealship.com/api/rooms', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
import requests

url = "https://signsealship.com/api/rooms"

payload = {
"name": "1428 Maple St — Refinance",
"reference": "TC-88412"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
{
  "roomCode": "<string>",
  "roomUrl": "<string>",
  "name": "<string>",
  "reference": "<string>",
  "status": "open",
  "createdAt": "2023-11-07T05:31:56Z"
}
{
"error": "<string>"
}
{
"error": "A valid partner API key is required."
}

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>