v77

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-08-012528701.8 MB

Conference Rooms

Update conference room

Updates a Conference Room by ID

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice, Messaging, Fax, or Video.

Learn more about API scopes.

put/api/fabric/resources/conference_rooms/{id}

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of a Conference Room.

Request body

namestring

The name of the Conference Room

display_namestring

Display name of the Conference Room

descriptionstring

The descrption of the Conference Room

join_fromstring date-time

The time users are allowed to start joining the conference. Joining before this time will result in failure to join the conference.

join_untilstring date-time

The time users are allowed to until the conference is locked. Attempting to join the conference after the set time will result in failure to join the conference.

max_membersinteger

Maximum number of members allowed in the conference room

quality'1080p' | '720p'

The viudeo quality of the Conference Room.

remove_atstring date-time

The time to remove all participants from the conference.

remove_after_seconds_elapsedinteger

The amount of time in seconds to remove a particpant from a conference after they join.

layout'grid-responsive' | 'grid-responsive-mobile' | 'highlight-1-responsive' | '1x1' | '2x1' | '2x2' | '5up' | '3x3' | '4x4' | '5x5' | '6x6' | '8x8' | '10x10'

record_on_startboolean

Starts recording when the conference starts.

enable_room_previewsboolean required

Enables live video room previews for the conference.

metaobject

Metadata of the conference.

sync_audio_videoboolean required

Syncs the participants audio and video.

tone_on_entry_and_exitboolean

Plays a tone when a participant joins or leaves the conference.

room_join_video_offboolean

Turns the conference video off when the participant joins the room if true.

user_join_video_offboolean

Turns the participants video off when the participant joins the room if true.

Example request

{
  "name": "coffee_cafe",
  "display_name": "Reception",
  "description": "This room is for coffee, no shop talk",
  "join_from": "2024-05-06T12:20:00Z",
  "join_until": "2024-05-06T12:20:00Z",
  "max_members": 30,
  "quality": "1080p",
  "remove_at": "2024-05-06T12:20:00Z",
  "record_on_start": true,
  "enable_room_previews": true,
  "meta": {
    "foo": "bar"
  },
  "sync_audio_video": true,
  "tone_on_entry_and_exit": true,
  "room_join_video_off": true,
  "user_join_video_off": true
}

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

project_idstring uuid required

Universal Unique Identifier.

display_namestring required

Display name of the Conference Room Fabric Resource

type'video_room' required

Type of the Fabric Resource

created_atstring date-time required

Date and time when the resource was created.

updated_atstring date-time required

Date and time when the resource was updated.

Example response

{
  "display_name": "Reception",
  "type": "video_room",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:20:00Z",
  "conference_room": {
    "name": "coffee_cafe",
    "description": "This room is for coffee, no shop talk",
    "display_name": "Reception",
    "max_members": 30,
    "quality": "1080p",
    "fps": 30,
    "join_from": "2024-05-06T12:20:00Z",
    "join_until": "2024-05-06T12:20:00Z",
    "remove_at": "2024-05-06T12:20:00Z",
    "record_on_start": true,
    "tone_on_entry_and_exit": true,
    "room_join_video_off": true,
    "user_join_video_off": true,
    "enable_room_previews": true,
    "sync_audio_video": true,
    "meta": {
      "foo": "bar"
    }
  }
}