> For the complete documentation index, see [llms.txt](https://developer.perculus.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.perculus.com/v2-en/services/room-management/user-create.md).

# Creating a Room

Below is a list of available parameters when creating a room

<table data-full-width="false"><thead><tr><th width="155">Parameter</th><th width="126">Type</th><th width="128">Required</th><th width="102">Default</th><th>Description</th></tr></thead><tbody><tr><td>name</td><td>string</td><td>Yes</td><td>n/a</td><td>Room name</td></tr><tr><td>lang</td><td>string</td><td>No</td><td>en-US</td><td>Room session language code(<a href="/pages/lsSvGzmzOzBbQwfL34jH">see</a>)</td></tr><tr><td>tags</td><td>string</td><td>No</td><td>null</td><td>Room session tags. Separated by commas.</td></tr><tr><td>inaccessible_replay</td><td>bool</td><td>No</td><td>false</td><td>Flag indicating that the room session will be recorded</td></tr><tr><td>options</td><td><a href="/pages/cQpTnQcpJmixOvnTB4vP">Session Options Object</a></td><td>No</td><td><em>See object</em></td><td>Room session options(<a href="/pages/cQpTnQcpJmixOvnTB4vP">see</a>)</td></tr><tr><td>creator_email</td><td>string</td><td>No</td><td>null</td><td>Email address of the user who will create the room</td></tr><tr><td>room_hosts</td><td>string[]</td><td>Hayır</td><td>null</td><td>List of user GUIDs to be assigned as room instructors</td></tr></tbody></table>

{% hint style="warning" %}
&#x20;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
* The user who created the room is automatically added as an instructor in all cases
  {% endhint %}

**Example request**

{% tabs %}
{% tab title="CURL" %}

```bash
curl -L -X POST 'https://<DOMAIN>/api/groups/xapi/room' \
-H 'Content-Type: application/json' \
--data-raw '{
  "name": "Test Room",
  "lang": "en-US",
  "tags": "test, api",
  "inaccessible_replay": false,
  "creator_email": "test@example.com",
  "room_hosts": ["<user_guid_1>", "<user_guid_2>"]
  "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
  }
}'
```

{% endtab %}
{% endtabs %}

**Example response**

{% hint style="info" %}
You need to save the `ROOM_GUID` parameter to perform other operations related to the room
{% endhint %}

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

```json
{
  "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,
  "room_hosts": ["A1B2C3D4-E5F6-7890-ABCD-EF1234567890"],
  "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
  }
}

```