name: zoom-whiteboard
description: |
Zoom Whiteboard API integration guide. Covers creating, managing, and sharing collaborative
whiteboards programmatically. Use when building visual collaboration tools, project planning
integrations, or automating whiteboard workflows within Zoom Workplace.

Zoom Whiteboard API

Build visual collaboration integrations with Zoom Whiteboard's infinite canvas and real-time collaboration features.

Overview

Zoom Whiteboard provides:
- Infinite canvas for visual collaboration
- Real-time multi-user editing
- Templates and shapes library
- Folder organization
- Export to PDF, PNG, SVG
- Sharing and permission controls

Key Features

Choose Your Integration

Core Endpoints

Common Operations

Create a Whiteboard

const response = await fetch('https://api.zoom.us/v2/whiteboards', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${accessToken}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Sprint Planning Board',
    folder_id: 'folder_abc'
  })
});

const whiteboard = await response.json();
// whiteboard.id, whiteboard.share_url

Add Collaborators

await fetch(`https://api.zoom.us/v2/whiteboards/${whiteboardId}/collaborators`, {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${accessToken}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    collaborators: [
      { email: '[email protected]', permission: 'editor' },
      { email: '[email protected]', permission: 'viewer' }
    ]
  })
});

Export Whiteboard

// Start export
const exportResponse = await fetch(
  `https://api.zoom.us/v2/whiteboards/${whiteboardId}/export`,
  {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${accessToken}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      format: 'pdf',
      quality: 'high'
    })
  }
);

const { export_id } = await exportResponse.json();

// Check export status
const statusResponse = await fetch(
  `https://api.zoom.us/v2/whiteboards/${whiteboardId}/export/${export_id}`,
  { headers: { 'Authorization': `Bearer ${accessToken}` } }
);

Permission Levels

Export Formats

Sharing Options

Prerequisites

1. Zoom account with Whiteboard access
2. OAuth app - Create in Zoom App Marketplace
3. Scopes - Required permissions:
4. whiteboard:read - Read whiteboard data
5. whiteboard:write - Create/modify whiteboards
6. whiteboard:read:admin - Admin read access
7. whiteboard:write:admin - Admin write access

Common Use Cases

Webhooks

Zoom Whiteboard sends real-time events:

See zoom-webhooks skill for webhook setup.

Resources

• Official docs: https://developers.zoom.us/docs/zoom-whiteboard/
• API Reference: https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#tag/Whiteboards
• Marketplace: https://marketplace.zoom.us/