Zoom Public API Documentation
Get webinar's session branding
GET {{baseUrl}}/webinars/:webinarId/branding
Use this API to get the webinar's Session Branding information. Session branding lets hosts visually customize a webinar by setting a webinar wallpaper that displays behind video tiles. Session branding also lets hosts set the Virtual Background for and apply name tags to hosts, alternative hosts, panelists, interpreters, and speakers. Prerequisites:
* A Pro or higher plan with the Webinar add-on.
* The Webinar Session Branding setting enabled. Scopes: Rate Limit Label: webinar:read,webinar:read:adminLight
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"wallpaper": {
"id": "<string>"
},
"virtual_backgrounds": [
{
"id": "<string>",
"name": "<string>",
"is_default": "<boolean>"
},
{
"id": "<string>",
"name": "<string>",
"is_default": "<boolean>"
}
],
"name_tags": [
{
"id": "<string>",
"name": "<string>",
"text_color": "<string>",
"accent_color": "<string>",
"background_color": "<string>",
"is_default": "<boolean>"
},
{
"id": "<string>",
"name": "<string>",
"text_color": "<string>",
"accent_color": "<string>",
"background_color": "<string>",
"is_default": "<boolean>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/webinars/:webinarId/branding' -H 'Accept: application/json'
ENDPOINTS