Logo
Zoom Public API Documentation

Upload Virtual Background files

POST {{baseUrl}}/users/:userId/settings/virtual_backgrounds

Use this API to upload a Virtual Background files to a user's profile. For user-level apps, pass the me value instead of the userId parameter.

Note: * A user profile cannot exceed more than 10 Virtual Background files. * You can only upload image files that are in JPG/JPEG, GIF or PNG format. * Video files must be in MP4 or MOV file format with a minimum resolution of 480 by 360 pixels (360p) and a maximum resolution of 1920 by 1080 pixels (1080p). * The Virtual Background file size cannot exceed 15 megabytes (MB).

Prerequisites: * The Virtual Background feature must be enabled on the account.

Scopes: user:write:admin,user:write

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>", "is_default": "<boolean>", "name": "<string>", "size": "<integer>", "type": "video" }



Curl
curl -X POST 'https://api.zoom.us/v2/users/:userId/settings/virtual_backgrounds' -H 'Content-Type: multipart/form-data' -H 'Accept: application/json' -F '{"name"=>"file", "value"=>"<string>", "datatype"=>"string"}='

ENDPOINTS