Zoom

Retrieves detailed information about a Zoom meeting by its ID. Returns comprehensive meeting data including topic, schedule, URLs, passwords, settings, and for recurring meetings, occurrence details and recurrence patterns. For recurring meetings, defaults to the latest occurrence unless occurrence_id or show_previous_occurrences is specified. Returned start_time must be interpreted using the meeting's timezone field. Requires meeting:read scope. Rate limit: LIGHT.

IMPORTANT: This action requires a PAID Zoom account (Pro, Business, or Enterprise plan). Free Zoom accounts cannot use this feature and will receive a 400 error. Additionally requires: - AI Companion feature enabled in account settings - Meeting must not be end-to-end encrypted (E2EE) - Meeting summary must be enabled and generated for the meeting Rate limit: LIGHT. Response fields such as `summary_details` and `next_steps` are optional and may be absent or empty arrays.

Retrieves detailed information about a specific Zoom user by ID, email, or 'me'. Returns user type, role, license info, and account metadata. Use when you need to check user type/license or retrieve user profile details.

To download meeting recordings, use `download_url`. Include OAuth token in the header for passcode-protected ones. Supports `recording:read` and `phone_recording:read:admin` scopes, with a `LIGHT` rate limit. Requires a paid Zoom plan with cloud recording enabled; missing entitlements return empty results or entitlement errors, not system failures. Error code 3301 means no cloud recording exists for the meeting — an expected empty-result case.

This text details how to list Zoom cloud recordings for a user, notably by using "me" for user-level apps and requiring an OAuth token for access. It requires a Pro plan, Cloud Recording enabled, and has a MEDIUM rate limit.

Tool to retrieve a list of meeting summary templates for a specified user. Use when you need to view available meeting summary templates or select a template for meeting summaries.

This Zoom API lists a user's scheduled meetings using the `me` value for user-level apps, excluding instant meetings and only showing unexpired ones. Requires specific scopes and has a `MEDIUM` rate limit. No server-side filtering by topic, agenda, or text fields; all such filtering must be done client-side. `meetingId` values exceed 32-bit integer range; treat as full-length numeric or string identifiers.

Retrieves the list of registrants for a webinar with registration enabled. This endpoint returns registrants (people who registered for the webinar), not participants (people who attended). Use this action when you need to view registrant details for CRM sync, reporting, or managing approvals for registration-based webinars. Supports filtering by occurrence, status (approved/pending/denied), and tracking source for targeted queries.

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.

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.

Enable Zoom meeting creation via user-level apps with "me". "Start_url" for hosts expires in 2 hours, or 90 days for "custCreate" users. Renew via API, capped at 100 requests/day. Requires "meeting:write" permission, subject to medium rate limit.

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).

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 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 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.

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 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.

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.

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 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.

Delete or cancel a scheduled Zoom meeting. Use occurrence_id to delete a specific occurrence of a recurring meeting. Supports notification options for hosts and registrants. Returns HTTP 204 on success. Rate limit: Light. Required scopes: meeting:write or meeting:write:admin.

Deletes a specific cloud recording file from a meeting or webinar. This action is irreversible when using the 'delete' action - the file cannot be recovered once permanently removed. Use this action when you need to remove an individual recording file (such as a specific video, audio, transcript, or chat file) rather than all recordings for a meeting. Requires the account to have Cloud Recording enabled. Rate limit: Light.

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.

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.

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.