Skip to main content

Update a Video Conference

Update a Video conference.

Permissions

The API token must include the following scopes: Video.

Path Parameters
id uuid REQUIRED

Unique ID of the video conference

Request Body REQUIRED
name string

A named unique identifier for the room. Allowed characters: A-Za-z0-9_-. Maximum of 100 characters.

display_name string

Display name of the video conference. Maximum of 200 characters. Defaults to the value of name.

join_from date-time

Conference does not accept new participants before this time. Expects RFC 3339 datetime: 2022-01-01T23:59:60Z. Date only: 2022-01-01 will be converted to 2022-01-01T00:00:00Z

join_until date-time

Conference stops accepting new participants at this time, but keeps running until all participants leave. Expects RFC 3339 datetime: 2022-01-01T23:59:60Z. Date only: 2022-01-01 will be converted to 2022-01-01T00:00:00Z

quality string

The conference's resolution. Allowed values are 720p or 1080p. Defaults to 720p.

layout string

The conference's initial layout. Defaults to grid-responsive. See documentation for a full list of supported layouts.

size string

The size of the video conference. Allowed values are small, medium and large. Defaults to medium. See documentation for a list of size limitations.

record_on_start boolean

Specifies whether to start recording a Conference Session when one is started for this Conference

enable_room_previews boolean

Whether a video with a preview of the content of the conference is to be generated.

enable_chat boolean

Enables group chat for all participants of the room. Defaults to true.

dark_primary string

Used for CTA buttons and selected items. Defaults to #044EF4

dark_background string

Main background color. Defaults to #FFFFFF

dark_foreground string

Main foreground color. Defaults to #1D2127

dark_success string

Used for success indications. Defaults to #17BB58

dark_negative string

Used for error indications. Defaults to #F42C50

light_primary string

Used for CTA buttons and selected items. Defaults to #044EF4

light_background string

Main background color. Defaults to #FFFFFF

light_foreground string

Main foreground color. Defaults to #1D2127

light_success string

Used for success indications. Defaults to #17BB58

light_negative string

Used for error indications. Defaults to #F42C50

Responses
200

OK

Schema OPTIONAL
id uuid OPTIONAL

A unique identifier for the video conference

name string OPTIONAL

A named unique identifier for the room. Allowed characters: A-Za-z0-9_-. Maximum of 100 characters.

display_name string OPTIONAL

Display name of the video conference. Maximum of 200 characters. Defaults to the value of name.

join_from date-time OPTIONAL

Conference does not accept new participants before this time. Expects RFC 3339 datetime: 2022-01-01T23:59:60Z. Date only: 2022-01-01 will be converted to 2022-01-01T00:00:00Z

join_until date-time OPTIONAL

Conference stops accepting new participants at this time, but keeps running until all participants leave. Expects RFC 3339 datetime: 2022-01-01T23:59:60Z. Date only: 2022-01-01 will be converted to 2022-01-01T00:00:00Z

quality string OPTIONAL

The conference's resolution. Allowed values are 720p or 1080p. Defaults to 720p.

layout string OPTIONAL

The conference's initial layout. Defaults to grid-responsive. See documentation for a full list of supported layouts.

size string OPTIONAL

The size of the video conference. Allowed values are small, medium and large. Defaults to medium. See documentation for a list of size limitations.

record_on_start boolean OPTIONAL

Specifies whether to start recording a Conference Session when one is started for this Conference

enable_room_previews boolean OPTIONAL

Whether a video with a preview of the content of the conference is to be generated.

enable_chat boolean OPTIONAL

Enables group chat for all participants of the room. Defaults to true.

dark_primary string OPTIONAL

Used for CTA buttons and selected items. Defaults to #044EF4

dark_background string OPTIONAL

Main background color. Defaults to #FFFFFF

dark_foreground string OPTIONAL

Main foreground color. Defaults to #1D2127

dark_success string OPTIONAL

Used for success indications. Defaults to #17BB58

dark_negative string OPTIONAL

Used for error indications. Defaults to #F42C50

light_primary string OPTIONAL

Used for CTA buttons and selected items. Defaults to #044EF4

light_background string OPTIONAL

Main background color. Defaults to #FFFFFF

light_foreground string OPTIONAL

Main foreground color. Defaults to #1D2127

light_success string OPTIONAL

Used for success indications. Defaults to #17BB58

light_negative string OPTIONAL

Used for error indications. Defaults to #F42C50

created_at date-time OPTIONAL
updated_at date-time OPTIONAL
active_session object OPTIONAL
id uuid OPTIONAL

Unique ID of the session

room_id uuid OPTIONAL

Unique ID of the Room if the Session was created from a Room and was not an auto-created Session.

name string OPTIONAL

The named identifier of room session.

display_name string OPTIONAL

Display name of room, no character limitations. Maxium of 200 characters. Defaults to the value of name.

join_from date-time OPTIONAL

Room Session does not accept new Members before this time.

join_until date-time OPTIONAL

Room Session stops accepting new Members at this time.

remove_at date-time OPTIONAL

Remove Members from the Room Session at this time.

remove_after_seconds_elapsed int32 OPTIONAL

Remove Members after they are in the Room Session for N seconds.

layout string OPTIONAL

The Room Session's initial layout. Defaults to grid-responsive. See documentation for a full list of supported layouts.

max_members integer OPTIONAL

The maximum number of members allowed in the room at a time.

fps integer OPTIONAL

The Room Session's frames per second. Possible values are 20 or 30.

quality string OPTIONAL

The Room Session's resolution. Possible values are 720p or 1080p.

start_time date-time OPTIONAL
end_time date-time OPTIONAL
duration integer OPTIONAL

How long, in seconds, the Room Session lasted.

status string OPTIONAL
record_on_start boolean OPTIONAL

Whether a recording was automatically started when this Room Session began.

enable_room_previews boolean OPTIONAL

Whether a video with a preview of the content of the room is to be generated.

preview_url string OPTIONAL

If room previews are enabled and the room session is in progress, this is the URL of the preview video.