Skip to main content
Create a new room in your organization. Rooms are the core collaboration context — all users, presence, stores, comments, and files are scoped to a room.

​
Endpoint

POST /v1/accounts/:accountId/rooms

​
Authentication

Bearer token required.

​
Request Body

​
name
string
required
A name for the room. Can be any string (e.g., "whiteboard/room-one", "project-alpha").
​
customId
string
Optional custom identifier for external system correlation. Must be unique within your organization.

​
Response

​
room
CollabKitRoom
The created room. See CollabKitRoom.

​
Example

curl -X POST https://api.collab-kit.com/v1/accounts/${ACCOUNT_ID}/rooms \
  -H "Authorization: Bearer ${TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{"name": "whiteboard/room-one", "customId": "my-room-1"}'
Response (201)
{
  "type": "response",
  "success": true,
  "description": "Room created",
  "data": {
    "room": {
      "id": "c3003c93-60cf-4184-b85f-20be14d26dac",
      "account_id": "a1b2c3d4-5678-...",
      "name": "whiteboard/room-one",
      "custom_id": "my-room-1",
      "created_at": "2026-05-29T10:00:00.000Z",
      "state": "active",
      "duration_seconds": 0,
      "active_participants": 0,
      "total_users_created": 0
    }
  },
  "error": null
}