Logo
Zoom Public API Documentation

Share a whiteboard to new users or team chat channels.

POST {{baseUrl}}/whiteboards/:whiteboardId/collaborator

Use this API to add collaborators to a whiteboard.

Scopes: whiteboard_collaborator: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

[ { "collaborator_id": "<string>", "collaborator_name": "<string>", "user_id": "<string>", "channel_id": "<string>", "avatar": "<string>", "role": 1, "collaborator_type": 1 }, { "collaborator_id": "<string>", "collaborator_name": "<string>", "user_id": "<string>", "channel_id": "<string>", "avatar": "<string>", "role": 3, "collaborator_type": 1 } ]



Curl
curl -X POST 'https://api.zoom.us/v2/whiteboards/:whiteboardId/collaborator' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"collaborators":[{"email":"\u003cstring\u003e","channel_id":"\u003cstring\u003e","role":0},{"email":"\u003cstring\u003e","channel_id":"\u003cstring\u003e","role":2}]}'

ENDPOINTS