Zoom Whiteboard API
Number of APIs: 10
1. whiteboards-{whiteboardId}-collaborator-{collaboratorId} - Remove the collaborator from a whiteboard
DELETE {{baseUrl}}/whiteboards/:whiteboardId/collaborator/:collaboratorId
Removes a collaborator from a whiteboard.
Scopes: whiteboard_collaborator:write:admin
Rate Limit Label: MEDIUM
2. whiteboards-{whiteboardId}-collaborator - Get collaborators of a whiteboard
GET {{baseUrl}}/whiteboards/:whiteboardId/collaborator
Returns a list of a whiteboard collaborators.
Scopes: whiteboard_collaborator:read:admin
Rate Limit Label: MEDIUM
3. whiteboards-{whiteboardId}-collaborator - 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
4. whiteboards-{whiteboardId}-collaborator - Update whiteboard collaborators
PATCH {{baseUrl}}/whiteboards/:whiteboardId/collaborator
Use this API to update whiteboard collaborators.
Scopes: whiteboard:write:admin
Rate Limit Label: MEDIUM
5. whiteboards-{whiteboardId}-share_setting - Update whiteboard share setting
PATCH {{baseUrl}}/whiteboards/:whiteboardId/share_setting
Updates the whiteboard share setting.
Scopes: whiteboard_share_setting:write:admin,whiteboard_share_setting:write
Rate Limit Label: MEDIUM
6. whiteboards-{whiteboardId} - Get a whiteboard
GET {{baseUrl}}/whiteboards/:whiteboardId
Use this API to return a whiteboard information.
Scopes: whiteboard:read:admin,whiteboard:read
Rate Limit Label: MEDIUM
7. whiteboards-{whiteboardId} - Update whiteboard basic information
PUT {{baseUrl}}/whiteboards/:whiteboardId
Use this API to rename a whiteboard, update whiteboard status(locked or unlocked).
Scopes: whiteboard:write:admin
Rate Limit Label: MEDIUM
8. whiteboards-{whiteboardId} - Delete a whiteboard
DELETE {{baseUrl}}/whiteboards/:whiteboardId
Use this API to delete a whiteboard.
Scopes: whiteboard:write:admin,whiteboard:write
Rate Limit Label: MEDIUM
9. whiteboards - List all whiteboards
GET {{baseUrl}}/whiteboards?search_key=<string>&user_id=<string>&date_filter_type=modified_date&from=<dateTime>&to=<dateTime>&page_size=10&next_page_token=<string>
Use this API to list whiteboards of current user (Required Scopes: whiteboard:read) or list all whiteboards under the account (Required Scopes: whiteboard:read:admin).
Note: user_id can intake Zoom user ID or email which only applies when scope = whiteboard:read:admin. Otherwise, the user_id can only intake me.
Scopes: whiteboard:read:admin,whiteboard:read
Rate Limit Label: MEDIUM
10. whiteboards - Create a new whiteboard
POST {{baseUrl}}/whiteboards
Use this API to create a new whiteboard for a user.
Scopes: whiteboard:write
Rate Limit Label: LIGHT
ENDPOINTS