Zoom

Tool to search company contacts in Zoom by first name, last name, or email. Use when you need to find specific contacts within the organization. Supports pagination for large result sets and optionally includes presence status.

Registers a participant for a Zoom meeting that has registration enabled. Prerequisites: - The meeting host must have a licensed (paid) Zoom account - this will NOT work with free/basic accounts - The meeting must have registration enabled (approval_type = 0 for automatic or 1 for manual approval) - Maximum of 4,999 registrants per meeting Required fields: meeting_id, first_name, last_name, email Optional fields: address, city, state, zip, country, phone, comments, industry, job_title, org, language, auto_approve Common errors: - "Only available for paid users" - The meeting host needs a licensed Zoom account - "Registration has not been enabled" - Enable registration via update_a_meeting with approval_type = 0 or 1 - "Meeting not found" - Invalid meeting ID or meeting has ended

Registers a participant for a Zoom webinar that has registration enabled. Prerequisites: - The webinar host must have a Pro or higher plan with Webinar add-on - this will NOT work with basic/free accounts - The webinar must have registration enabled (approval_type = 0 for automatic or 1 for manual approval) - Registration type must be properly configured (1=once for all, 2=each occurrence, 3=choose occurrences) Required fields: webinarId, first_name, email Optional fields: last_name, address, city, state, zip, country, phone, comments, industry, job_title, org, language, occurrence_ids, source_id Common errors: - "Webinar plan is missing" - The host needs a Zoom webinar license/add-on - "Registration has not been enabled" - Enable registration via webinar settings with approval_type = 0 or 1 - "Webinar not found" (404) - Invalid webinar ID or webinar has ended - "Host cannot register" - The webinar host cannot register themselves as an attendee

Adds one or more collaborators to a whiteboard project. Use this action when you want to invite team members or external users to collaborate on a specific whiteboard project. Project owners or authorized users can add collaborators with different permission levels (owner, editor, or viewer). Prerequisites: - The user must be the project owner or have admin permissions - The target user must have a Zoom account - The whiteboard project must exist and be accessible Required fields: project_id, collaborators (list with at least one user) Optional fields: skip_notifications, invite_message Common errors: - "Whiteboard plan is missing" - Whiteboard add-on is required - "User not found" - The collaborator's email is not associated with a Zoom account - "Project not found" - Invalid project ID - "Invalid collaborator role" - Role value must be 1, 2, or 3

Adds one or more collaborators to a whiteboard. Use this action when you need to invite users or team chat channels to collaborate on a specific whiteboard. Supports individual user invites (via email) and team chat channel invites (via channel_id). Collaborators are assigned a role that determines their permission level. On success, returns the list of collaborators that were added. Use this action when you want to share a whiteboard to new users or team chat channels and assign them specific permission levels (owner, co-owner, editor, commenter, or viewer).

Applies or updates a classification label on a whiteboard. Use this action when you need to assign or change a security classification label on an existing whiteboard. Each whiteboard can only have one classification label at a time — if the whiteboard already has a label, it will be replaced with the new one. Rate limit: Light. Required scopes: whiteboard:write:admin, whiteboard:write, whiteboard:update:whiteboard_classification, or whiteboard:update:whiteboard_classification:admin.

Tool to bulk import CRM leads into Zoom Revenue Accelerator (ZRA). Use when you need to import or update multiple leads asynchronously. Supports up to 2000 leads per request and returns a task_id to track import progress.

Creates a new whiteboard for the authenticated user. Use when you need to create a blank whiteboard that can be shared and collaborated on with others. The whiteboard will be associated with the user making the API call. Required scope: whiteboard:write or whiteboard:write:whiteboard Notes: - If no name is provided, the whiteboard will be named "Untitled" - After creation, the whiteboard can be shared with collaborators using share settings

Creates an export task to generate PDF exports and audit logs for specified whiteboards. The exported content is bundled into a ZIP file containing the whiteboard PDFs and audit logs. Use when you need to export one or more whiteboards for archival, sharing, or compliance purposes. Use this action when you want to export whiteboard content as a downloadable ZIP file containing PDF exports and audit logs. After creating the export task, poll the GetWhiteboardExportStatus action using the returned task_id until the status changes to 'successed', then download the export using the DownloadWhiteboardExport action. Note: This action only initiates the export process. The export is processed asynchronously. You must poll GetWhiteboardExportStatus to check when the export is ready, then use DownloadWhiteboardExport to retrieve the actual ZIP file.

Creates a new whiteboard project in Zoom. Use when you need to organize and group whiteboards together, optionally adding collaborators and initializing the project with existing whiteboards.

Tool to create a new conversation in Zoom Revenue Accelerator (ZRA). Use when uploading meeting recordings or phone calls for AI-powered analytics, including transcription, sentiment analysis, and engagement scoring.

Tool to create a comment on a Zoom Revenue Accelerator conversation. Use when you need to add comments, replies, or annotations to ZRA conversation recordings or transcripts.

Tool to create or update CRM accounts in Zoom Revenue Accelerator (ZRA). Use when you need to sync CRM account data to Zoom IQ. Supports up to 2000 accounts per request and returns an async task ID for polling status.

Tool to bulk import or delete CRM contacts in Zoom Revenue Accelerator. Use when syncing contacts from external CRM systems. Accepts up to 2,000 contacts per request and returns a task ID for async status tracking.

Tool to bulk import or delete CRM deals in Zoom Revenue Accelerator (ZRA). Use when you need to synchronize deals from an external CRM to Zoom's ZRA system. Supports up to 2000 deals per request and processes asynchronously.

Tool to register a new CRM API integration for Zoom Revenue Accelerator (ZRA). Use when you need to configure CRM settings including type, name, currency, deal stages, and URL patterns for accessing CRM records.

Tool to create a new conversation in Zoom Revenue Accelerator for a specific user. Use when you need to initiate a ZRA conversation entry with topic and start time.

Deletes all cloud recordings for a meeting or webinar. Requires the account to have Cloud Recording enabled. Rate limit: Light. Required scopes: cloud_recording:delete:meeting_recording or cloud_recording:delete:meeting_recording:admin.

Deletes a whiteboard by its unique identifier. Use when you need to permanently remove a specific whiteboard from Zoom. This action is irreversible — once deleted, the whiteboard cannot be recovered. Requires the user to have whiteboard delete permissions.

Removes a collaborator from a whiteboard. Use this action when you need to revoke a user's access to a specific whiteboard by removing them as a collaborator. This action is irreversible for the collaborator's access — the collaborator will no longer be able to view or edit the whiteboard unless added back. Requires the user to have whiteboard admin or owner permissions. Prerequisites: - The authenticated user must be the whiteboard owner, co-owner, or have admin permissions - The collaborator must currently have access to the whiteboard Common errors: - "Whiteboard not found" - Invalid whiteboard ID - "Collaborator not found" - The specified collaborator does not have access to the whiteboard - "Insufficient permissions" - User lacks permission to remove collaborators

Deletes a whiteboard project by its ID. Deleting a project removes all associated whiteboards from the project. Use when you need to permanently remove a whiteboard project and all its contents from Zoom. This action is irreversible — once the project is deleted, it cannot be recovered, and all associated whiteboards will be removed.

Deletes a ZRA (Zoom Revenue Accelerator) conversation by ID. Use when you need to remove a conversation from the Revenue Accelerator system. This is an undocumented endpoint that returns HTTP 200 on success.

Tool to delete a comment from a Zoom Revenue Accelerator conversation. Use when you need to remove a specific comment from a ZRA conversation.

Deletes CRM settings for Zoom Revenue Accelerator (ZRA). Use when you need to remove CRM configuration from the account.

Tool to delete activities from a Zoom Revenue Accelerator (ZRA) deal. Use when you need to remove one or more activities associated with a specific deal by providing the deal ID and comma-separated activity IDs.

Downloads a specific file that was imported into a whiteboard, including images, PDFs, DOCX, and other supported file formats. Use this action when you need to retrieve the actual file content of an imported whiteboard attachment. This action streams the file content directly from Zoom's servers.

Downloads the exported whiteboard content for a completed whiteboard export task. The task must have completed successfully before calling this action. Use when you need to retrieve the actual whiteboard content (drawings, annotations, images) that was exported using the Create whiteboard export API. Returns a ZIP archive containing the whiteboard files. This action is read-only and does not modify any whiteboard data. Use this action when you have created a whiteboard export task and want to download the resulting ZIP file containing the exported content.

Downloads the activity archive file for a whiteboard archiving session. This action retrieves the PDF file containing whiteboard session activity data based on the provided file path. Use when you need to retrieve the archived activity file for a completed whiteboard session. Use this action when you have obtained a file path from the List whiteboard sessions activities endpoint and want to download the actual activity archive file. The file is returned as a PDF stream. This action is read-only and does not modify any data. Note: Files may expire and return 404 if the download URL has expired.

Access Zoom Webinar details requires Pro or higher plan and Webinar add-on. Scopes include `webinar:read:admin` and `webinar:read`. Granular scopes and a 'LIGHT' rate limit also apply.

Retrieves details about a specific whiteboard document. Returns comprehensive whiteboard information including name, creation/modification dates, share settings, and classification. Use this action when you need to fetch metadata for a specific whiteboard by its ID. Requires whiteboard:read or whiteboard:read:admin scope.

Retrieves detailed information about a specific whiteboard session by its session ID. Returns session metadata including start/end times, whiteboard info, and a list of activities performed during the session. Use this action when you need to retrieve session details, activity logs, or participant information for a Zoom Whiteboard session. For large result sets, use pagination with next_page_token.

The daily report provides Zoom service usage details, like new users, meetings, participants, and minutes per day for a month, requiring a Pro plan or higher. It has a 'Heavy' rate limit.

Tool to retrieve content analysis for a Zoom IQ conversation by its ID. Use when you need to get AI-generated insights and analysis from a Revenue Accelerator conversation. Returns structured analysis data including conversation insights and extracted content.

Tool to get details of a specific deal in Zoom Revenue Accelerator (formerly Zoom IQ). Returns deal information for the specified deal ID including name, amount, stage, owner, and dates.

Retrieves a paginated list of Zoom Marketplace apps installed for a specific user. Returns app details including app ID, name, type, and installation status. Use when you need to check which marketplace apps a user has access to.

Retrieves marketplace entitlements for a specific Zoom user by ID or 'me'. Returns list of entitlements associated with the user's account. Use when you need to check user marketplace subscriptions or permissions.

Retrieves the list of participants who attended a past (ended) Zoom meeting. Requires a paid Zoom account (Pro or higher). Meeting must have ended with at least one participant (excluding solo meetings). Use meeting ID for the latest instance, or instance UUID for a specific occurrence.

Tool to retrieve a user's settings including meeting scheduling, in-meeting features, email notifications, recording, telephony, and security preferences. Use when you need to check or display a user's Zoom configuration settings.

Retrieves the status of a whiteboard export task by its task ID. This action queries the current state of an export request initiated via the create whiteboard export action. Use this action when you need to check whether a whiteboard export has completed processing, is still being generated, or has failed. Poll this endpoint until status changes from 'processing' to either 'successed' or 'failed'. The export is processed asynchronously, so you should poll this endpoint periodically to check for completion before attempting to download the exported file.

Retrieves detailed information about a specific whiteboard project by its ID. Returns project metadata including name, description, owner, sharing settings, and timestamps. Use this action when you need to view details about a Zoom Whiteboard project or retrieve its configuration.

Tool to retrieve comments for a specific Zoom Revenue Accelerator (ZRA) conversation. Use when you need to access user comments, replies, and annotations associated with a conversation recording or transcript.

Retrieves interaction details for a specific Zoom Revenue Accelerator (ZRA) conversation. Returns interaction data including speakers, timestamps, content, and metadata for conversation analysis. Use when you need detailed interaction-level data from ZRA conversations.

Tool to retrieve scorecards for a specific conversation in Zoom Revenue Accelerator. Use when you need to get scorecard data and performance metrics for a particular conversation.

Tool to retrieve activities associated with a Zoom Revenue Accelerator (ZRA) deal. Use when you need to list all activities for a specific deal in ZRA.

Initiates an import of a whiteboard from an external source (Miro, Mural, or Visio files). The import is processed asynchronously and returns a task_id for tracking progress. Use this task_id to poll for import completion and retrieve the resulting whiteboard. Use this action when you need to convert an externally created whiteboard into a Zoom whiteboard. The file must already be uploaded to Zoom before initiating the import.

Lists archived meeting and webinar files within a specified date range (max 7 days). Requires the 'Meeting and Webinar Archiving' feature to be enabled by Zoom Support. Use this to retrieve compliance recordings archived to third-party storage platforms.

Lists devices in your Zoom account managed through Zoom Device Management (ZDM). Returns information about Zoom Room devices including computers, controllers, scheduling displays, and whiteboards. Scopes: `device:read:admin`, `device:write:admin`, `device:read:list_zdm_devices:admin` Rate Limit Label: `HEAVY`

Tool to retrieve custom fields configured for a Zoom Marketplace app. Use when you need to list all custom fields available for the marketplace app.

Tool to retrieve all UUIDs for past instances of a given meeting. Use when you need to get the list of all occurrences (instances) of a recurring meeting that have already ended. Each instance has a unique UUID that can be used to query specific details about that occurrence.

Lists all collaborators for a whiteboard project, including their roles and permissions. Use this action when you need to view who has access to a whiteboard project and what permission level each collaborator has. This action is read-only and does not modify any data. Note: This action requires the whiteboard project to exist and the authenticated user to have appropriate permissions (project owner, co-owner, or admin).

Tool to list collaboration devices associated with a user. Use when you need to retrieve information about a user's collaboration devices. For user-level apps, pass 'me' instead of the userId parameter to get devices for the authenticated user.

Get a list of past webinar participants with a Pro plan or above plus an add-on. Requires specific scopes and has a medium rate limit.

The API lists all scheduled webinars for Zoom users with a webinar plan, using `me` for user-level apps. It only shows unexpired webinars for hosts broadcasting to up to 10,000 attendees. Requires Pro plan upwards and specific scopes. Rate limit: MEDIUM.

Lists all whiteboard projects accessible to the user. Returns project metadata including ID, name, owner, and timestamps. Use this action when you need to retrieve whiteboard projects with optional filtering by owner or name search. Supports pagination through the next_page_token parameter.

Lists all whiteboards accessible to the user. Returns whiteboard metadata including ID, name, owner, and timestamps. Use this action when you need to retrieve whiteboards with optional filtering by owner, date range, project, or name search. Supports pagination through the next_page_token parameter.

Tool to list all conversations in Zoom Revenue Accelerator. Use when you need to retrieve analytics data from Revenue Accelerator conversations, including engagement scores, sentiment analysis, and meeting metrics.

Lists CRM accounts from Zoom Revenue Accelerator by account IDs. Use when you need to retrieve CRM account information for specific account identifiers (up to 100 IDs).

Tool to retrieve CRM contact information from Zoom IQ Revenue Accelerator (ZRA). Use when you need to fetch detailed contact information for specific CRM contacts. Supports up to 100 contact IDs per request.

Tool to retrieve CRM deal information from Zoom Revenue Accelerator (ZRA). Use when you need to fetch detailed deal information for specific CRM deals. Supports up to 100 deal IDs per request.

Tool to retrieve CRM lead information from Zoom IQ Revenue Accelerator (ZRA). Use when you need to fetch detailed lead information for specific CRM leads. Supports up to 100 lead IDs per request.

Tool to retrieve the current CRM API registration information for Zoom Revenue Accelerator (ZRA). Use when you need to view the configured CRM settings including type, name, currency, deal stages, and URL patterns.

Tool to list deals from Zoom Revenue Accelerator (ZRA). Returns deal information including name, amount, stage, and owner details. Use when you need to retrieve CRM deal data from Zoom ZRA.

Tool to list scheduled Zoom Revenue Accelerator (ZRA) items. Use when you need to retrieve scheduled ZRA-related data. Returns an empty list when no scheduled items are available for the authenticated account.

Tool to retrieve account indicator settings for Zoom Revenue Accelerator (ZRA). Use when you need to view configured indicators that identify specific words, phrases, or sentences in conversations.

Tool to list conversation playlists for a specific user in Zoom Revenue Accelerator. Use when you need to retrieve playlists containing conversation clips for coaching or sharing purposes.

Moves one or more whiteboards to a specified Zoom Whiteboard project. Use when you need to organize whiteboards by assigning them to a specific project for better management and access control. The maximum number of whiteboards that can be moved in a single request is 50.

Removes a collaborator from a whiteboard project. Use this action when you need to revoke a user's access to a specific whiteboard project. This action is irreversible — once a collaborator is removed, they will no longer have access to the project's whiteboards unless re-added. Note: The authenticated user must be the project owner, co-owner, or have admin permissions to remove collaborators.

Removes the classification label from a whiteboard. Use this action when you need to unassign or clear a security classification label from an existing whiteboard. Not supported in Gov cluster. Each whiteboard can only have one classification label at a time — calling this action removes the currently applied classification, if any. This action is reversible — you can apply a new classification label afterward using the ApplyClassificationToWhiteboard action.

Removes one or more whiteboards from a specified Zoom Whiteboard project. This action is irreversible — once whiteboards are removed from a project, they cannot be automatically restored to that project. Use when you need to clean up whiteboards from a project or reassign them to a different project.

To update a meeting via API, ensure `start_time` is future-dated; `recurrence` is needed. Limit: 100 requests/day, 100 updates/meeting in 24 hrs. Requires `meeting:write` and `meeting:write:admin` scopes, with a `LIGHT` rate limit.

Updates the name of an existing whiteboard project in Zoom. This action allows you to rename a project to better reflect its content or purpose. The project_id is required to identify which project to update. This action is commonly used when reorganizing whiteboard content or updating project names to reflect new themes. Use this action when you need to rename a whiteboard project to better organize your Zoom whiteboards, update project names to reflect new topics or purposes, or batch-rename projects as part of a larger content management workflow. Note: This action modifies existing data but is not destructive — the project and all its associated whiteboards remain intact even after a name change.

Updates an existing classification label in Zoom Whiteboard. Use this action when you need to modify the name, color, sensitivity level, description, guideline URL, or default status of an existing classification label. Only the fields provided in the request body will be updated. Changes are saved as a draft and may need to be published separately. Use this action when you need to rename a classification label to better reflect its purpose, update the color coding for visibility, adjust sensitivity levels to match your organization's security policies, or change which label is set as the default for new whiteboards. Note: This action modifies existing data but is not destructive — the classification label and all associated whiteboards remain intact even after updates.

Updates collaborator permissions for a whiteboard project. Use this action when you need to change the permission level of one or more collaborators on a whiteboard project. This allows reassigning roles such as changing a viewer to an editor or promoting a collaborator to owner status. Prerequisites: - The user must be the project owner or have admin permissions - The whiteboard project must exist and be accessible Required fields: project_id, collaborators (list with collaborator_id and role for each) Common errors: - "User not found" - The collaborator ID does not match a Zoom user - "Project not found" - Invalid project ID - "Invalid collaborator role" - Role value must be 0, 1, 2, 3, or 4

Updates collaborator settings for a whiteboard. Changes the permission role for one or more collaborators on the whiteboard. Use this action when you need to modify what access levels collaborators have, such as promoting a viewer to editor or demoting an owner to co-owner. Note: When assigning a new Owner or Co-owner, the user must belong to the same account as the original Owner. If ownership is transferred, the original owner automatically becomes a Co-owner. This action is irreversible once the role changes are saved.

Updates the sharing settings for a whiteboard, controlling who can access and edit the whiteboard. Use this action when you need to change the share permissions, visibility scope, or access role for a specific whiteboard. The API returns HTTP 204 No Content on success.

Tool to update a comment in a Zoom Revenue Accelerator conversation. Use when you need to modify the text, mentions, or timestamp of an existing comment.

Tool to update the host of a Zoom Revenue Accelerator (ZRA) conversation. Use when you need to transfer conversation ownership to a different user.

Uploads a file to be used in Zoom Whiteboard. Supports PDF and Visio (.vsdx) file formats. Use when you need to import external documents into Zoom Whiteboard for collaboration and editing. The file upload uses a separate file API endpoint (fileapi.zoom.us).

Tool to validate a Zoom Marketplace app manifest before submission or update. Use when you need to verify that an app manifest configuration is valid and meets Zoom's requirements.

Triggers when a Zoom webinar's details change. Detects changes such as: - Topic updates - Start time changes - Agenda modifications - Duration changes - Settings updates (host video, registration type, audio options, etc.) - Status changes - Occurrence updates for recurring webinars - Recurrence pattern changes