Setting the file. One moment.
Skill 132 · Build Zoom REST API App
Subchapter 132.39
references/whiteboard.mdMarkdown5 KBView on GitHub
Authoritative endpoint inventory for Whiteboard. This file mirrors the official Zoom API Hub OpenAPI document for this product area.
https://api.zoom.us/v2paths object.../examples/ for orchestration patterns, not as the canonical source of path names.| Metric | Value |
|---|---|
| Endpoint operations | 32 |
| Path templates | 21 |
| Tags | 8 |
| Tag | Operations |
|---|---|
| Archiving | 3 |
| Collaborator | 4 |
| Document | 5 |
| Export | 3 |
| File | 2 |
| Import | 2 |
| Project | 12 |
| Settings | 1 |
| Method | Endpoint | Summary | Operation ID |
|---|---|---|---|
| GET | /whiteboards/sessions | List whiteboards sessions | Createwhiteboardsarchivefiles |
| GET | /whiteboards/sessions/activity/download/{path} | Download Whiteboards activity file | Downloadwhiteboardsactivityfile |
| GET | /whiteboards/sessions/{seesionId} | List whiteboard sessions activities | Listwhiteboardsessionsarchivedfiles |
| Method | Endpoint | Summary | Operation ID |
|---|---|---|---|
| GET | /whiteboards/{whiteboardId}/collaborator | Get collaborators of a whiteboard | GetAWhiteboardCollaborator |
| PATCH | /whiteboards/{whiteboardId}/collaborator | Update whiteboard collaborators | UpdateAWhiteboardCollaborator |
| POST | /whiteboards/{whiteboardId}/collaborator | Share a whiteboard to new users or team chat channels. | AddAWhiteboardCollaborator |
| DELETE | /whiteboards/{whiteboardId}/collaborator/{collaboratorId} | Remove the collaborator from a whiteboard | DeleteAWhiteboardCollaborator |
| Method | Endpoint | Summary | Operation ID |
|---|---|---|---|
| GET | /whiteboards | List all whiteboards | ListWhiteboards |
| POST | /whiteboards | Create a new whiteboard | newWhiteboardCreate |
| DELETE | /whiteboards/{whiteboardId} | Delete a whiteboard | DeleteAWhiteboard |
| GET | /whiteboards/{whiteboardId} | Get a whiteboard | GetAWhiteboard |
| PUT | /whiteboards/{whiteboardId} | Update whiteboard basic information | UpdateAWhiteboardMetadata |
| Method | Endpoint | Summary | Operation ID |
|---|---|---|---|
| POST | /whiteboards/export | Create whiteboard export | Createwhiteboardsexport |
| GET | /whiteboards/export/task/{taskId} | Download whiteboard export | Downloadwhiteboardexport |
| GET | /whiteboards/export/task/{taskId}/status | Get whiteboard export generation status | Getwhiteboardexportdatagenerationstatus |
| Method | Endpoint | Summary | Operation ID |
|---|---|---|---|
| POST | /whiteboards/files | Upload file for whiteboard import | Uploadfileforwhiteboardimport |
| GET | /whiteboards/{whiteboardId}/files/{fileId} | Download Imported Whiteboard File | Downloadembeddedwhiteboardfile |
| Method | Endpoint | Summary | Operation ID |
|---|---|---|---|
| POST | /whiteboards/import | Create a new whiteboard by import | CreateWhiteboardImport |
| GET | /whiteboards/import/{taskId}/status | Get whiteboard import status | GetWhiteboardimportstatus |
| Method | Endpoint | Summary | Operation ID |
|---|---|---|---|
| GET | /whiteboards/projects | List all projects | Listallprojects |
| POST | /whiteboards/projects | Create a new project | Createproject |
| DELETE | /whiteboards/projects/{projectId} | Delete a project | Deleteproject |
| GET | /whiteboards/projects/{projectId} | Get a project | Getaproject |
| PATCH | /whiteboards/projects/{projectId} | Update project basic information | Updateproject |
| GET | /whiteboards/projects/{projectId}/collaborators | Get collaborators of a project | Getcollaboratorsofaproject |
| PATCH | /whiteboards/projects/{projectId}/collaborators | Update project collaborators | Updateprojectcollaborators |
| POST | /whiteboards/projects/{projectId}/collaborators | Share a project to new users | Shareaprojecttonewusers |
| DELETE | /whiteboards/projects/{projectId}/collaborators/{collaboratorId} | Remove the collaborator from a project | Removethecollaboratorfromaproject |
| GET | /whiteboards/projects/{projectId}/subprojects | List subprojects | listSubProjects |
| DELETE | /whiteboards/projects/{projectId}/whiteboards | Remove whiteboards from a project | Removewhiteboardsfromaproject |
| POST | /whiteboards/projects/{projectId}/whiteboards | Move whiteboards to a project | Movewhiteboardstoproject |
| Method | Endpoint | Summary | Operation ID |
|---|---|---|---|
| PATCH | /whiteboards/{whiteboardId}/share_setting | Update whiteboard share setting | UpdateAWhiteboardShareSetting |