Update Video Room

PUT 
/resources/video_rooms/:id

Updates a video room by ID.

Request

Path Parameters

id uuidrequired

Unique ID of the video room

application/json

Body

required

display_name string
max_members integer
quality string
join_from date-time
join_until date-time
remove_at date-time
remove_after_seconds_elapsed integer
layout string
record_on_start boolean
enable_room_previews boolean
sync_audio_video boolean
meta object

Responses

200

A video room

application/json

Schema

Schema

id uuid
project_id uuid
display_name string
type string
created_at date-time
updated_at date-time

video_room

object

display_name string

max_members integer

quality string

join_from date-time

join_until date-time

remove_at date-time

remove_after_seconds_elapsed integer

layout string

record_on_start boolean

enable_room_previews boolean

sync_audio_video boolean

meta object

name string

id uuid

fps integer

prioritize_hand_raise boolean

Example (from schema)

{
  "id": "993ed018-9e79-4e50-b97b-984bd5534095",
  "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
  "display_name": "Reception",
  "type": "video_room",
  "created_at": "2024-01-02T00:00:00Z",
  "updated_at": "2024-01-02T00:00:00Z",
  "video_room": {
    "display_name": "Reception",
    "max_members": 30,
    "quality": "720p",
    "join_from": "2024-01-02T00:00:00Z",
    "join_until": "2024-01-02T01:00:00Z",
    "remove_at": "2024-01-02T02:00:00Z",
    "remove_after_seconds_elapsed": 3600,
    "layout": "grid-responsive",
    "record_on_start": true,
    "enable_room_previews": true,
    "sync_audio_video": true,
    "meta": {},
    "name": "reception",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "fps": 20,
    "prioritize_hand_raise": true
  }
}

422

Unprocessable Entity

application/json

Schema

Schema

type stringrequired
code stringrequired
message stringrequired
attribute string
url urirequired

Example (from schema)

{
  "type": "validation_error",
  "code": "invalid_parameter",
  "message": "Name must be present",
  "attribute": "name",
  "url": "https://docs.signalwire.com/api/errors#invalid_parameter"
}

Loading...