post `/rooms`

Create room

Base URL https://api.vseepreview.com/api_v3 · operationId createRoom

Authentication: Admin Token — Requires the Clinic Admin API Token from your dashboard (Developers → App → Edit App).

Create a new room for video consultations.

Parameters

Name	In	Type	Required	Enum	Default	Description
`X-ApiToken`	header	string	yes			API token (e.g. your_api_token)
`X-AccountCode`	header	string	yes			Account code (e.g. vclinic)

Request body

Content type: application/json

Field	Type	Required	Description
`domain`	string	yes	Clinic's domain
`code`	string	no	Room code (optional, should be unique)
`slug`	string	no	Room slug (optional)
`name`	string	yes	Room's name

Example:

{
  "domain": "vclinic.vsee.me",
  "code": "b4vjj",
  "slug": "provider00102",
  "name": "provider00102 room"
}

Responses

`200` — Room created successfully

success — Room created

{
  "data": {
    "visits": {
      "walkin": {
        "enabled": true
      },
      "appointment": {
        "enabled": false
      }
    },
    "auth": {
      "guest": {
        "type": 600,
        "log_in": {
          "enabled": true
        }
      }
    },
    "subtitle": "If this is an emergency, please call 911.",
    "slug": "provider00102",
    "name": "provider00102 room",
    "domain": "vclinic.vsee.me",
    "active": true,
    "users": "85741",
    "account_code": "clinic",
    "provider_ids": [
      "85741"
    ],
    "public_access_room": true,
    "modified": 1605728974,
    "created": 1605728974,
    "payment": {
      "consultations": [
        {
          "id": "5fb57ace-4808-4346-ad3c-3348925862c1",
          "description": "15-min Consultation",
          "duration": 15,
          "amount": 0,
          "group": false,
          "charge": false,
          "slots": 1
        }
      ],
      "currency": "USD"
    },
    "operation_settings": {
      "is_closed": false,
      "close_msg": "Service currently not available. Please check back later",
      "default_timezone": "America/Los_Angeles"
    },
    "id": "171",
    "code": "b4vjj"
  }
}

`400` — Room already exists

room_exists — Room already exists

{
  "code": 400,
  "message": "In domain 'vclinic.vsee.me' slug 'uat2' already exists."
}

Machine-readable: OpenAPI JSON (operationId: createRoom)

post /rooms