--- title: Presets --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [Realtime Kit](https://developers.cloudflare.com/api/resources/realtime_kit) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Presets ##### [Fetch all presets](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/presets/methods/get) GET/accounts/{account\_id}/realtime/kit/{app\_id}/presets ##### [Create a preset](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/presets/methods/create) POST/accounts/{account\_id}/realtime/kit/{app\_id}/presets ##### [Fetch details of a preset](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/presets/methods/get_preset_by_id) GET/accounts/{account\_id}/realtime/kit/{app\_id}/presets/{preset\_id} ##### [Delete a preset](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/presets/methods/delete) DELETE/accounts/{account\_id}/realtime/kit/{app\_id}/presets/{preset\_id} ##### [Update a preset](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/presets/methods/update) PATCH/accounts/{account\_id}/realtime/kit/{app\_id}/presets/{preset\_id} ##### [Replace a preset](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/presets/methods/replace_preset_by_id) PUT/accounts/{account\_id}/realtime/kit/{app\_id}/presets/{preset\_id} ##### ModelsExpand Collapse
PresetGetResponse object {data, paging, success }
data: array of object {id, created\_at, name, updated\_at } id: optional string ID of the preset formatuuid Link to this property created\_at: optional string Timestamp this preset was created at formatdate-time Link to this property name: optional string Name of the preset Link to this property updated\_at: optional string Timestamp this preset was last updated formatdate-time Link to this property
Link to this property
paging: object {end\_offset, start\_offset, total\_count } end\_offset: number Link to this property start\_offset: number Link to this property total\_count: number minimum0 Link to this property
Link to this property success: boolean Link to this property
[Link to this property](<#(resource)%20realtime_kit.presets%20%3E%20(model)%20preset_get_response%20%3E%20(schema)>)
PresetCreateResponse object {data, success }
data: object {id, config, created\_at, 4 more } Data returned by the operation id: string ID of the preset formatuuid Link to this property
config: object {max\_screenshare\_count, max\_video\_streams, media, 2 more } max\_screenshare\_count: number Maximum number of screen shares that can be active at a given time Link to this property
max\_video\_streams: object {desktop, mobile } Maximum number of streams that are visible on a device desktop: number Maximum number of video streams visible on desktop devices Link to this property mobile: number Maximum number of streams visible on mobile devices Link to this property
Link to this property
media: object {screenshare, video, audio } Media configuration options. eg: Video quality
screenshare: object {frame\_rate, quality } Configuration options for participant screen shares frame\_rate: number Frame rate of screen share Link to this property
quality: "hd"or "vga"or "qvga"or 2 more Quality of screen share One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property
Link to this property
video: object {frame\_rate, quality, simulcast } Configuration options for participant videos frame\_rate: number Frame rate of participants’ video maximum30 Link to this property
quality: "hd"or "vga"or "qvga"or 2 more Video quality of participants One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property simulcast: optional boolean Enable simulcast for participant videos. Link to this property
Link to this property
audio: optional object {enable\_high\_bitrate, enable\_stereo } Control options for Audio quality. enable\_high\_bitrate: optional boolean Enable High Quality Audio for your meetings Link to this property enable\_stereo: optional boolean Enable Stereo for your meetings Link to this property
Link to this property
Link to this property
view\_type: "GROUP\_CALL"or "WEBINAR"or "AUDIO\_ROOM"or "LIVESTREAM" Type of the meeting One of the following: "GROUP\_CALL" Link to this property "WEBINAR" Link to this property "AUDIO\_ROOM" Link to this property "LIVESTREAM" Link to this property
Link to this property livestream\_viewer\_qualities: optional array of number Livestream viewer quality levels. Link to this property
Link to this property created\_at: string Timestamp this preset was created at formatdate-time Link to this property name: string Name of the preset Link to this property
permissions: object {accept\_waiting\_requests, can\_accept\_production\_requests, can\_change\_participant\_permissions, 23 more } accept\_waiting\_requests: boolean Whether this participant can accept waiting requests Link to this property can\_accept\_production\_requests: boolean Link to this property can\_change\_participant\_permissions: boolean Link to this property can\_edit\_display\_name: boolean Link to this property can\_livestream: boolean Link to this property can\_record: boolean Link to this property can\_spotlight: boolean Link to this property
chat: object {private, public }
private: object {can\_receive, can\_send, files, text } can\_receive: boolean Link to this property can\_send: boolean Link to this property files: boolean Link to this property text: boolean Link to this property
Link to this property
public: object {can\_send, files, text } can\_send: boolean Can send messages in general Link to this property files: boolean Can send file messages Link to this property text: boolean Can send text messages Link to this property
Link to this property
Link to this property
connected\_meetings: object {can\_alter\_connected\_meetings, can\_switch\_connected\_meetings, can\_switch\_to\_parent\_meeting } can\_alter\_connected\_meetings: boolean Link to this property can\_switch\_connected\_meetings: boolean Link to this property can\_switch\_to\_parent\_meeting: boolean Link to this property
Link to this property disable\_participant\_audio: boolean Link to this property disable\_participant\_screensharing: boolean Link to this property disable\_participant\_video: boolean Link to this property hidden\_participant: boolean Whether this participant is visible to others or not Link to this property kick\_participant: boolean Link to this property
media: object {audio, screenshare, video } Media permissions
audio: object {can\_produce } Audio permissions
can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "CAN\_REQUEST" Can produce audio One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
screenshare: object {can\_produce } Screenshare permissions
can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "CAN\_REQUEST" Can produce screen share video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
video: object {can\_produce } Video permissions
can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "CAN\_REQUEST" Can produce video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
Link to this property pin\_participant: boolean Link to this property
plugins: object {can\_close, can\_edit\_config, can\_start, config } Plugin permissions can\_close: boolean Can close plugins that are already open Link to this property can\_edit\_config: boolean Can edit plugin config Link to this property can\_start: boolean Can start plugins Link to this property
config: map\[object {access\_control, handles\_view\_only } ] Plugin configuration keyed by plugin UUID.
access\_control: optional "FULL\_ACCESS"or "VIEW\_ONLY" One of the following: "FULL\_ACCESS" Link to this property "VIEW\_ONLY" Link to this property
Link to this property handles\_view\_only: optional boolean Link to this property
Link to this property
Link to this property
polls: object {can\_create, can\_view, can\_vote } Poll permissions can\_create: boolean Can create polls Link to this property can\_view: boolean Can view polls Link to this property can\_vote: boolean Can vote on polls Link to this property
Link to this property
recorder\_type: "RECORDER"or "LIVESTREAMER"or "NONE" Type of the recording peer One of the following: "RECORDER" Link to this property "LIVESTREAMER" Link to this property "NONE" Link to this property
Link to this property show\_participant\_list: boolean Link to this property
waiting\_room\_type: "SKIP"or "ON\_PRIVILEGED\_USER\_ENTRY"or "SKIP\_ON\_ACCEPT" Waiting room type One of the following: "SKIP" Link to this property "ON\_PRIVILEGED\_USER\_ENTRY" Link to this property "SKIP\_ON\_ACCEPT" Link to this property
Link to this property accept\_stage\_requests: optional boolean Link to this property is\_recorder: optional boolean Link to this property
stage\_access: optional "ALLOWED"or "NOT\_ALLOWED"or "CAN\_REQUEST" One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property stage\_enabled: optional boolean Link to this property transcription\_enabled: optional boolean Link to this property
Link to this property
ui: object {design\_tokens }
design\_tokens: object {border\_radius, border\_width, colors, 5 more }
border\_radius: "sharp"or "rounded"or "extra-rounded"or "circular" One of the following: "sharp" Link to this property "rounded" Link to this property "extra-rounded" Link to this property "circular" Link to this property
Link to this property
border\_width: "none"or "thin"or "fat" One of the following: "none" Link to this property "thin" Link to this property "fat" Link to this property
Link to this property
colors: object {background, brand, danger, 5 more }
background: object {"1000", "600", "700", 2 more } "1000": string Link to this property "600": string Link to this property "700": string Link to this property "800": string Link to this property "900": string Link to this property
Link to this property
brand: object {"300", "400", "500", 2 more } "300": string Link to this property "400": string Link to this property "500": string Link to this property "600": string Link to this property "700": string Link to this property
Link to this property danger: string Link to this property success: string Link to this property text: string Link to this property text\_on\_brand: string Link to this property video\_bg: string Link to this property warning: string Link to this property
Link to this property spacing\_base: number minimum1 Link to this property
theme: "darkest"or "dark"or "light" One of the following: "darkest" Link to this property "dark" Link to this property "light" Link to this property
Link to this property font\_family: optional string Link to this property google\_font: optional string Link to this property logo: optional string formaturi Link to this property
Link to this property
Link to this property updated\_at: string Timestamp this preset was last updated formatdate-time Link to this property
Link to this property success: boolean Success status of the operation Link to this property
[Link to this property](<#(resource)%20realtime_kit.presets%20%3E%20(model)%20preset_create_response%20%3E%20(schema)>)
PresetGetPresetByIDResponse object {data, success }
data: object {id, config, created\_at, 4 more } Data returned by the operation id: string ID of the preset formatuuid Link to this property
config: object {max\_screenshare\_count, max\_video\_streams, media, 2 more } max\_screenshare\_count: number Maximum number of screen shares that can be active at a given time Link to this property
max\_video\_streams: object {desktop, mobile } Maximum number of streams that are visible on a device desktop: number Maximum number of video streams visible on desktop devices Link to this property mobile: number Maximum number of streams visible on mobile devices Link to this property
Link to this property
media: object {screenshare, video, audio } Media configuration options. eg: Video quality
screenshare: object {frame\_rate, quality } Configuration options for participant screen shares frame\_rate: number Frame rate of screen share Link to this property
quality: "hd"or "vga"or "qvga"or 2 more Quality of screen share One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property
Link to this property
video: object {frame\_rate, quality, simulcast } Configuration options for participant videos frame\_rate: number Frame rate of participants’ video maximum30 Link to this property
quality: "hd"or "vga"or "qvga"or 2 more Video quality of participants One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property simulcast: optional boolean Enable simulcast for participant videos. Link to this property
Link to this property
audio: optional object {enable\_high\_bitrate, enable\_stereo } Control options for Audio quality. enable\_high\_bitrate: optional boolean Enable High Quality Audio for your meetings Link to this property enable\_stereo: optional boolean Enable Stereo for your meetings Link to this property
Link to this property
Link to this property
view\_type: "GROUP\_CALL"or "WEBINAR"or "AUDIO\_ROOM"or "LIVESTREAM" Type of the meeting One of the following: "GROUP\_CALL" Link to this property "WEBINAR" Link to this property "AUDIO\_ROOM" Link to this property "LIVESTREAM" Link to this property
Link to this property livestream\_viewer\_qualities: optional array of number Livestream viewer quality levels. Link to this property
Link to this property created\_at: string Timestamp this preset was created at formatdate-time Link to this property name: string Name of the preset Link to this property
permissions: object {accept\_waiting\_requests, can\_accept\_production\_requests, can\_change\_participant\_permissions, 23 more } accept\_waiting\_requests: boolean Whether this participant can accept waiting requests Link to this property can\_accept\_production\_requests: boolean Link to this property can\_change\_participant\_permissions: boolean Link to this property can\_edit\_display\_name: boolean Link to this property can\_livestream: boolean Link to this property can\_record: boolean Link to this property can\_spotlight: boolean Link to this property
chat: object {private, public }
private: object {can\_receive, can\_send, files, text } can\_receive: boolean Link to this property can\_send: boolean Link to this property files: boolean Link to this property text: boolean Link to this property
Link to this property
public: object {can\_send, files, text } can\_send: boolean Can send messages in general Link to this property files: boolean Can send file messages Link to this property text: boolean Can send text messages Link to this property
Link to this property
Link to this property
connected\_meetings: object {can\_alter\_connected\_meetings, can\_switch\_connected\_meetings, can\_switch\_to\_parent\_meeting } can\_alter\_connected\_meetings: boolean Link to this property can\_switch\_connected\_meetings: boolean Link to this property can\_switch\_to\_parent\_meeting: boolean Link to this property
Link to this property disable\_participant\_audio: boolean Link to this property disable\_participant\_screensharing: boolean Link to this property disable\_participant\_video: boolean Link to this property hidden\_participant: boolean Whether this participant is visible to others or not Link to this property kick\_participant: boolean Link to this property
media: object {audio, screenshare, video } Media permissions
audio: object {can\_produce } Audio permissions
can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "CAN\_REQUEST" Can produce audio One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
screenshare: object {can\_produce } Screenshare permissions
can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "CAN\_REQUEST" Can produce screen share video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
video: object {can\_produce } Video permissions
can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "CAN\_REQUEST" Can produce video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
Link to this property pin\_participant: boolean Link to this property
plugins: object {can\_close, can\_edit\_config, can\_start, config } Plugin permissions can\_close: boolean Can close plugins that are already open Link to this property can\_edit\_config: boolean Can edit plugin config Link to this property can\_start: boolean Can start plugins Link to this property
config: map\[object {access\_control, handles\_view\_only } ] Plugin configuration keyed by plugin UUID.
access\_control: optional "FULL\_ACCESS"or "VIEW\_ONLY" One of the following: "FULL\_ACCESS" Link to this property "VIEW\_ONLY" Link to this property
Link to this property handles\_view\_only: optional boolean Link to this property
Link to this property
Link to this property
polls: object {can\_create, can\_view, can\_vote } Poll permissions can\_create: boolean Can create polls Link to this property can\_view: boolean Can view polls Link to this property can\_vote: boolean Can vote on polls Link to this property
Link to this property
recorder\_type: "RECORDER"or "LIVESTREAMER"or "NONE" Type of the recording peer One of the following: "RECORDER" Link to this property "LIVESTREAMER" Link to this property "NONE" Link to this property
Link to this property show\_participant\_list: boolean Link to this property
waiting\_room\_type: "SKIP"or "ON\_PRIVILEGED\_USER\_ENTRY"or "SKIP\_ON\_ACCEPT" Waiting room type One of the following: "SKIP" Link to this property "ON\_PRIVILEGED\_USER\_ENTRY" Link to this property "SKIP\_ON\_ACCEPT" Link to this property
Link to this property accept\_stage\_requests: optional boolean Link to this property is\_recorder: optional boolean Link to this property
stage\_access: optional "ALLOWED"or "NOT\_ALLOWED"or "CAN\_REQUEST" One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property stage\_enabled: optional boolean Link to this property transcription\_enabled: optional boolean Link to this property
Link to this property
ui: object {design\_tokens }
design\_tokens: object {border\_radius, border\_width, colors, 5 more }
border\_radius: "sharp"or "rounded"or "extra-rounded"or "circular" One of the following: "sharp" Link to this property "rounded" Link to this property "extra-rounded" Link to this property "circular" Link to this property
Link to this property
border\_width: "none"or "thin"or "fat" One of the following: "none" Link to this property "thin" Link to this property "fat" Link to this property
Link to this property
colors: object {background, brand, danger, 5 more }
background: object {"1000", "600", "700", 2 more } "1000": string Link to this property "600": string Link to this property "700": string Link to this property "800": string Link to this property "900": string Link to this property
Link to this property
brand: object {"300", "400", "500", 2 more } "300": string Link to this property "400": string Link to this property "500": string Link to this property "600": string Link to this property "700": string Link to this property
Link to this property danger: string Link to this property success: string Link to this property text: string Link to this property text\_on\_brand: string Link to this property video\_bg: string Link to this property warning: string Link to this property
Link to this property spacing\_base: number minimum1 Link to this property
theme: "darkest"or "dark"or "light" One of the following: "darkest" Link to this property "dark" Link to this property "light" Link to this property
Link to this property font\_family: optional string Link to this property google\_font: optional string Link to this property logo: optional string formaturi Link to this property
Link to this property
Link to this property updated\_at: string Timestamp this preset was last updated formatdate-time Link to this property
Link to this property success: boolean Success status of the operation Link to this property
[Link to this property](<#(resource)%20realtime_kit.presets%20%3E%20(model)%20preset_get_preset_by_id_response%20%3E%20(schema)>)
PresetDeleteResponse object {data, success }
data: object {id, config, created\_at, 4 more } Data returned by the operation id: string ID of the preset formatuuid Link to this property
config: object {max\_screenshare\_count, max\_video\_streams, media, 2 more } max\_screenshare\_count: number Maximum number of screen shares that can be active at a given time Link to this property
max\_video\_streams: object {desktop, mobile } Maximum number of streams that are visible on a device desktop: number Maximum number of video streams visible on desktop devices Link to this property mobile: number Maximum number of streams visible on mobile devices Link to this property
Link to this property
media: object {screenshare, video, audio } Media configuration options. eg: Video quality
screenshare: object {frame\_rate, quality } Configuration options for participant screen shares frame\_rate: number Frame rate of screen share Link to this property
quality: "hd"or "vga"or "qvga"or 2 more Quality of screen share One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property
Link to this property
video: object {frame\_rate, quality, simulcast } Configuration options for participant videos frame\_rate: number Frame rate of participants’ video maximum30 Link to this property
quality: "hd"or "vga"or "qvga"or 2 more Video quality of participants One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property simulcast: optional boolean Enable simulcast for participant videos. Link to this property
Link to this property
audio: optional object {enable\_high\_bitrate, enable\_stereo } Control options for Audio quality. enable\_high\_bitrate: optional boolean Enable High Quality Audio for your meetings Link to this property enable\_stereo: optional boolean Enable Stereo for your meetings Link to this property
Link to this property
Link to this property
view\_type: "GROUP\_CALL"or "WEBINAR"or "AUDIO\_ROOM"or "LIVESTREAM" Type of the meeting One of the following: "GROUP\_CALL" Link to this property "WEBINAR" Link to this property "AUDIO\_ROOM" Link to this property "LIVESTREAM" Link to this property
Link to this property livestream\_viewer\_qualities: optional array of number Livestream viewer quality levels. Link to this property
Link to this property created\_at: string Timestamp this preset was created at formatdate-time Link to this property name: string Name of the preset Link to this property
permissions: object {accept\_waiting\_requests, can\_accept\_production\_requests, can\_change\_participant\_permissions, 23 more } accept\_waiting\_requests: boolean Whether this participant can accept waiting requests Link to this property can\_accept\_production\_requests: boolean Link to this property can\_change\_participant\_permissions: boolean Link to this property can\_edit\_display\_name: boolean Link to this property can\_livestream: boolean Link to this property can\_record: boolean Link to this property can\_spotlight: boolean Link to this property
chat: object {private, public }
private: object {can\_receive, can\_send, files, text } can\_receive: boolean Link to this property can\_send: boolean Link to this property files: boolean Link to this property text: boolean Link to this property
Link to this property
public: object {can\_send, files, text } can\_send: boolean Can send messages in general Link to this property files: boolean Can send file messages Link to this property text: boolean Can send text messages Link to this property
Link to this property
Link to this property
connected\_meetings: object {can\_alter\_connected\_meetings, can\_switch\_connected\_meetings, can\_switch\_to\_parent\_meeting } can\_alter\_connected\_meetings: boolean Link to this property can\_switch\_connected\_meetings: boolean Link to this property can\_switch\_to\_parent\_meeting: boolean Link to this property
Link to this property disable\_participant\_audio: boolean Link to this property disable\_participant\_screensharing: boolean Link to this property disable\_participant\_video: boolean Link to this property hidden\_participant: boolean Whether this participant is visible to others or not Link to this property kick\_participant: boolean Link to this property
media: object {audio, screenshare, video } Media permissions
audio: object {can\_produce } Audio permissions
can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "CAN\_REQUEST" Can produce audio One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
screenshare: object {can\_produce } Screenshare permissions
can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "CAN\_REQUEST" Can produce screen share video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
video: object {can\_produce } Video permissions
can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "CAN\_REQUEST" Can produce video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
Link to this property pin\_participant: boolean Link to this property
plugins: object {can\_close, can\_edit\_config, can\_start, config } Plugin permissions can\_close: boolean Can close plugins that are already open Link to this property can\_edit\_config: boolean Can edit plugin config Link to this property can\_start: boolean Can start plugins Link to this property
config: map\[object {access\_control, handles\_view\_only } ] Plugin configuration keyed by plugin UUID.
access\_control: optional "FULL\_ACCESS"or "VIEW\_ONLY" One of the following: "FULL\_ACCESS" Link to this property "VIEW\_ONLY" Link to this property
Link to this property handles\_view\_only: optional boolean Link to this property
Link to this property
Link to this property
polls: object {can\_create, can\_view, can\_vote } Poll permissions can\_create: boolean Can create polls Link to this property can\_view: boolean Can view polls Link to this property can\_vote: boolean Can vote on polls Link to this property
Link to this property
recorder\_type: "RECORDER"or "LIVESTREAMER"or "NONE" Type of the recording peer One of the following: "RECORDER" Link to this property "LIVESTREAMER" Link to this property "NONE" Link to this property
Link to this property show\_participant\_list: boolean Link to this property
waiting\_room\_type: "SKIP"or "ON\_PRIVILEGED\_USER\_ENTRY"or "SKIP\_ON\_ACCEPT" Waiting room type One of the following: "SKIP" Link to this property "ON\_PRIVILEGED\_USER\_ENTRY" Link to this property "SKIP\_ON\_ACCEPT" Link to this property
Link to this property accept\_stage\_requests: optional boolean Link to this property is\_recorder: optional boolean Link to this property
stage\_access: optional "ALLOWED"or "NOT\_ALLOWED"or "CAN\_REQUEST" One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property stage\_enabled: optional boolean Link to this property transcription\_enabled: optional boolean Link to this property
Link to this property
ui: object {design\_tokens }
design\_tokens: object {border\_radius, border\_width, colors, 5 more }
border\_radius: "sharp"or "rounded"or "extra-rounded"or "circular" One of the following: "sharp" Link to this property "rounded" Link to this property "extra-rounded" Link to this property "circular" Link to this property
Link to this property
border\_width: "none"or "thin"or "fat" One of the following: "none" Link to this property "thin" Link to this property "fat" Link to this property
Link to this property
colors: object {background, brand, danger, 5 more }
background: object {"1000", "600", "700", 2 more } "1000": string Link to this property "600": string Link to this property "700": string Link to this property "800": string Link to this property "900": string Link to this property
Link to this property
brand: object {"300", "400", "500", 2 more } "300": string Link to this property "400": string Link to this property "500": string Link to this property "600": string Link to this property "700": string Link to this property
Link to this property danger: string Link to this property success: string Link to this property text: string Link to this property text\_on\_brand: string Link to this property video\_bg: string Link to this property warning: string Link to this property
Link to this property spacing\_base: number minimum1 Link to this property
theme: "darkest"or "dark"or "light" One of the following: "darkest" Link to this property "dark" Link to this property "light" Link to this property
Link to this property font\_family: optional string Link to this property google\_font: optional string Link to this property logo: optional string formaturi Link to this property
Link to this property
Link to this property updated\_at: string Timestamp this preset was last updated formatdate-time Link to this property
Link to this property success: boolean Success status of the operation Link to this property
[Link to this property](<#(resource)%20realtime_kit.presets%20%3E%20(model)%20preset_delete_response%20%3E%20(schema)>)
PresetUpdateResponse object {data, success }
data: object {id, config, created\_at, 4 more } Data returned by the operation id: string ID of the preset formatuuid Link to this property
config: object {max\_screenshare\_count, max\_video\_streams, media, 2 more } max\_screenshare\_count: number Maximum number of screen shares that can be active at a given time Link to this property
max\_video\_streams: object {desktop, mobile } Maximum number of streams that are visible on a device desktop: number Maximum number of video streams visible on desktop devices Link to this property mobile: number Maximum number of streams visible on mobile devices Link to this property
Link to this property
media: object {screenshare, video, audio } Media configuration options. eg: Video quality
screenshare: object {frame\_rate, quality } Configuration options for participant screen shares frame\_rate: number Frame rate of screen share Link to this property
quality: "hd"or "vga"or "qvga"or 2 more Quality of screen share One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property
Link to this property
video: object {frame\_rate, quality, simulcast } Configuration options for participant videos frame\_rate: number Frame rate of participants’ video maximum30 Link to this property
quality: "hd"or "vga"or "qvga"or 2 more Video quality of participants One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property simulcast: optional boolean Enable simulcast for participant videos. Link to this property
Link to this property
audio: optional object {enable\_high\_bitrate, enable\_stereo } Control options for Audio quality. enable\_high\_bitrate: optional boolean Enable High Quality Audio for your meetings Link to this property enable\_stereo: optional boolean Enable Stereo for your meetings Link to this property
Link to this property
Link to this property
view\_type: "GROUP\_CALL"or "WEBINAR"or "AUDIO\_ROOM"or "LIVESTREAM" Type of the meeting One of the following: "GROUP\_CALL" Link to this property "WEBINAR" Link to this property "AUDIO\_ROOM" Link to this property "LIVESTREAM" Link to this property
Link to this property livestream\_viewer\_qualities: optional array of number Livestream viewer quality levels. Link to this property
Link to this property created\_at: string Timestamp this preset was created at formatdate-time Link to this property name: string Name of the preset Link to this property
permissions: object {accept\_waiting\_requests, can\_accept\_production\_requests, can\_change\_participant\_permissions, 23 more } accept\_waiting\_requests: boolean Whether this participant can accept waiting requests Link to this property can\_accept\_production\_requests: boolean Link to this property can\_change\_participant\_permissions: boolean Link to this property can\_edit\_display\_name: boolean Link to this property can\_livestream: boolean Link to this property can\_record: boolean Link to this property can\_spotlight: boolean Link to this property
chat: object {private, public }
private: object {can\_receive, can\_send, files, text } can\_receive: boolean Link to this property can\_send: boolean Link to this property files: boolean Link to this property text: boolean Link to this property
Link to this property
public: object {can\_send, files, text } can\_send: boolean Can send messages in general Link to this property files: boolean Can send file messages Link to this property text: boolean Can send text messages Link to this property
Link to this property
Link to this property
connected\_meetings: object {can\_alter\_connected\_meetings, can\_switch\_connected\_meetings, can\_switch\_to\_parent\_meeting } can\_alter\_connected\_meetings: boolean Link to this property can\_switch\_connected\_meetings: boolean Link to this property can\_switch\_to\_parent\_meeting: boolean Link to this property
Link to this property disable\_participant\_audio: boolean Link to this property disable\_participant\_screensharing: boolean Link to this property disable\_participant\_video: boolean Link to this property hidden\_participant: boolean Whether this participant is visible to others or not Link to this property kick\_participant: boolean Link to this property
media: object {audio, screenshare, video } Media permissions
audio: object {can\_produce } Audio permissions
can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "CAN\_REQUEST" Can produce audio One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
screenshare: object {can\_produce } Screenshare permissions
can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "CAN\_REQUEST" Can produce screen share video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
video: object {can\_produce } Video permissions
can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "CAN\_REQUEST" Can produce video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
Link to this property pin\_participant: boolean Link to this property
plugins: object {can\_close, can\_edit\_config, can\_start, config } Plugin permissions can\_close: boolean Can close plugins that are already open Link to this property can\_edit\_config: boolean Can edit plugin config Link to this property can\_start: boolean Can start plugins Link to this property
config: map\[object {access\_control, handles\_view\_only } ] Plugin configuration keyed by plugin UUID.
access\_control: optional "FULL\_ACCESS"or "VIEW\_ONLY" One of the following: "FULL\_ACCESS" Link to this property "VIEW\_ONLY" Link to this property
Link to this property handles\_view\_only: optional boolean Link to this property
Link to this property
Link to this property
polls: object {can\_create, can\_view, can\_vote } Poll permissions can\_create: boolean Can create polls Link to this property can\_view: boolean Can view polls Link to this property can\_vote: boolean Can vote on polls Link to this property
Link to this property
recorder\_type: "RECORDER"or "LIVESTREAMER"or "NONE" Type of the recording peer One of the following: "RECORDER" Link to this property "LIVESTREAMER" Link to this property "NONE" Link to this property
Link to this property show\_participant\_list: boolean Link to this property
waiting\_room\_type: "SKIP"or "ON\_PRIVILEGED\_USER\_ENTRY"or "SKIP\_ON\_ACCEPT" Waiting room type One of the following: "SKIP" Link to this property "ON\_PRIVILEGED\_USER\_ENTRY" Link to this property "SKIP\_ON\_ACCEPT" Link to this property
Link to this property accept\_stage\_requests: optional boolean Link to this property is\_recorder: optional boolean Link to this property
stage\_access: optional "ALLOWED"or "NOT\_ALLOWED"or "CAN\_REQUEST" One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property stage\_enabled: optional boolean Link to this property transcription\_enabled: optional boolean Link to this property
Link to this property
ui: object {design\_tokens }
design\_tokens: object {border\_radius, border\_width, colors, 5 more }
border\_radius: "sharp"or "rounded"or "extra-rounded"or "circular" One of the following: "sharp" Link to this property "rounded" Link to this property "extra-rounded" Link to this property "circular" Link to this property
Link to this property
border\_width: "none"or "thin"or "fat" One of the following: "none" Link to this property "thin" Link to this property "fat" Link to this property
Link to this property
colors: object {background, brand, danger, 5 more }
background: object {"1000", "600", "700", 2 more } "1000": string Link to this property "600": string Link to this property "700": string Link to this property "800": string Link to this property "900": string Link to this property
Link to this property
brand: object {"300", "400", "500", 2 more } "300": string Link to this property "400": string Link to this property "500": string Link to this property "600": string Link to this property "700": string Link to this property
Link to this property danger: string Link to this property success: string Link to this property text: string Link to this property text\_on\_brand: string Link to this property video\_bg: string Link to this property warning: string Link to this property
Link to this property spacing\_base: number minimum1 Link to this property
theme: "darkest"or "dark"or "light" One of the following: "darkest" Link to this property "dark" Link to this property "light" Link to this property
Link to this property font\_family: optional string Link to this property google\_font: optional string Link to this property logo: optional string formaturi Link to this property
Link to this property
Link to this property updated\_at: string Timestamp this preset was last updated formatdate-time Link to this property
Link to this property success: boolean Success status of the operation Link to this property
[Link to this property](<#(resource)%20realtime_kit.presets%20%3E%20(model)%20preset_update_response%20%3E%20(schema)>)
PresetReplacePresetByIDResponse object {data, success }
data: object {id, config, created\_at, 4 more } Data returned by the operation id: string ID of the preset formatuuid Link to this property
config: object {max\_screenshare\_count, max\_video\_streams, media, 2 more } max\_screenshare\_count: number Maximum number of screen shares that can be active at a given time Link to this property
max\_video\_streams: object {desktop, mobile } Maximum number of streams that are visible on a device desktop: number Maximum number of video streams visible on desktop devices Link to this property mobile: number Maximum number of streams visible on mobile devices Link to this property
Link to this property
media: object {screenshare, video, audio } Media configuration options. eg: Video quality
screenshare: object {frame\_rate, quality } Configuration options for participant screen shares frame\_rate: number Frame rate of screen share Link to this property
quality: "hd"or "vga"or "qvga"or 2 more Quality of screen share One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property
Link to this property
video: object {frame\_rate, quality, simulcast } Configuration options for participant videos frame\_rate: number Frame rate of participants’ video maximum30 Link to this property
quality: "hd"or "vga"or "qvga"or 2 more Video quality of participants One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property simulcast: optional boolean Enable simulcast for participant videos. Link to this property
Link to this property
audio: optional object {enable\_high\_bitrate, enable\_stereo } Control options for Audio quality. enable\_high\_bitrate: optional boolean Enable High Quality Audio for your meetings Link to this property enable\_stereo: optional boolean Enable Stereo for your meetings Link to this property
Link to this property
Link to this property
view\_type: "GROUP\_CALL"or "WEBINAR"or "AUDIO\_ROOM"or "LIVESTREAM" Type of the meeting One of the following: "GROUP\_CALL" Link to this property "WEBINAR" Link to this property "AUDIO\_ROOM" Link to this property "LIVESTREAM" Link to this property
Link to this property livestream\_viewer\_qualities: optional array of number Livestream viewer quality levels. Link to this property
Link to this property created\_at: string Timestamp this preset was created at formatdate-time Link to this property name: string Name of the preset Link to this property
permissions: object {accept\_waiting\_requests, can\_accept\_production\_requests, can\_change\_participant\_permissions, 23 more } accept\_waiting\_requests: boolean Whether this participant can accept waiting requests Link to this property can\_accept\_production\_requests: boolean Link to this property can\_change\_participant\_permissions: boolean Link to this property can\_edit\_display\_name: boolean Link to this property can\_livestream: boolean Link to this property can\_record: boolean Link to this property can\_spotlight: boolean Link to this property
chat: object {private, public }
private: object {can\_receive, can\_send, files, text } can\_receive: boolean Link to this property can\_send: boolean Link to this property files: boolean Link to this property text: boolean Link to this property
Link to this property
public: object {can\_send, files, text } can\_send: boolean Can send messages in general Link to this property files: boolean Can send file messages Link to this property text: boolean Can send text messages Link to this property
Link to this property
Link to this property
connected\_meetings: object {can\_alter\_connected\_meetings, can\_switch\_connected\_meetings, can\_switch\_to\_parent\_meeting } can\_alter\_connected\_meetings: boolean Link to this property can\_switch\_connected\_meetings: boolean Link to this property can\_switch\_to\_parent\_meeting: boolean Link to this property
Link to this property disable\_participant\_audio: boolean Link to this property disable\_participant\_screensharing: boolean Link to this property disable\_participant\_video: boolean Link to this property hidden\_participant: boolean Whether this participant is visible to others or not Link to this property kick\_participant: boolean Link to this property
media: object {audio, screenshare, video } Media permissions
audio: object {can\_produce } Audio permissions
can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "CAN\_REQUEST" Can produce audio One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
screenshare: object {can\_produce } Screenshare permissions
can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "CAN\_REQUEST" Can produce screen share video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
video: object {can\_produce } Video permissions
can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "CAN\_REQUEST" Can produce video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
Link to this property pin\_participant: boolean Link to this property
plugins: object {can\_close, can\_edit\_config, can\_start, config } Plugin permissions can\_close: boolean Can close plugins that are already open Link to this property can\_edit\_config: boolean Can edit plugin config Link to this property can\_start: boolean Can start plugins Link to this property
config: map\[object {access\_control, handles\_view\_only } ] Plugin configuration keyed by plugin UUID.
access\_control: optional "FULL\_ACCESS"or "VIEW\_ONLY" One of the following: "FULL\_ACCESS" Link to this property "VIEW\_ONLY" Link to this property
Link to this property handles\_view\_only: optional boolean Link to this property
Link to this property
Link to this property
polls: object {can\_create, can\_view, can\_vote } Poll permissions can\_create: boolean Can create polls Link to this property can\_view: boolean Can view polls Link to this property can\_vote: boolean Can vote on polls Link to this property
Link to this property
recorder\_type: "RECORDER"or "LIVESTREAMER"or "NONE" Type of the recording peer One of the following: "RECORDER" Link to this property "LIVESTREAMER" Link to this property "NONE" Link to this property
Link to this property show\_participant\_list: boolean Link to this property
waiting\_room\_type: "SKIP"or "ON\_PRIVILEGED\_USER\_ENTRY"or "SKIP\_ON\_ACCEPT" Waiting room type One of the following: "SKIP" Link to this property "ON\_PRIVILEGED\_USER\_ENTRY" Link to this property "SKIP\_ON\_ACCEPT" Link to this property
Link to this property accept\_stage\_requests: optional boolean Link to this property is\_recorder: optional boolean Link to this property
stage\_access: optional "ALLOWED"or "NOT\_ALLOWED"or "CAN\_REQUEST" One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property stage\_enabled: optional boolean Link to this property transcription\_enabled: optional boolean Link to this property
Link to this property
ui: object {design\_tokens }
design\_tokens: object {border\_radius, border\_width, colors, 5 more }
border\_radius: "sharp"or "rounded"or "extra-rounded"or "circular" One of the following: "sharp" Link to this property "rounded" Link to this property "extra-rounded" Link to this property "circular" Link to this property
Link to this property
border\_width: "none"or "thin"or "fat" One of the following: "none" Link to this property "thin" Link to this property "fat" Link to this property
Link to this property
colors: object {background, brand, danger, 5 more }
background: object {"1000", "600", "700", 2 more } "1000": string Link to this property "600": string Link to this property "700": string Link to this property "800": string Link to this property "900": string Link to this property
Link to this property
brand: object {"300", "400", "500", 2 more } "300": string Link to this property "400": string Link to this property "500": string Link to this property "600": string Link to this property "700": string Link to this property
Link to this property danger: string Link to this property success: string Link to this property text: string Link to this property text\_on\_brand: string Link to this property video\_bg: string Link to this property warning: string Link to this property
Link to this property spacing\_base: number minimum1 Link to this property
theme: "darkest"or "dark"or "light" One of the following: "darkest" Link to this property "dark" Link to this property "light" Link to this property
Link to this property font\_family: optional string Link to this property google\_font: optional string Link to this property logo: optional string formaturi Link to this property
Link to this property
Link to this property updated\_at: string Timestamp this preset was last updated formatdate-time Link to this property
Link to this property success: boolean Success status of the operation Link to this property
[Link to this property](<#(resource)%20realtime_kit.presets%20%3E%20(model)%20preset_replace_preset_by_id_response%20%3E%20(schema)>)