Logo
Zoom Public API Documentation

webinars-{webinarId}-branding-virtual_backgrounds

Number of APIs: 3


1. Delete a webinar's branding Virtual Backgrounds

DELETE {{baseUrl}}/webinars/:webinarId/branding/virtual_backgrounds?ids=<string>

Use this API to delete a webinar's session branding Virtual Background.

Prerequisites: * The Webinar Session Branding setting enabled.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: Light



2. Set webinar's default branding Virtual Background

PATCH {{baseUrl}}/webinars/:webinarId/branding/virtual_backgrounds?id=<string>&set_default_for_all_panelists=<boolean>

Use this API to set a webinar's default session branding Virtual Background.

Prerequisites: * The Webinar Session Branding setting enabled.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: Light



3. Upload a webinar's branding Virtual Background

POST {{baseUrl}}/webinars/:webinarId/branding/virtual_backgrounds

Use this API to upload a webinar's session branding Virtual Background. Hosts and panelists can select and use these Virtual Backgrounds during the webinar. Branding Virtual Background files have the following restrictions: * A webinar cannot exceed more than 10 Virtual Background files. * You can only upload image files that are in JPG/JPEG, GIF or PNG format. * The Virtual Background file size cannot exceed 15 megabytes (MB).

Prerequisites: * The Webinar Session Branding setting enabled.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: Medium



ENDPOINTS