Reference

ZOOM_MEETING_SUMMARY_UPDATED_TRIGGER

Fires when an AI-generated meeting summary is created or updated for a meeting. Requires a paid Zoom account with AI Companion enabled and a non-encrypted meeting that has summary generation enabled.

ZOOM_NEW_CLOUD_RECORDING_TRIGGER

Fires when a new cloud recording is created for a meeting the user attended or hosted.

ZOOM_NEW_MEETING_CREATED_TRIGGER

Fires when a user creates a new meeting.

ZOOM_NEW_MEETING_PARTICIPANT_TRIGGER

Fires when a new participant appears in the attendance report for a past meeting.

ZOOM_NEW_WEBINAR_CREATED_TRIGGER

Fires when a user creates a new webinar.

ZOOM_DAILY_USAGE_REPORT_CHANGED_TRIGGER

Fires when daily usage statistics are updated for a selected month and year, including metrics like active users, meetings held, and participant counts.

ZOOM_MEETING_DETAILS_CHANGED_TRIGGER

Fires when a meeting's details are updated, including topic, schedule, settings like waiting room or recording options, or recurrence pattern. This covers timezone, duration, password, and other configuration changes.

ZOOM_MEETING_RECORDING_CHANGED_TRIGGER

Fires when recording files are added, completed, or when recording metadata changes for a meeting. This includes new participant audio files and recording status updates.

ZOOM_NEW_WEBINAR_PARTICIPANT_TRIGGER

Fires when a new participant appears in the attendance report for a past webinar.

ZOOM_USER_INFORMATION_CHANGED_TRIGGER

Fires when a user's profile or account settings are updated, such as name, email, job title, phone, timezone, language, or account status.

ZOOM_WEBINAR_DETAILS_CHANGED_TRIGGER

Fires when any aspect of a webinar is modified, such as the topic, schedule, settings, or recurrence pattern. This includes changes to host video settings, registration requirements, and audio options.

Get daily usage report

Retrieves daily Zoom service usage metrics including new users, meetings, participants, and meeting minutes for each day of a specified month. This helps you track adoption and engagement patterns across your organization.

Create IQ conversation

Creates a Zoom Revenue Accelerator conversation entry to organize and track sales calls, meetings, or customer interactions after uploading recordings and transcripts. This helps you capture and analyze important business conversations for coaching and performance improvement.

Create IQ conversation comment

Add comments and annotations to Zoom conversation recordings or transcripts to collaborate with your team and document important discussions. This helps you capture insights and action items from client calls and meetings.

Create IQ user conversation

Creates a new conversation record in Zoom Revenue Accelerator for tracking user interactions and meetings. This helps you maintain organized records of customer conversations for sales analysis and team collaboration.

Delete IQ conversation

Permanently removes a Zoom IQ conversation from your system, allowing you to delete outdated or unwanted discussion records. This is useful for managing and cleaning up your conversation history.

Delete IQ conversation comment

Remove unwanted or outdated comments from Zoom conversation threads to keep discussions clean and focused. This helps maintain accurate records and prevents confusion from deleted or incorrect information.

Delete IQ deal activities

Remove activity records from a Zoom deal to clean up outdated or incorrect activity history and keep your deal information accurate.

Get IQ conversation comments

Retrieve all comments and discussion threads from a specific Zoom conversation, including timestamps and user information. This helps you access the full context of conversations and track discussion details.

Get IQ conversation content analysis

Retrieve AI-generated insights and analysis from a Zoom conversation to understand key discussion points, topics, and outcomes. This helps you capture and organize important meeting information without manual note-taking.

Get IQ conversation interactions

Retrieve detailed interaction data and transcript information from a Zoom conversation, including participant activity and engagement metrics. This helps you analyze customer or team discussions for insights and follow-up actions.

Get IQ conversation scorecards

Retrieves performance scorecards and quality metrics for a specific Zoom conversation to help evaluate call quality and performance. This operation allows you to programmatically access conversation scores and feedback that would normally be reviewed manually in Zoom.

Get IQ deal

Retrieve detailed information about a specific deal in Zoom Revenue Accelerator, including its value, current stage, assigned owner, and key dates to track sales progress.

Get IQ deal activities

Retrieve all activities and interactions associated with a specific deal in Zoom Revenue Accelerator, helping you track the complete history of customer engagement and deal progress.

Get IQ user conversation playlists

Retrieves conversation playlists associated with a Zoom IQ user, allowing you to access organized collections of meeting recordings and interactions. This helps you quickly find and review specific conversations grouped by topic or project.

Get marketplace user apps

Retrieve a list of Zoom Marketplace apps that are installed for a specific user, including their names, types, and installation status. This helps you understand which third-party integrations and extensions are available to your team members.

Get marketplace user entitlements

Retrieve the marketplace apps and add-ons that a specific Zoom user has access to, helping you understand what features and integrations are available on their account.

Add a meeting registrant

Automatically registers participants for a Zoom meeting that has registration enabled, capturing their contact information and custom details.

Create a meeting

Programmatically schedule Zoom meetings on your calendar with customizable settings like topic, start time, and participant details. This lets you automate meeting creation and integrate scheduling directly into your workflows.

Delete a meeting

Remove a scheduled Zoom meeting from your calendar, with the option to notify attendees about the cancellation. Use this when you need to cancel individual occurrences of recurring meetings or delete one-time meetings entirely.

Get a meeting

Retrieve complete details about a specific Zoom meeting including its schedule, join URLs, passwords, and settings. Use this to access all meeting information needed for planning, sharing with participants, or automating meeting-related workflows.

Get a meeting summary (Paid accounts only)

Retrieve an AI-generated summary of a Zoom meeting including key discussion points, action items, and next steps. This helps you quickly capture and reference meeting outcomes without manually taking notes.

Get meeting recordings

Retrieve all recordings from a completed Zoom meeting, including download links and metadata to access video files from your cloud storage.

Delete meeting recordings

Permanently removes all cloud recordings associated with a specific meeting or webinar from your Zoom account. Use this to manage storage, maintain privacy, or clean up recordings you no longer need.

Bulk import ZRA CRM leads

Quickly import or update multiple sales leads into Zoom Revenue Accelerator, handling up to 2000 records at once and tracking the import progress asynchronously.

Create ZRA conversation

Initiates a new conversation in Zoom Revenue Accelerator to analyze meeting recordings or phone calls with AI-powered insights like transcription, sentiment analysis, and engagement scoring.

Create ZRA conversation comment

Add comments, replies, or annotations to your Zoom Revenue Accelerator conversations to collaborate with team members and document important insights from calls and meetings.

Create ZRA CRM accounts

Sync your CRM account data into Zoom Revenue Accelerator to enable AI-powered insights and intelligence on your sales accounts. This allows you to bulk create or update up to 2000 accounts at once for seamless integration with Zoom IQ.

Create ZRA CRM contacts

Bulk import contacts into Zoom Revenue Accelerator from your existing CRM system, supporting up to 2,000 contacts per batch to keep your sales pipeline synchronized across platforms.

Create ZRA CRM deals

Bulk import deals from your external CRM system into Zoom Revenue Accelerator to keep your sales pipeline synchronized and up-to-date.

Create ZRA CRM settings

Registers your CRM system with Zoom Revenue Accelerator to enable automatic deal tracking and revenue insights directly within Zoom meetings. This connects your sales pipeline data so Zoom can analyze deal progress and meeting impact on your revenue.

Create ZRA user conversation

Initiates a new conversation record in Zoom Revenue Accelerator for tracking sales interactions and discussions with a specific timeline and topic. This helps you maintain a structured record of client conversations tied to revenue opportunities.

Delete ZRA conversation

Remove a conversation from your Zoom Revenue Accelerator system when it's no longer needed or relevant to your sales pipeline. This helps keep your revenue tracking data clean and organized.

Delete ZRA conversation comment

Remove unwanted or outdated comments from Zoom Revenue Accelerator conversations to keep your sales discussions clean and organized. This helps maintain accurate conversation records and removes any erroneous or sensitive information that shouldn't remain in your deal communication history.

Delete ZRA CRM settings

Remove your Zoom Revenue Accelerator CRM configuration from your account when you no longer need the integration or want to reset your settings.

Delete ZRA deal activities

Remove activities from a Zoom Revenue Accelerator deal to keep your deal information accurate and up-to-date. Use this when activities are completed, duplicated, or no longer relevant to your deal progress.

Add a webinar registrant

Automatically register attendees for your Zoom webinar, allowing you to build your audience and capture participant information in advance. This streamlines the sign-up process and enables you to manage attendee confirmations.

Get a webinar

Retrieve detailed information about a specific Zoom webinar, including title, description, schedule, and attendee settings to monitor and manage your webinar events.

Add project collaborators

Invite team members or external users to collaborate on a Zoom whiteboard project with specific permission levels. This enables seamless teamwork by granting collaborators access to shared visual workspaces.

Add whiteboard collaborator

Invite users or team channels to collaborate on a whiteboard and assign them specific permission levels to control what they can do. This enables real-time brainstorming and content creation with controlled access.

Apply classification to whiteboard

Assign or update security classification labels on whiteboards to control access and compliance. This helps you organize whiteboards by sensitivity level, ensuring proper data protection and governance.

Create a whiteboard

Creates a new blank whiteboard for collaborative visual planning and brainstorming that can be shared with team members or clients. This enables you to quickly set up a digital canvas for real-time collaboration and idea visualization.

Create whiteboard export

Initiates the export process to generate PDF files and audit logs for your Zoom whiteboards, bundling them into a downloadable ZIP file for archival or sharing purposes.

Create whiteboard project

Creates a new whiteboard project in Zoom to organize and group whiteboards together with optional collaborators. Use this when you need a centralized workspace for visual brainstorming, planning, or collaborative design work.

Delete whiteboard

Permanently removes a specific whiteboard from Zoom, allowing you to clean up old brainstorming sessions and meeting materials to keep your workspace organized.

Delete whiteboard collaborator

Remove a collaborator's access to a whiteboard, preventing them from viewing or editing shared content. Use this when team members leave projects, change roles, or you need to restrict whiteboard visibility for security or organization purposes.

Delete whiteboard project

Permanently removes a whiteboard project and all its associated whiteboards from Zoom. This is useful when you want to clean up completed projects or archived collaboration spaces.

Download imported whiteboard file

Retrieves and downloads files that were imported into Zoom whiteboards, allowing you to access images, PDFs, documents, and other attachments shared during collaborative sessions.

Download whiteboard export

Retrieves the exported whiteboard content from a completed export task as a downloadable file. Use this to access all drawings, annotations, and images captured during your Zoom meetings.

Download whiteboard session activity

Retrieves and downloads the PDF archive file containing whiteboard activity and notes from a completed Zoom session. Use this to preserve meeting discussions, sketches, and collaborative work for future reference or documentation.

Remove project collaborator

Remove a team member's access to a Zoom whiteboard project instantly. Use this when team members leave, change roles, or no longer need to collaborate on specific projects.

Get a user

Retrieves detailed information about a specific Zoom user by ID, email, or 'me'.

Get a whiteboard

Retrieves details about a specific whiteboard document.

Get a whiteboard session

Retrieves detailed information about a specific whiteboard session by its session ID.

Get past meeting participants

Retrieves the list of participants who attended a past (ended) Zoom meeting.

Get user settings

Tool to retrieve a user's settings including meeting scheduling, in-meeting features, email notifications, recording, telephony, and security preferences.

Get whiteboard export status

Retrieves the status of a whiteboard export task by its task ID.

Get whiteboard project

Retrieves detailed information about a specific whiteboard project by its ID.

Get ZRA conversation comments

Tool to retrieve comments for a specific Zoom Revenue Accelerator (ZRA) conversation.

Get ZRA conversation interactions

Retrieves interaction details for a specific Zoom Revenue Accelerator (ZRA) conversation.

Get ZRA conversation scorecards

Tool to retrieve scorecards for a specific conversation in Zoom Revenue Accelerator.

Get ZRA deal activities

Tool to retrieve activities associated with a Zoom Revenue Accelerator (ZRA) deal.

Import whiteboard

Initiates an import of a whiteboard from an external source (Miro, Mural, or Visio files).

List all recordings

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.

List archived files

Lists archived meeting and webinar files within a specified date range (max 7 days).

List devices

Lists devices in your Zoom account managed through Zoom Device Management (ZDM).

List IQ conversations

DEPRECATED: Use ZOOMLISTZRACONVERSATIONS instead (Zoom rebranded IQ to ZRA).

List IQ deals

DEPRECATED: Use ZOOMLISTZRADEALS instead (Zoom rebranded IQ to ZRA).

List marketplace app custom fields

Tool to retrieve custom fields configured for a Zoom Marketplace app.

List meeting summary templates

Tool to retrieve a list of meeting summary templates for a specified user.

List meetings

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.

List past meeting instances

Tool to retrieve all UUIDs for past instances of a given meeting.

List project collaborators

Lists all collaborators for a whiteboard project, including their roles and permissions.

List user collaboration devices

Tool to list collaboration devices associated with a user.

List webinar participants

Get a list of past webinar participants with a Pro plan or above plus an add-on.

List webinar registrants

Retrieves the list of registrants for a webinar with registration enabled.

List webinars

The API lists all scheduled webinars for Zoom users with a webinar plan, using me for user-level apps.

List whiteboard projects

Lists all whiteboard projects accessible to the user.

List whiteboards

Lists all whiteboards accessible to the user.

List ZRA conversations

Tool to list all conversations in Zoom Revenue Accelerator.

List ZRA CRM accounts

Lists CRM accounts from Zoom Revenue Accelerator by account IDs.

List ZRA CRM contacts

Tool to retrieve CRM contact information from Zoom IQ Revenue Accelerator (ZRA).

List ZRA CRM deals

Tool to retrieve CRM deal information from Zoom Revenue Accelerator (ZRA).

List ZRA CRM leads

Tool to retrieve CRM lead information from Zoom IQ Revenue Accelerator (ZRA).

List ZRA CRM settings

Tool to retrieve the current CRM API registration information for Zoom Revenue Accelerator (ZRA).

List ZRA deals

Tool to list deals from Zoom Revenue Accelerator (ZRA).

List ZRA scheduled items

Tool to list scheduled Zoom Revenue Accelerator (ZRA) items.

List ZRA settings indicators

Tool to retrieve account indicator settings for Zoom Revenue Accelerator (ZRA).

List ZRA user conversation playlists

Tool to list conversation playlists for a specific user in Zoom Revenue Accelerator.

Move whiteboards to project

Moves one or more whiteboards to a specified Zoom Whiteboard project.

Remove whiteboard classification

Removes the classification label from a whiteboard.

Remove whiteboards from project

Removes one or more whiteboards from a specified Zoom Whiteboard project.

Search company contacts

Tool to search company contacts in Zoom by first name, last name, or email.

Update a meeting

To update a meeting via API, ensure starttime is future-dated; recurrence is needed.

Update a whiteboard project

Updates the name of an existing whiteboard project in Zoom.

Update classification label

Updates an existing classification label in Zoom Whiteboard.

Update IQ conversation comment

DEPRECATED: Use ZOOMUPDATEZRACONVERSATIONCOMMENT instead (Zoom rebranded IQ to ZRA).

Update IQ conversation host

DEPRECATED: Use ZOOMUPDATEZRACONVERSATIONHOST instead (Zoom rebranded IQ to ZRA).

Update project collaborators

Updates collaborator permissions for a whiteboard project.

Update whiteboard collaborator

Updates collaborator settings for a whiteboard.

Update whiteboard share settings

Updates the sharing settings for a whiteboard, controlling who can access and edit the whiteboard.

Update ZRA conversation comment

Tool to update a comment in a Zoom Revenue Accelerator conversation.

Update ZRA conversation host

Tool to update the host of a Zoom Revenue Accelerator (ZRA) conversation.

Upload Whiteboard File

Uploads a file to be used in Zoom Whiteboard.

Validate marketplace app manifest

Tool to validate a Zoom Marketplace app manifest before submission or update.