Logo
Zoom Public API Documentation

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

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
Content-Type
string
Accept
string




RESPONSES

status Created

{ "id": "<string>", "name": "<string>", "is_default": "<boolean>", "size": "<integer>", "type": "image" }



Curl
curl -X POST 'https://api.zoom.us/v2/webinars/:webinarId/branding/virtual_backgrounds' -H 'Content-Type: multipart/form-data' -H 'Accept: application/json' -F '{"name"=>"file", "value"=>"<string>", "datatype"=>"string"}=' -F '{"name"=>"default", "value"=>"false", "datatype"=>"boolean"}=' -F '{"name"=>"set_default_for_all_panelists", "value"=>"true", "datatype"=>"boolean"}='

ENDPOINTS