REST ClientVideoVideoConferences

update

View as MarkdownOpen in Claude

Replace a video conference. Uses PUT for full replacement, so all fields must be provided in the request body.

This method performs a full replacement (PUT), not a partial update (PATCH). Include all fields you want to keep in the request body.

Path parameters

idstringRequiredformat: "uuid"
Unique ID of the video conference.

Request

display_namestringRequired<=200 characters
Display name of the video conference. Maximum of 200 characters.
descriptionstringOptional<=3000 characters
Description of the conference. Maximum of 3000 characters.
join_fromdatetimeOptional
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_untildatetimeOptional
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`.
qualityenumOptionalDefaults to 720p
The conference's resolution.
layoutenumOptionalDefaults to grid-responsive
The conference's initial layout.
sizeenumOptionalDefaults to medium
The size of the video conference.
record_on_startbooleanOptional
Whether to start recording when a conference session begins.
tone_on_entry_and_exitbooleanOptional
Whether a tone is played when a member enters or exits the conference.
room_join_video_offbooleanOptional
Whether participants join with video off by room setting.
user_join_video_offbooleanOptional
Whether participants join with video off by user setting.
enable_room_previewsbooleanOptional
Whether a preview video of the conference content is generated.
enable_chatbooleanOptional
Whether group chat is enabled for conference participants.
dark_primarystringOptionalformat: "^#[0-9a-fA-F]{6}$"
CTA buttons and selected items color (dark theme).
dark_backgroundstringOptionalformat: "^#[0-9a-fA-F]{6}$"
Main background color (dark theme).
dark_foregroundstringOptionalformat: "^#[0-9a-fA-F]{6}$"
Main foreground color (dark theme).
dark_successstringOptionalformat: "^#[0-9a-fA-F]{6}$"
Success indication color (dark theme).
dark_negativestringOptionalformat: "^#[0-9a-fA-F]{6}$"
Error indication color (dark theme).
light_primarystringOptionalformat: "^#[0-9a-fA-F]{6}$"
CTA buttons and selected items color (light theme).
light_backgroundstringOptionalformat: "^#[0-9a-fA-F]{6}$"
Main background color (light theme).
light_foregroundstringOptionalformat: "^#[0-9a-fA-F]{6}$"
Main foreground color (light theme).
light_successstringOptionalformat: "^#[0-9a-fA-F]{6}$"
Success indication color (light theme).
light_negativestringOptionalformat: "^#[0-9a-fA-F]{6}$"
Error indication color (light theme).

Response

idstringRequiredformat: "uuid"
Unique ID of the video conference.
namestringRequired
A named unique identifier for the conference. Allowed characters: `A-Za-z0-9_-`.
display_namestring or nullRequired
Display name of the video conference. Maximum of 200 characters.
descriptionstring or nullRequired
Description of the conference. Maximum of 3000 characters.
join_fromdatetime or nullRequired
Conference does not accept new participants before this time.
join_untildatetime or nullRequired
Conference stops accepting new participants at this time, but keeps running until all participants leave.
qualityenumRequired
The conference's resolution.
layoutenumRequired
The conference's initial layout.
sizeenum or nullRequired
The size of the video conference.
record_on_startbooleanRequired
Whether to start recording when a conference session begins.
tone_on_entry_and_exitbooleanRequired
Whether a tone is played when a member enters or exits the conference.
user_join_video_offbooleanRequired
Whether participants join with video off by user setting.
room_join_video_offbooleanRequired
Whether participants join with video off by room setting.
enable_chatbooleanRequired
Whether group chat is enabled for conference participants.
enable_room_previewsboolean or nullRequired
Whether a preview video of the conference content is generated.
dark_primarystring or nullRequired
CTA buttons and selected items color (dark theme).
dark_backgroundstring or nullRequired
Main background color (dark theme).
dark_foregroundstring or nullRequired
Main foreground color (dark theme).
dark_successstring or nullRequired
Success indication color (dark theme).
dark_negativestring or nullRequired
Error indication color (dark theme).
light_primarystring or nullRequired
CTA buttons and selected items color (light theme).
light_backgroundstring or nullRequired
Main background color (light theme).
light_foregroundstring or nullRequired
Main foreground color (light theme).
light_successstring or nullRequired
Success indication color (light theme).
light_negativestring or nullRequired
Error indication color (light theme).
metaobject or nullRequired
User-defined metadata for the conference.
created_atdatetimeRequired
Timestamp when the conference was created.
updated_atdatetimeRequired
Timestamp when the conference was last updated.
active_sessionobjectOptional
Active session information. Only present when requested via the `include_active_session` query parameter.

Response Example

Response
1{
2  "id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
3  "name": "my_conference",
4  "display_name": "My Conference's Name",
5  "description": "This conference will be used for full company all hands meetings",
6  "join_from": "2022-01-01T00:00:00Z",
7  "join_until": "2022-12-31T23:59:59Z",
8  "quality": "720p",
9  "layout": "grid-responsive",
10  "size": "medium",
11  "record_on_start": false,
12  "tone_on_entry_and_exit": true,
13  "user_join_video_off": false,
14  "room_join_video_off": false,
15  "enable_chat": true,
16  "enable_room_previews": false,
17  "dark_primary": "#044EF4",
18  "dark_background": "#FFFFFF",
19  "dark_foreground": "#1D2127",
20  "dark_success": "#17BB58",
21  "dark_negative": "#F42C50",
22  "light_primary": "#044EF4",
23  "light_background": "#FFFFFF",
24  "light_foreground": "#1D2127",
25  "light_success": "#17BB58",
26  "light_negative": "#F42C50",
27  "meta": {},
28  "created_at": "2022-01-01T10:00:00Z",
29  "updated_at": "2022-01-01T11:00:00Z",
30  "active_session": {
31    "id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
32    "room_id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
33    "name": "my_example_room",
34    "display_name": "My Room's Name",
35    "join_from": "2022-01-01T00:00:00Z",
36    "join_until": "2022-12-31T23:59:59Z",
37    "remove_at": "2022-12-31T23:59:59Z",
38    "remove_after_seconds_elapsed": 120,
39    "layout": "grid-responsive",
40    "max_members": 20,
41    "fps": 20,
42    "quality": "720p",
43    "start_time": "2022-01-01T10:00:00Z",
44    "end_time": "2022-01-01T11:00:00Z",
45    "duration": 120,
46    "status": "completed",
47    "record_on_start": true,
48    "enable_room_previews": true,
49    "preview_url": "https://example.signalwire.com/api/video/room_sessions/c22d24f6-5a47-4597-9a23-c7d01e696b92/preview",
50    "audio_video_sync": true
51  }
52}

Example

1from signalwire.rest import RestClient
2
3client = RestClient(
4    project="your-project-id",
5    token="your-api-token",
6    host="your-space.signalwire.com",
7)
8
9conf = client.video.conferences.update("conference-id", display_name="Team Meeting v2")