Updating a Room

Below is a list of available parameters for updating room:

Parameter	Type	Required	Default	Description
name	string	No	null	Room name
lang	string	No	null	Room session language code(see)
tags	string	No	null	Room session tags. Separated by commas.
inaccessible_replay	bool	No	null	Flag indicating that the room session will be recorded
options	Session Options Object	No	null	Room session options(see)
room_hosts	string[]	Hayır	null	List of user GUIDs to be assigned as room instructors

The name parameter must be unique for a room.

⚠️ All parameters are optional in the update operation. Only the sent parameters will be updated.

Example request

CURL

curl -L -X PUT 'https://<DOMAIN>/xapi/v2/room/:ROOM_GUID' \
-H 'Content-Type: application/json' \
--data-raw '{
  "name": "Updated Room Name",
  "lang": "en-US",
  "tags": "test",
  "inaccessible_replay": true,
  "room_hosts": ["<user_guid_1>", "<user_guid_2>"]
  "options": {
    "allow_rating": false,
    "preparation_time": 10,
    "session_duration": 90,
    "Chat": {
      "OffMessageModule": true,
      "OffGeneralMsging": false
    },
    "Duration": {
      "AllowExtendTime": false,
      "UseRemainingTime": true
    },
    "allow_users_stream_self_cam_mic": false,
    "hide_user_streams": true,
    "enable_attendance_check": false,
    "allow_reactions": false
  }
}'

Example response

A successful update operation will return 200 OK with body including the following information:

{
  "room_guid": "B5530B7F-6414-4046-87A6-67730D5F9F08",
  "name": "Updated Room Name",
  "lang": "en-US",
  "url": "https://yourdomain.com/groups/room/updated-room-name_{0}",
  "created_date": "2025-08-14T13:02:00",
  "tags": "test",
  "inaccessible_replay": true,
  "room_hosts": ["A1B2C3D4-E5F6-7890-ABCD-EF1234567890"],
  "ui_options": {
    "allow_rating": false,
    "preparation_time": 10,
    "session_duration": 90,
    "chat": {
      "offMessageModule": true,
      "offGeneralMsging": false,
      "offGeneralMsgLimitForUser": false,
      "offSpecialMsging": false,
      "offSpecialMsgToAdmin": false,
      "offSpecialMsgToUser": false,
      "offNewMsgSound": false,
      "offClearForReplay": false,
      "onNewMsgSoundInAll": false,
      "onNewMsgNotifyInAll": false
    },
    "duration": {
      "allowExtendTime": false,
      "useRemainingTime": true
    },
    "allow_users_stream_self_cam_mic": false,
    "hide_user_streams": true,
    "enable_attendance_check": false,
    "enable_simultaneous_interpretation": false,
    "enable_simultaneous_interpretation_for_users": false,
    "start_active": false,
    "return_url": "",
    "allow_reactions": false
  }
}