🏠Creating a Room

Below is a list of available parameters when creating a room

Parameter	Type	Required	Default	Description
name	string	Yes	n/a	Room name
lang	string	No	en-US	Room session language code(see)
tags	string	No	null	Room session tags. Separated by commas.
allow_recording	bool	No	true	Flag indicating that the room session recording will not be accessible
inaccessible_replay	bool	No	false	Flag indicating that the room session will be recorded
options	Session Options Object	No	See object	Room session options(see)
creator_email	string	No	null	Email address of the user who will create the room

The name parameter must be unique for a room

⚠️ Important information about creator_email parameter:

• Must be in valid email format

• If a user exists with this email, that user will be set as the room creator

• If no user exists with this email, the API key owner will be the room creator

• If the parameter is left empty, the API key owner will be the room creator

Example request

CURL

curl -L -X POST 'https://<DOMAIN>/xapi/v2/room' \
-H 'Content-Type: application/json' \
--data-raw '{
  "name": "Test Room",
  "lang": "en-US",
  "tags": "test, api",
  "allow_recording": true,
  "inaccessible_replay": false,
  "creator_email": "[email protected]",
  "options": {
    "allow_rating": true,
    "preparation_time": 15,
    "session_duration": 60,
    "Chat": {
      "OffMessageModule": false,
      "OffGeneralMsging": false,
      "OffGeneralMsgLimitForUser": false,
      "OffSpecialMsging": false,
      "OffSpecialMsgToAdmin": false,
      "OffSpecialMsgToUser": false,
      "OffNewMsgSound": false,
      "OffClearForReplay": false,
      "OnNewMsgSoundInAll": false,
      "OnNewMsgNotifyInAll": false
    },
    "Duration": {
      "AllowExtendTime": true,
      "UseRemainingTime": false
    },
    "allow_users_stream_self_cam_mic": true,
    "hide_user_streams": false,
    "enable_attendance_check": true,
    "enable_simultaneous_interpretation": false,
    "enable_simultaneous_interpretation_for_users": false,
    "start_active": false,
    "return_url": "",
    "allow_reactions": true
  }
}'

Example response

You need to save the ROOM_GUID parameter to perform other operations related to the room

A successful create operation will return 201 Created with body including the following information:

{
  "room_guid": "B5530B7F-6414-4046-87A6-67730D5F9F08",
  "name": "Test Room",
  "lang": "en-US",
  "url": "https://yourdomain.com/groups/room/test-room_{0}",
  "created_date": "2025-08-19T12:59:00",
  "tags": "test, api",
  "inaccessible_replay": false,
  "allow_recording": true,
  "ui_options": {
    "allow_rating": true,
    "preparation_time": 15,
    "session_duration": 60,
    "chat": {
      "offMessageModule": false,
      "offGeneralMsging": false,
      "offGeneralMsgLimitForUser": false,
      "offSpecialMsging": false,
      "offSpecialMsgToAdmin": false,
      "offSpecialMsgToUser": false,
      "offNewMsgSound": false,
      "offClearForReplay": false,
      "onNewMsgSoundInAll": false,
      "onNewMsgNotifyInAll": false
    },
    "duration": {
      "allowExtendTime": true,
      "useRemainingTime": false
    },
    "allow_users_stream_self_cam_mic": true,
    "hide_user_streams": false,
    "enable_attendance_check": true,
    "enable_simultaneous_interpretation": false,
    "enable_simultaneous_interpretation_for_users": false,
    "start_active": false,
    "return_url": "",
    "allow_reactions": true
  }
}