Update a room-config template
curl --request PATCH \
--url https://api.orbit.devotel.io/api/v1/video/room-templates/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"config": {
"max_participants": 151,
"max_duration_minutes": 722,
"recording_enabled": true,
"recording_output": {
"width": 2000,
"height": 1140,
"framerate": 30,
"video_bitrate_kbps": 10050
},
"simulcast": true,
"spatial_layers": 2,
"max_bitrate_kbps": 4050,
"e2ee": true,
"audio_only": true,
"captions_required": true,
"waiting_room": true,
"waiting_room_auto_promote": true
}
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/video/room-templates/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"config": {
"max_participants": 151,
"max_duration_minutes": 722,
"recording_enabled": True,
"recording_output": {
"width": 2000,
"height": 1140,
"framerate": 30,
"video_bitrate_kbps": 10050
},
"simulcast": True,
"spatial_layers": 2,
"max_bitrate_kbps": 4050,
"e2ee": True,
"audio_only": True,
"captions_required": True,
"waiting_room": True,
"waiting_room_auto_promote": True
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
config: {
max_participants: 151,
max_duration_minutes: 722,
recording_enabled: true,
recording_output: {width: 2000, height: 1140, framerate: 30, video_bitrate_kbps: 10050},
simulcast: true,
spatial_layers: 2,
max_bitrate_kbps: 4050,
e2ee: true,
audio_only: true,
captions_required: true,
waiting_room: true,
waiting_room_auto_promote: true
}
})
};
fetch('https://api.orbit.devotel.io/api/v1/video/room-templates/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbit.devotel.io/api/v1/video/room-templates/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'config' => [
'max_participants' => 151,
'max_duration_minutes' => 722,
'recording_enabled' => true,
'recording_output' => [
'width' => 2000,
'height' => 1140,
'framerate' => 30,
'video_bitrate_kbps' => 10050
],
'simulcast' => true,
'spatial_layers' => 2,
'max_bitrate_kbps' => 4050,
'e2ee' => true,
'audio_only' => true,
'captions_required' => true,
'waiting_room' => true,
'waiting_room_auto_promote' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/api/v1/video/room-templates/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"config\": {\n \"max_participants\": 151,\n \"max_duration_minutes\": 722,\n \"recording_enabled\": true,\n \"recording_output\": {\n \"width\": 2000,\n \"height\": 1140,\n \"framerate\": 30,\n \"video_bitrate_kbps\": 10050\n },\n \"simulcast\": true,\n \"spatial_layers\": 2,\n \"max_bitrate_kbps\": 4050,\n \"e2ee\": true,\n \"audio_only\": true,\n \"captions_required\": true,\n \"waiting_room\": true,\n \"waiting_room_auto_promote\": true\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.orbit.devotel.io/api/v1/video/room-templates/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"config\": {\n \"max_participants\": 151,\n \"max_duration_minutes\": 722,\n \"recording_enabled\": true,\n \"recording_output\": {\n \"width\": 2000,\n \"height\": 1140,\n \"framerate\": 30,\n \"video_bitrate_kbps\": 10050\n },\n \"simulcast\": true,\n \"spatial_layers\": 2,\n \"max_bitrate_kbps\": 4050,\n \"e2ee\": true,\n \"audio_only\": true,\n \"captions_required\": true,\n \"waiting_room\": true,\n \"waiting_room_auto_promote\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/video/room-templates/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"config\": {\n \"max_participants\": 151,\n \"max_duration_minutes\": 722,\n \"recording_enabled\": true,\n \"recording_output\": {\n \"width\": 2000,\n \"height\": 1140,\n \"framerate\": 30,\n \"video_bitrate_kbps\": 10050\n },\n \"simulcast\": true,\n \"spatial_layers\": 2,\n \"max_bitrate_kbps\": 4050,\n \"e2ee\": true,\n \"audio_only\": true,\n \"captions_required\": true,\n \"waiting_room\": true,\n \"waiting_room_auto_promote\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"template": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"config": {
"max_participants": 151,
"max_duration_minutes": 722,
"recording_enabled": true,
"recording_output": {
"width": 2000,
"height": 1140,
"framerate": 30,
"video_bitrate_kbps": 10050
},
"simulcast": true,
"spatial_layers": 2,
"max_bitrate_kbps": 4050,
"e2ee": true,
"audio_only": true,
"captions_required": true,
"waiting_room": true,
"waiting_room_auto_promote": true
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by": "<string>"
}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Video
Update a room-config template
Apply a partial update to a room-config template. At least one of name / description / config must be supplied; a null description clears it. config is a FULL replacement of the stored preset (validated in whole so the cross-field codec/SVC guard always runs), not a deep-merge. Owner/admin/developer only; scoped on video:write.
PATCH
/
api
/
v1
/
video
/
room-templates
/
{id}
Update a room-config template
curl --request PATCH \
--url https://api.orbit.devotel.io/api/v1/video/room-templates/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"config": {
"max_participants": 151,
"max_duration_minutes": 722,
"recording_enabled": true,
"recording_output": {
"width": 2000,
"height": 1140,
"framerate": 30,
"video_bitrate_kbps": 10050
},
"simulcast": true,
"spatial_layers": 2,
"max_bitrate_kbps": 4050,
"e2ee": true,
"audio_only": true,
"captions_required": true,
"waiting_room": true,
"waiting_room_auto_promote": true
}
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/video/room-templates/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"config": {
"max_participants": 151,
"max_duration_minutes": 722,
"recording_enabled": True,
"recording_output": {
"width": 2000,
"height": 1140,
"framerate": 30,
"video_bitrate_kbps": 10050
},
"simulcast": True,
"spatial_layers": 2,
"max_bitrate_kbps": 4050,
"e2ee": True,
"audio_only": True,
"captions_required": True,
"waiting_room": True,
"waiting_room_auto_promote": True
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
config: {
max_participants: 151,
max_duration_minutes: 722,
recording_enabled: true,
recording_output: {width: 2000, height: 1140, framerate: 30, video_bitrate_kbps: 10050},
simulcast: true,
spatial_layers: 2,
max_bitrate_kbps: 4050,
e2ee: true,
audio_only: true,
captions_required: true,
waiting_room: true,
waiting_room_auto_promote: true
}
})
};
fetch('https://api.orbit.devotel.io/api/v1/video/room-templates/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbit.devotel.io/api/v1/video/room-templates/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'config' => [
'max_participants' => 151,
'max_duration_minutes' => 722,
'recording_enabled' => true,
'recording_output' => [
'width' => 2000,
'height' => 1140,
'framerate' => 30,
'video_bitrate_kbps' => 10050
],
'simulcast' => true,
'spatial_layers' => 2,
'max_bitrate_kbps' => 4050,
'e2ee' => true,
'audio_only' => true,
'captions_required' => true,
'waiting_room' => true,
'waiting_room_auto_promote' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/api/v1/video/room-templates/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"config\": {\n \"max_participants\": 151,\n \"max_duration_minutes\": 722,\n \"recording_enabled\": true,\n \"recording_output\": {\n \"width\": 2000,\n \"height\": 1140,\n \"framerate\": 30,\n \"video_bitrate_kbps\": 10050\n },\n \"simulcast\": true,\n \"spatial_layers\": 2,\n \"max_bitrate_kbps\": 4050,\n \"e2ee\": true,\n \"audio_only\": true,\n \"captions_required\": true,\n \"waiting_room\": true,\n \"waiting_room_auto_promote\": true\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.orbit.devotel.io/api/v1/video/room-templates/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"config\": {\n \"max_participants\": 151,\n \"max_duration_minutes\": 722,\n \"recording_enabled\": true,\n \"recording_output\": {\n \"width\": 2000,\n \"height\": 1140,\n \"framerate\": 30,\n \"video_bitrate_kbps\": 10050\n },\n \"simulcast\": true,\n \"spatial_layers\": 2,\n \"max_bitrate_kbps\": 4050,\n \"e2ee\": true,\n \"audio_only\": true,\n \"captions_required\": true,\n \"waiting_room\": true,\n \"waiting_room_auto_promote\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/video/room-templates/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"config\": {\n \"max_participants\": 151,\n \"max_duration_minutes\": 722,\n \"recording_enabled\": true,\n \"recording_output\": {\n \"width\": 2000,\n \"height\": 1140,\n \"framerate\": 30,\n \"video_bitrate_kbps\": 10050\n },\n \"simulcast\": true,\n \"spatial_layers\": 2,\n \"max_bitrate_kbps\": 4050,\n \"e2ee\": true,\n \"audio_only\": true,\n \"captions_required\": true,\n \"waiting_room\": true,\n \"waiting_room_auto_promote\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"template": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"config": {
"max_participants": 151,
"max_duration_minutes": 722,
"recording_enabled": true,
"recording_output": {
"width": 2000,
"height": 1140,
"framerate": 30,
"video_bitrate_kbps": 10050
},
"simulcast": true,
"spatial_layers": 2,
"max_bitrate_kbps": 4050,
"e2ee": true,
"audio_only": true,
"captions_required": true,
"waiting_room": true,
"waiting_room_auto_promote": true
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by": "<string>"
}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Path Parameters
The vrtpl_-prefixed template id.
Body
application/json
Required string length:
1 - 120Maximum string length:
500The reusable, NON-SECRET room-config preset stored on a video room-config template. Every field is optional and maps 1:1 to the identically-named POST /video/rooms-scheduled room-create knob; an empty object is a valid 'all defaults' preset. Unknown keys are rejected, and secret-bearing fields (BYO recording-storage credentials, consent receipts) are intentionally never part of a template.
Show child attributes
Show child attributes
⌘I