Skip to main content
Zoom logo
  • Category: video conferencing
  • Auth: OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 105
  • Triggers: 11
  • Slug: ZOOM
  • Version: 20261101_00

Frequently Asked Questions

For a step-by-step guide on creating and configuring your own Zoom OAuth credentials with Composio, see How to create OAuth credentials for Zoom.

Tools

Slug: ZOOM_ADD_A_MEETING_REGISTRANTRegisters 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

Input Parameters

string
The registrant’s organization.
string
The registrant’s ZIP or postal code.
string
The registrant’s city.
string
required
The registrant’s email address.
string
The registrant’s phone number.
string
The registrant’s state or province.
string
The registrant’s address.
string
The registrant’s two-letter country code.
string
The registrant’s questions and comments.
string
The registrant’s industry.
string ("en-US" | "de-DE" | "es-ES" | "fr-FR" | "jp-JP" | "pt-PT" | "ru-RU" | "zh-CN" | "zh-TW" | "ko-KO" | "it-IT" | "vi-VN" | "pl-PL" | "Tr-TR")
The registrant’s language preference for confirmation emails: * en-US — English (US) * de-DE — German (Germany) * es-ES — Spanish (Spain) * fr-FR — French (France) * jp-JP — Japanese * pt-PT — Portuguese (Portugal) * ru-RU — Russian * zh-CN — Chinese (PRC) * zh-TW — Chinese (Taiwan) * ko-KO — Korean * it-IT — Italian (Italy) * vi-VN — Vietnamese * pl-PL — Polish * Tr-TR — Turkish
string
The registrant’s job title.
string
required
The registrant’s last name.
string
required
The registrant’s first name.
integer
required
The meeting’s ID. When storing this value in your database, you must store it as a long format integer and not an integer. Meeting IDs can exceed 10 digits.
boolean
If a meeting was scheduled with the approval_type field value of 1 (manual approval) but you want to automatically approve meeting registrants, set the value of this field to true. Note: You cannot use this field to change approval setting for a meeting originally scheduled with the approval_type field value of 0 (automatic approval).
string
A comma-separated list of meeting occurrence IDs. You can get this value with the Get a meeting API.
string ("" | "1-20" | "21-50" | "51-100" | "101-500" | "500-1,000" | "1,001-5,000" | "5,001-10,000" | "More than 10,000")
The registrant’s number of employees: * 1-20 * 21-50 * 51-100 * 101-500 * 500-1,000 * 1,001-5,000 * 5,001-10,000 * More than 10,000
array
Information about custom questions.
string ("" | "Within a month" | "1-3 months" | "4-6 months" | "More than 6 months" | "No timeframe")
The registrant’s purchasing time frame: * Within a month * 1-3 months * 4-6 months * More than 6 months * No timeframe
string ("" | "Decision Maker" | "Evaluator/Recommender" | "Influencer" | "Not involved")
The registrant’s role in the purchase process: * Decision Maker * Evaluator/Recommender * Influencer * Not involved

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_ADD_A_WEBINAR_REGISTRANTRegisters 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

Input Parameters

string
The registrant’s organization.
string
The registrant’s ZIP or postal code.
string
The registrant’s city.
string
required
The registrant’s email address.
string
The registrant’s phone number.
string
The registrant’s state or province.
string
The registrant’s address.
string
The registrant’s two-letter country code.
string
The registrant’s questions and comments.
string
The registrant’s industry.
string ("en-US" | "de-DE" | "es-ES" | "fr-FR" | "jp-JP" | "pt-PT" | "ru-RU" | "zh-CN" | "zh-TW" | "ko-KR" | "it-IT" | "vi-VN" | "pl-PL" | "tr-TR")
The registrant’s language preference for confirmation emails: * en-US - English (US) * de-DE - German (Germany) * es-ES - Spanish (Spain) * fr-FR - French (France) * jp-JP - Japanese * pt-PT - Portuguese (Portugal) * ru-RU - Russian * zh-CN - Chinese (PRC) * zh-TW - Chinese (Taiwan) * ko-KR - Korean * it-IT - Italian (Italy) * vi-VN - Vietnamese * pl-PL - Polish * tr-TR - Turkish
string
The registrant’s job title.
string
The registrant’s last name.
string
The tracking source’s unique identifier.
string
required
The registrant’s first name.
string
required
The webinar’s ID.
string
A comma-separated list of webinar occurrence IDs. Get this value with the Get a webinar API. Make sure the registration_type is 3 if updating multiple occurrences with this API.
string ("" | "1-20" | "21-50" | "51-100" | "101-500" | "500-1,000" | "1,001-5,000" | "5,001-10,000" | "More than 10,000")
The registrant’s number of employees: * 1-20 * 21-50 * 51-100 * 101-500 * 500-1,000 * 1,001-5,000 * 5,001-10,000 * More than 10,000
array
Information about custom questions.
string ("" | "Within a month" | "1-3 months" | "4-6 months" | "More than 6 months" | "No timeframe")
The registrant’s purchasing time frame: * Within a month * 1-3 months * 4-6 months * More than 6 months * No timeframe
string ("" | "Decision Maker" | "Evaluator/Recommender" | "Influencer" | "Not involved")
The registrant’s role in the purchase process: * Decision Maker * Evaluator/Recommender * Influencer * Not involved

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_ADD_PROJECT_COLLABORATORSAdds 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

Input Parameters

string
required
The unique identifier of the whiteboard project.
array
required
List of users to add as collaborators with their email addresses and roles.
string
A custom message to include with the project invitation. Maximum 280 characters.
boolean
If set to true, collaborators will not receive email notifications about the invitation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_ADD_WHITEBOARD_COLLABORATORAdds 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).

Input Parameters

array
required
List of users or channels to add as collaborators. Supports 1-100 collaborators per request. Each item must have either email (for individual users) or channel_id (for team chat channels), but not both.
string
required
The unique identifier of the whiteboard.
string
A custom message to include with the collaborator invitation. Maximum 280 characters.
boolean
If true, collaborators will not receive email or in-app notifications about the invitation. Defaults to false (notifications are sent).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_APPLY_CLASSIFICATION_TO_WHITEBOARDApplies 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.

Input Parameters

string
required
The whiteboard’s unique identifier.
string
required
The unique identifier of the classification label to apply to the whiteboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CREATE_A_MEETINGCreate a Zoom meeting for a specified user, defaulting to the authenticated user. The host’s start URL expires after two hours for regular users or 90 days for custCreate users; meeting creation is limited to 100 requests per day per host.

Input Parameters

integer
The type of meeting. * 1 - An instant meeting. * 2 - A scheduled meeting. * 3 - A recurring meeting with no fixed time. * 8 - A recurring meeting with fixed time.
string
The meeting’s topic.
string
The meeting’s agenda. This value has a maximum length of 2,000 characters.
string
The user’s user ID or email address. For user-level apps, pass the me value. Defaults to me for user-level apps.
integer
The meeting’s scheduled duration, in minutes. This field is only used for scheduled meetings (2). Ignored for all other meeting types.
string
The passcode required to join the meeting. By default, a passcode can only have a maximum length of 10 characters and only contain alphanumeric characters and the @, -, _, and * characters. * If the account owner or administrator has configured minimum passcode requirement settings, the passcode must meet those requirements. * If passcode requirements are enabled, use the Get user settings API or the Get account settings API to get the requirements.
string
The timezone to assign to the start_time value. This field is only used for scheduled or recurring meetings with a fixed time. For a list of supported timezones and their formats, see our timezone list. Omitting this silently falls back to the account’s timezone, which may shift meeting times for participants.
string
The meeting’s start time. This field is only used for scheduled or recurring meetings with a fixed time. This supports local time and GMT formats. * To set a meeting’s start time in GMT, use the yyyy-MM-ddTHH:mm:ssZ date-time format. For example, 2020-03-31T12:02:00Z. * To set a meeting’s start time using a specific timezone, use the yyyy-MM-ddTHH:mm:ss date-time format and specify the timezone ID in the timezone field. If you do not specify a timezone, the timezone value defaults to your Zoom account’s timezone. You can also use UTC for the timezone value. Note: If no start_time is set for a scheduled meeting, the start_time is set at the current time and the meeting type changes to an instant meeting, which expires after 30 days.
string
The account admin meeting template ID used to schedule a meeting using a meeting template. For a list of account admin-provided meeting templates, use the List meeting templates API. * At this time, this field only accepts account admin meeting template IDs. * To enable the account admin meeting templates feature, contact Zoom support.
boolean
Whether to create a prescheduled meeting via the GSuite app. This only supports the meeting type value of 2 (scheduled meetings) and 3 (recurring meetings with no fixed time). * true - Create a prescheduled meeting. * false - Create a regular meeting.
string
The email address or user ID of the user to schedule a meeting for.
string ("both" | "telephony" | "voip" | "thirdParty")
How participants join the audio portion of the meeting. * both - Both telephony and VoIP. * telephony - Telephony only. * voip - VoIP only. * thirdParty - Third party audio conference.
array
Information about the meeting’s tracking fields.
boolean
Whether to generate a default passcode using the user’s settings. This value defaults to false. If this value is true and the user has the PMI setting enabled with a passcode, then the user’s meetings will use the PMI passcode. It will not use a default passcode.
integer
Recurrence meeting types. 1 - Daily. 2 - Weekly. 3 - Monthly.
boolean
Whether to use a Personal Meeting ID (PMI) instead of a generated meeting ID. This field is only used for scheduled meetings (2), instant meetings (1), or recurring meetings with no fixed time (3). This value defaults to false.
integer
If the value of the join_before_host field is true, this field indicates the time limits when a participant can join a meeting before the meeting’s host. * 0 - Allow the participant to join the meeting at anytime. * 5 - Allow the participant to join 5 minutes before the meeting’s start time. * 10 - Allow the participant to join 10 minutes before the meeting’s start time.
array
The meeting’s resources. Each resource must include resource_id and resource_type fields.
boolean
Whether to add a watermark when viewing a shared screen.
boolean
Whether to host the meeting in China (CN). This value defaults to false.
boolean
Whether to enable the Focus Mode feature when the meeting starts.
boolean
Whether to start meetings with the host video on.
boolean
Whether to host the meeting in India (IN). This value defaults to false.
integer
Select how many times the meeting should recur before it is canceled. If end_times is set to 0, it means there is no end time. The maximum number of recurring is 60. Cannot be used with end_date_time.
string
The contact name for meeting registration.
boolean
Whether to enable the Waiting Room feature. If this value is true, this disables the join_before_host setting.
integer
Use this field only if you’re scheduling a recurring meeting of type 3 to state the day in a month when the meeting should recur. The value range is from 1 to 31. For the meeting to recur on 23rd of each month, provide 23 as this field’s value and 1 as the repeat_interval field’s value. Instead, if you would like the meeting to recur every three months, on 23rd of the month, change the value of the repeat_interval field to 3.
string ("1" | "2" | "3" | "4" | "5" | "6" | "7")
This field is required if you’re scheduling a recurring meeting of type 2 to state the days of the week when the meeting should repeat. The value must be a single number between 1 to 7 in string format. For instance, if the meeting should recur on Sunday, provide 1 as this field’s value. To set the meeting to occur on multiple days, you must call the API multiple times or use a different recurrence pattern. 1 - Sunday. 2 - Monday. 3 - Tuesday. 4 - Wednesday. 5 - Thursday. 6 - Friday. 7 - Saturday.
integer
Enable meeting registration approval. * 0 - Automatically approve registration. * 1 - Manually approve registration. * 2 - No registration required. This value defaults to 2.
string
The contact email address for meeting registration.
integer
Use this field only if you’re scheduling a recurring meeting of type 3 to state the week of the month when the meeting should recur. If you use this field, you must also use the monthly_week_day field to state the day of the week when the meeting should recur. -1 - Last week of the month. 1 - First week of the month. 2 - Second week of the month. 3 - Third week of the month. 4 - Fourth week of the month.
string ("local" | "cloud" | "none")
The automatic recording settings. * local - Record the meeting locally. * cloud - Record the meeting to the cloud. * none - Auto-recording disabled. This value defaults to none.
string ("enhanced_encryption" | "e2ee")
The type of end-to-end (E2EE) encryption to use for the meeting. * enhanced_encryption - Enhanced encryption. Encryption is stored in the cloud when you enable this option. * e2ee - End-to-end encryption. The encryption key is stored on your local device and cannot be obtained by anyone else. When you use E2EE encryption, certain features, such as cloud recording or phone and SIP/H.323 dial-in, are disabled.
boolean
Whether to set the meeting as private.
string
Select the final date when the meeting will recur before it is canceled. Should be in UTC time, such as 2017-11-25T12:00:00Z. Cannot be used with end_times.
boolean
Whether to set the meeting as an internal meeting.
array
A list of the meeting’s invitees.
boolean
Whether to mute participants upon entry.
integer
Define the interval when the meeting should recur. For instance, to schedule a meeting that recurs every two months, set this field’s value as 2 and the value of the type parameter as 3. For a daily meeting, the maximum interval you can set is 90 days. For a weekly meeting the maximum interval that you can set is of 12 weeks. For a monthly meeting, there is a maximum of 3 months.
string
A semicolon-separated list of the meeting’s alternative hosts” email addresses or IDs.
boolean
Whether participants can join the meeting before its host. This field is only used for scheduled meetings (2) or recurring meetings (3 and 8). This value defaults to false. If the Waiting Room feature is enabled, this setting is disabled.
boolean
Whether to start meetings with the participant video on.
integer
The meeting’s registration type. * 1 - Attendees register once and can attend any meeting occurrence. * 2 - Attendees must register for each meeting occurrence. * 3 - Attendees register once and can select one or more meeting occurrences to attend. This field is only for recurring meetings with fixed times (8). This value defaults to 1.
boolean
Whether to close registration after the event date. This value defaults to false.
boolean
Whether to send email notifications to alternative hosts and users with scheduling privileges. This value defaults to true.
boolean
Whether to include social media sharing buttons on the meeting’s registration page. This setting is only applied to meetings with registration enabled.
integer
Use this field only if you’re scheduling a recurring meeting of type 3 to state a specific day in a week when the monthly meeting should recur. To use this field, you must also use the monthly_week field. 1 - Sunday. 2 - Monday. 3 - Tuesday. 4 - Wednesday. 5 - Thursday. 6 - Friday. 7 - Saturday.
array
Information about the breakout rooms.
string
If the meeting_authentication value is true, the type of authentication required for users to join a meeting. To get this value, use the authentication_options array’s id value in the Get user settings API response.
boolean
Whether to enable the Breakout Room pre-assign option.
string
Third party audio conference info.
string
The meeting’s authenticated domains. Only Zoom users whose email address contains an authenticated domain can join the meeting. Comma-separate multiple domains or use a wildcard for listing domains.
boolean
If true, only authenticated users can join the meeting.
boolean
Whether to allow attendees to join a meeting from multiple devices. This setting is only applied to meetings with registration enabled.
boolean
Whether the Allow host to save video order feature is enabled.
array
A list of participants that can bypass meeting authentication. These participants will receive a unique meeting invite. Each exception must include name and email fields.
boolean
Whether to push meeting changes to the calendar. To enable this feature, configure the Configure Calendar and Contacts Service in the user’s profile page of the Zoom web portal and enable the Automatically sync Zoom calendar events information bi-directionally between Zoom and integrated calendars. setting in the Settings page of the Zoom web portal. * true - Push meeting changes to the calendar. * false - Do not push meeting changes to the calendar.
array
A list of available global dial-in countries.
boolean
Whether to automatically start a meeting summary.
boolean
Whether to set the meeting as a participant focused meeting.
boolean
Whether the Allow alternative hosts to add or edit polls feature is enabled. This requires Zoom version 5.8.0 or higher.
boolean
Whether to enable language interpretation for the meeting.
boolean
Whether to send registrants an email confirmation. * true - Send a confirmation email. * false - Do not send a confirmation email.
boolean
Whether to send registrants email notifications about their registration approval, cancellation, or rejection. * true - Send an email notification. * false - Do not send an email notification. Set this value to true to also use the registrants_confirmation_email parameter.
array
Add additional meeting data center regions. Provide this value as an array of country codes for the countries available as data center regions in the Account Profile interface but have been opted out of in the user settings. For example, the data center regions selected in your Account Profile are Europe, Hong Kong SAR, Australia, India, Japan, China, United States, and Canada. However, in the My Profile settings, you did not select India and Japan for meeting and webinar traffic routing. To include India and Japan as additional data centers, use the [IN, TY] value for this field.
boolean
Whether to enable the Enable continuous meeting chat setting.
array
The list of blocked countries or regions.
boolean
Whether to automatically start AI Companion questions.
array
Information about the meeting’s language interpreters. Each interpreter must include email and languages fields.
boolean
Whether to enable sign language interpretation for the meeting.
boolean
Whether to send email notifications to alternative hosts. This value defaults to true.
array
The list of approved countries or regions.
boolean
Whether to enable the Automatically add invited external users setting.
array
Information about the meeting’s sign language interpreters. Each interpreter must include email and sign_language fields.
boolean
string ("approve" | "deny")
Whether to allow or block users from specific countries or regions. * approve - Allow users from specific countries or regions to join the meeting. If you select this setting, include the approved countries or regions in the approved_list field. * deny - Block users from specific countries or regions from joining the meeting. If you select this setting, include the blocked countries or regions in the denied_list field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CREATE_IQ_CONVERSATIONDEPRECATED: Use ZOOM_CREATE_ZRA_CONVERSATION instead (Zoom rebranded IQ to ZRA). Tool to create a Zoom Revenue Accelerator (formerly Zoom IQ) conversation. Use when you need to create a new conversation entry, typically after uploading recording files, transcripts, and metadata.

Input Parameters

string
Topic or title of the conversation.
string
User ID of the conversation host. If not provided, defaults to the authenticated user.
integer
Duration of the conversation in seconds.
string
Meeting ID to associate with this conversation.
string
Conversation start time in ISO 8601 date-time format (e.g., 2024-01-15T10:30:00Z).
string
Primary language code for the conversation (e.g., ‘en’, ‘es’, ‘fr’).
string
Type of conversation (e.g., ‘meeting’, ‘phone’, ‘external’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CREATE_IQ_CONVERSATION_COMMENTDEPRECATED: Use ZOOM_CREATE_ZRA_CONVERSATION_COMMENT instead (Zoom rebranded IQ to ZRA). Tool to create a comment on a Zoom IQ conversation. Use when you need to add comments, replies, or annotations to IQ conversation recordings or transcripts.

Input Parameters

string
required
The text content of the comment to add to the conversation.
boolean
Whether the comment is private (visible only to specific users) or public (visible to all conversation participants).
string
required
The conversation’s unique identifier.
array
Array of team IDs to mention in the comment. Team members will be notified.
array
Array of user IDs to mention in the comment. These users will be notified.
string
Parent comment ID for threaded replies. Leave empty for top-level comments.
string
Timestamp in the recording where the comment should be anchored.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CREATE_IQ_USER_CONVERSATIONDEPRECATED: Use ZOOM_CREATE_ZRA_USER_CONVERSATION instead (Zoom rebranded IQ to ZRA). Tool to create a Zoom IQ conversation for a user. Use when you need to create a new conversation entry in Zoom Revenue Accelerator for a specific user.

Input Parameters

string
The user ID or email address of the user. Use ‘me’ to create a conversation for the authenticated user. Defaults to ‘me’.
string
The type of conversation (e.g., ‘meeting’, ‘phone_call’).
string
The topic or title of the conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CREATE_PROJECTCreates 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.

Input Parameters

string
Email address of the project owner. Only usable with admin scope.
string
required
The name of the whiteboard project. Must be between 1 and 50 characters.
array
List of collaborators to add to the project. Each collaborator must have an email and role.
string
The invite message to send to collaborators. Maximum 280 characters.
array
List of whiteboard IDs to add to the project. Whiteboards must belong to the same account.
boolean
If set to true, collaborators will not receive notifications when added to the project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CREATE_WHITEBOARDCreates 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

Input Parameters

string
The whiteboard name. If not provided, the default name ‘Untitled’ will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CREATE_WHITEBOARD_EXPORTCreates 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.

Input Parameters

array
required
The list of whiteboard IDs to export. The list must contain between 1 and 50 unique whiteboard IDs. If more than 50 IDs are provided, only the first 50 will be processed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CREATE_ZRA_CONVERSATIONTool 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.

Input Parameters

string
Zoom deal ID to associate this conversation with a specific deal in your CRM.
string
IQ file’s unique identifier for uploading a recording file that was already uploaded to Zoom IQ.
string
Host user ID or email address. If not provided, the OAuth token owner will be set as the default host.
array
Speech timeline showing when each participant spoke during the recording. Helps with speaker diarization and analytics.
string
Time zone for formatting timestamps in the conversation analytics (e.g., ‘America/New_York’, ‘Europe/London’).
string
Third-party download URL for the recording file. Use this to directly upload a file from an external file service.
array
List of participants in the conversation. Maximum 200 participants. Each participant must have a display_name and optionally an email.
string
End time of the meeting or call in ISO-8601 format. Optional but recommended for accurate duration tracking.
string ("en" | "es" | "fr" | "de" | "it" | "zh" | "ru" | "uk" | "ja" | "ko" | "vi" | "pt" | "nl" | "hi")
Supported primary languages for conversation analysis
string ("meeting" | "phone")
required
Type of conversation to create. Use ‘meeting’ for Zoom meetings or video calls, ‘phone’ for phone calls.
string
Topic or title of the meeting or phone call. Helps identify the conversation in analytics.
string
required
Start time of the meeting or call in ISO-8601 format (e.g., ‘2026-02-17T10:00:00Z’). Required for all conversations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CREATE_ZRA_CONVERSATION_COMMENTTool 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.

Input Parameters

string
required
The conversation identifier for the Zoom Revenue Accelerator conversation.
string
required
The text content of the comment to add to the conversation.
boolean
Whether the comment is private (visible only to specific users) or public (visible to all conversation participants).
array
Array of team IDs to mention in the comment. Team members will be notified.
array
Array of user IDs to mention in the comment. These users will be notified.
string
Parent comment ID for nested replies. Leave empty for top-level comments.
string
Timestamp in the recording where the comment should be anchored (format: HH:MM:SS).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CREATE_ZRA_CRM_ACCOUNTSCreate, update, or delete CRM accounts in Zoom Revenue Accelerator in batches of up to 2,000. A task ID may be returned for polling status.

Input Parameters

array
required
Array of CRM account objects to create or update. Maximum 2000 accounts per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CREATE_ZRA_CRM_CONTACTSBulk import or delete CRM contacts in Zoom Revenue Accelerator, accepting up to 2,000 contacts per request. A task ID may be returned for asynchronous status tracking.

Input Parameters

array
required
Array of CRM contact objects. Up to 2,000 contacts can be submitted per request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CREATE_ZRA_CRM_DEALSTool 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.

Input Parameters

array
required
List of CRM deal objects for bulk import or deletion. Maximum of 2000 deals per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CREATE_ZRA_CRM_LEADSBulk import, update, or delete CRM leads in Zoom Revenue Accelerator, with up to 2,000 leads per request. A task ID may be returned to track asynchronous processing.

Input Parameters

array
required
Array of CRM lead objects to bulk import. Maximum of 2000 leads per request. Each lead must include crm_lead_id, lead_name, and modify_time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CREATE_ZRA_CRM_SETTINGSTool 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.

Input Parameters

string
Display name for the CRM type. If not provided, defaults to the value of crm_type.
string
required
CRM type identifier, 1-16 alphanumeric characters, must start with letter (e.g., ‘oracle’, ‘salesforce’).
array
required
Array of deal stage definitions. Must include at least one stage for each type: OPEN, CLOSED_WON, and CLOSED_LOST.
string
Currency unit to use (e.g., ‘USD’, ‘EUR’, ‘JPY’). Defaults to ‘USD’ if not specified.
string
URL pattern template for opening deal objects in the CRM. Use {id} as placeholder for the deal ID (e.g., ‘https://example.com/deals/{id}’).
string
URL pattern template for opening lead objects in the CRM. Use {id} as placeholder (e.g., ‘https://example.com/leads/{id}’).
string
URL pattern template for opening account objects in the CRM. Use {id} as placeholder (e.g., ‘https://example.com/accounts/{id}’).
string
URL pattern template for opening contact objects in the CRM. Use {id} as placeholder (e.g., ‘https://example.com/contacts/{id}’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CREATE_ZRA_USER_CONVERSATIONTool 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.

Input Parameters

string
required
The user ID or ‘me’ to create a conversation for. Use ‘me’ for the authenticated user.
string
required
The conversation title/topic. Specifies the name or subject of the conversation.
string
required
Meeting start timestamp in ISO 8601 format (e.g., ‘2026-02-17T10:00:00Z’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_DELETE_A_MEETINGDelete or cancel a Zoom meeting, with optional cancellation notifications for hosts and registrants. For recurring meetings, specify an occurrence to delete just that occurrence; otherwise the entire series is deleted; the result includes a success flag and available error details.

Input Parameters

string
required
The meeting ID or meeting UUID to delete/cancel. When storing this value in your database, store it as a long format integer and not an integer. Meeting IDs can be more than 10 digits.
string
The meeting occurrence ID to delete a specific occurrence of a recurring meeting. If provided, only that occurrence will be deleted. If not provided and the meeting is recurring, all occurrences will be deleted.
boolean
Whether to send a notification to the host and alternative hosts about the meeting cancellation. Set to true to notify the meeting host and alternative hosts.
boolean
Whether to send a cancellation notification to meeting registrants. Set to true to notify all registrants that the meeting has been cancelled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_DELETE_IQ_CONVERSATIONDeletes a Zoom IQ conversation by ID. This deprecated action returns a structured success indicator and message after a successful HTTP response.

Input Parameters

string
required
The conversation ID to delete. This is the unique identifier for the Zoom IQ conversation that you want to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_DELETE_IQ_CONVERSATION_COMMENTDEPRECATED: Use ZOOM_DELETE_ZRA_CONVERSATION_COMMENT instead (Zoom rebranded IQ to ZRA). Tool to delete a comment from a Zoom IQ (Revenue Accelerator) conversation. Use when you need to remove a specific comment from a conversation. The endpoint uses idempotent DELETE behavior, returning success regardless of whether the comment exists.

Input Parameters

string
required
The comment’s unique identifier within that conversation.
string
required
The conversation’s unique identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_DELETE_IQ_DEAL_ACTIVITIESDEPRECATED: Use ZOOM_DELETE_ZRA_DEAL_ACTIVITIES instead (Zoom rebranded IQ to ZRA). Tool to delete activities associated with a Zoom IQ deal. Use when you need to remove activity records from a specific deal. Can delete all activities or specific ones by providing activity IDs.

Input Parameters

string
required
The unique identifier of the deal whose activities should be deleted.
string
Comma-separated list of activity IDs to delete. If not provided, all activities for the deal will be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_DELETE_MEETING_RECORDINGSDelete all cloud recording files for a meeting or webinar, either moving them to trash by default or permanently deleting them. A meeting or webinar ID targets the latest instance; a UUID targets a specific instance.

Input Parameters

string ("trash" | "delete")
The delete action to perform: ‘trash’ (default) moves recordings to trash where they can be recovered; ‘delete’ permanently removes recordings and cannot be undone.
string
required
The meeting ID or meeting UUID whose cloud recordings you want to delete. If a numeric meeting ID is provided, recordings from the latest meeting instance are deleted. Also accepts webinar ID or UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_DELETE_PROJECTDeletes 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.

Input Parameters

string
required
The project ID of the whiteboard project to delete. Deleting a project removes all associated whiteboards from the project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_DELETE_PROJECT_COLLABORATORRemoves 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.

Input Parameters

string
required
The unique identifier of the whiteboard project.
string
required
The unique identifier of the collaborator to remove from the project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_DELETE_RECORDING_FILEDeletes a specific cloud recording file from a meeting or webinar, moving it to trash by default or permanently deleting it with the delete action. Cloud Recording must be enabled.

Input Parameters

string ("trash" | "delete")
The delete action to perform: ‘trash’ (default) moves the recording file to trash where it can be recovered; ‘delete’ permanently removes the recording file and cannot be undone.
string
required
The meeting ID or meeting UUID that contains the recording file you want to delete. If a numeric meeting ID is provided, the recording from the latest meeting instance is targeted. Also accepts webinar ID or UUID.
string
required
The unique identifier of the specific recording file to delete. This ID can be obtained from the Get Meeting Recordings endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_DELETE_WHITEBOARDDeletes 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.

Input Parameters

string
required
The ID of the whiteboard to delete. This is the unique identifier assigned to the whiteboard when it was created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_DELETE_WHITEBOARD_COLLABORATORRemoves 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

Input Parameters

string
required
The unique identifier of the whiteboard from which to remove the collaborator. This is the unique identifier assigned to the whiteboard when it was created.
string
required
The unique identifier of the collaborator to remove from the whiteboard. This is the email address or user ID of the collaborator.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_DELETE_ZRA_CONVERSATIONDeletes 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.

Input Parameters

string
required
The ZRA (Zoom Revenue Accelerator) conversation ID to delete. This is a unique identifier for the conversation in Zoom’s Revenue Accelerator system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_DELETE_ZRA_CONVERSATION_COMMENTTool to delete a comment from a Zoom Revenue Accelerator conversation. Use when you need to remove a specific comment from a ZRA conversation.

Input Parameters

string
required
The ID of the comment to delete from the conversation.
string
required
The ID of the Zoom Revenue Accelerator conversation containing the comment to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_DELETE_ZRA_CRM_SETTINGSDeletes CRM settings for Zoom Revenue Accelerator (ZRA). Use when you need to remove CRM configuration from the account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_DELETE_ZRA_DEAL_ACTIVITIESTool 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.

Input Parameters

string
required
The deal ID for which to delete activities. This is the unique identifier of the deal in Zoom Revenue Accelerator.
string
required
Comma-separated list of activity IDs to delete from the deal. For example: ‘activity-1,activity-2,activity-3’. All specified activities will be removed from the deal.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_DOWNLOAD_IMPORTED_WHITEBOARD_FILEDownloads a specific imported file from a Zoom whiteboard. If Zoom returns error code 34002, the response contains null content instead of a downloaded file.

Input Parameters

string
required
The unique identifier of the file to download. This is the file ID assigned when the file was imported into the whiteboard.
string
required
The unique identifier of the whiteboard from which to download the file. This is the whiteboard’s unique ID, not the session ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_DOWNLOAD_WHITEBOARD_EXPORTDownloads 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.

Input Parameters

string
required
The unique identifier of the whiteboard export task. Use the task_id returned from the Create whiteboard export API once the export task has completed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_DOWNLOAD_WHITEBOARD_SESSION_ACTIVITYDownloads a whiteboard session activity archive using its file path. A 404 response returns null content and the requested path, rather than a downloaded file.

Input Parameters

string
required
The file path to the activity archive file. Obtain this path from the ‘List whiteboard sessions activities’ endpoint in the download_url field of each activity record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_GET_A_MEETINGRetrieve details of a Zoom meeting by ID, including its topic, schedule, URLs, passwords, settings, and recurring meeting information. Optionally request a specific occurrence or include previous occurrences.

Input Parameters

string
required
The meeting’s ID. When storing this value in your database, store it as a long format integer and not an integer. Meeting IDs can be more than 10 digits. UUID-style meeting IDs containing a leading ’/’ or ’//’ must be double-URL-encoded before use.
string
Meeting occurrence ID. Provide this field to view meeting details of a particular occurrence of the recurring meeting.
boolean
Set this field’s value to true to view meeting details of all previous occurrences of a recurring meeting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_GET_A_MEETING_SUMMARYRetrieves an AI-generated meeting or webinar summary by instance UUID, including summary content when available. The host needs a paid plan and the appropriate AI Companion summary setting; end-to-end encrypted meetings do not support summaries.

Input Parameters

string
required
The meeting’s past instance UUID (e.g. ‘aDYlohsHRtCd4ii1uC2+hA==’). This endpoint only accepts instance UUIDs from list_past_meeting_instances or past_meetings — the definition UUID from list_meetings will NOT work.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_GET_A_WEBINARAccess 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.

Input Parameters

string
required
The webinar’s ID or universally unique ID (UUID).
string
Unique identifier for an occurrence of a recurring webinar. Recurring webinars can have a maximum of 50 occurrences. When you create a recurring Webinar using Create a webinar API, you can retrieve the Occurrence ID from the response of the API call.
boolean
Set the value of this field to true if you would like to view Webinar details of all previous occurrences of a recurring Webinar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_GET_DAILY_USAGE_REPORTThe 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.

Input Parameters

integer
Year for this report. Defaults to the current year if not provided.
integer
Month for this report (1-12). Defaults to the current month if not provided.
string
The group ID to filter results. Use the List groups API to retrieve group IDs. When specified, the response only includes users who are members of the queried group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_GET_IQ_CONVERSATION_COMMENTSDEPRECATED: Use ZOOM_GET_ZRA_CONVERSATION_COMMENTS instead (Zoom rebranded IQ to ZRA). Tool to retrieve all comments for a specific Zoom IQ conversation. Use when you need to access comments, replies, and discussion threads within a conversation. Returns comment content, timestamps, user information, and mentions. Supports pagination for large comment sets.

Input Parameters

integer
Number of records per API call. Default is 30.
string
required
The conversation’s ID. If the ID begins with a / character or contains // characters, you must double encode the ID value.
string
For pagination through large result sets with 15-minute expiration. Use this token to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_GET_IQ_CONVERSATION_CONTENT_ANALYSISTool 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.

Input Parameters

string
required
The conversation ID to analyze. This identifies the specific conversation for which content analysis is requested.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_GET_IQ_CONVERSATION_INTERACTIONSDEPRECATED: Use ZOOM_GET_ZRA_CONVERSATION_INTERACTIONS instead (Zoom rebranded IQ to ZRA). Tool to retrieve interactions for a specific Zoom IQ (Revenue Accelerator) conversation. Use when you need to fetch conversation interaction data, including participant interactions and transcript details. Supports pagination for large result sets.

Input Parameters

string
required
The unique identifier of the conversation for which to retrieve interactions.
integer
The number of records to return per page. Default is 30.
string
Token to retrieve the next page of results. Use the token returned in the previous response to paginate through large result sets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_GET_IQ_CONVERSATION_SCORECARDSDEPRECATED: Use ZOOM_GET_ZRA_CONVERSATION_SCORECARDS instead (Zoom rebranded IQ to ZRA). Tool to retrieve scorecards for a specific Zoom IQ conversation by conversation ID. Use when you need to access scorecard data associated with a conversation. Note: There is a known issue where the API may return an empty scorecards list even when scorecards exist in the UI.

Input Parameters

string
required
The conversation ID to retrieve scorecards for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_GET_IQ_DEALTool 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.

Input Parameters

string
required
The unique identifier of the deal to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_GET_IQ_DEAL_ACTIVITIESDEPRECATED: Use ZOOM_GET_ZRA_DEAL_ACTIVITIES instead (Zoom rebranded IQ to ZRA). Tool to retrieve activities associated with a Zoom Revenue Accelerator (formerly Zoom IQ) deal. Use when you need to list all activities for a specific deal.

Input Parameters

string
required
The unique identifier of the deal whose activities to retrieve.
integer
Number of records to return per page. Default is 30, maximum is 100.
string
Token for pagination to fetch the next page of results. Use the token returned in the previous response to get the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_GET_IQ_USER_CONVERSATIONS_PLAYLISTSDEPRECATED: Use ZOOM_LIST_ZRA_USER_CONVERSATION_PLAYLISTS instead (Zoom rebranded IQ to ZRA). Tool to retrieve conversation playlists for a Zoom IQ (Revenue Accelerator) user. Returns playlist information or an empty response when no playlists exist.

Input Parameters

string
required
The user ID for which to retrieve conversation playlists. Use ‘me’ to get playlists for the authenticated user.
integer
Number of records to return per page. Maximum 300.
string
Token for fetching the next page of results. Obtained from the previous response’s next_page_token field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_GET_MARKETPLACE_USER_APPSRetrieves 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.

Input Parameters

string
required
The user ID. Can be retrieved using GET /users/me or GET /users endpoints.
integer
Number of records returned per page.
string
Token for retrieving the next page of results. Use the token returned from the previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_GET_MARKETPLACE_USER_ENTITLEMENTSRetrieves 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.

Input Parameters

string
required
The user ID or email address of the user. For user-level apps, pass the me value to fetch the authenticated user’s entitlements.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_GET_MEETING_RECORDINGSRetrieve cloud recording metadata for a meeting or webinar by ID or UUID; an ID selects the latest instance. The result can include download URLs and, on request, a download access token. A not-found response is reported as an empty recordings list, including when the user is not found.

Input Parameters

integer
The download_access_token Time to Live (TTL) value. This parameter is only valid if the include_fields query parameter contains the download_access_token value.
string
required
To get a meeting’s cloud recordings, provide the meeting ID or UUID. If providing the meeting ID instead of UUID, the response will be for the latest meeting instance. To get a webinar’s cloud recordings, provide the webinar’s ID or UUID. If providing the webinar ID instead of UUID, the response will be for the latest webinar instance.
string
Set to ‘download_access_token’ to include a JWT token for downloading the meeting’s recordings. This token can be appended to download URLs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_GET_PAST_MEETING_PARTICIPANTSRetrieve participants in a past Zoom meeting within the last 15 months, using a meeting ID for the latest instance or a UUID for a specific instance. A paid Pro or higher account is required; one-person meetings are excluded by default unless the relevant account setting is enabled.

Input Parameters

integer
The number of records returned within a single API call.
string
required
The meeting’s numeric ID or instance UUID. If you provide a numeric meeting ID, the API returns participants for the latest meeting instance. If you provide a UUID, it must be an instance UUID (from list_past_meeting_instances), not the series UUID from list_meetings.
string
Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token’s expiration period is 15 minutes. Exhaust all pages by repeatedly calling with the returned token until it is absent; stopping early silently omits remaining participants.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_GET_PROJECTRetrieve a Zoom Whiteboard project by ID, returning its name and available owner, timestamp, starred and collaborator information.

Input Parameters

string
required
The unique identifier of the whiteboard project to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_GET_USERRetrieves 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.

Input Parameters

string
required
The user ID or email address of the user. For user-level apps, pass the me value to fetch the authenticated user.
integer
The user’s login method: 0 - Facebook OAuth, 1 - Google OAuth, 24 - Apple OAuth, 27 - Microsoft OAuth, 97 - Mobile device, 98 - RingCentral OAuth, 99 - API user, 100 - Zoom Work email, 101 - Single Sign-On (SSO). The following login methods are only available in China: 11 - Phone number, 21 - WeChat, 23 - Alipay.
boolean
Whether the email address in the response should be encrypted. Set to true to encrypt the email in the response.
boolean
Whether to search for the user by their unique ID (UID). Set to true to search by the user’s unique ID instead of their user ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_GET_WHITEBOARDRetrieves 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.

Input Parameters

string
required
The unique identifier of the whiteboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_GET_WHITEBOARD_EXPORT_STATUSRetrieves 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.

Input Parameters

string
required
The unique identifier of the whiteboard export task. This ID is returned when you create a whiteboard export. Example: adcc655d3a3549e692959737fe2a7a0d

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_GET_WHITEBOARD_SESSIONRetrieves 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.

Input Parameters

integer
The number of records returned within a single API call. If not specified, defaults to 30. Maximum value is 300.
string
required
The session unique ID. You can get this ID from the session list API or from webhook payloads when sessions are created or updated.
string
The next page token is used to paginate through a large set of results. Provided in the response when there are more records available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_GET_ZRA_CONVERSATION_COMMENTSTool 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.

Input Parameters

string
required
The conversation identifier for which to retrieve comments.
integer
Number of records to return per API call. Maximum value is 300, default is 30.
string
Token for pagination to retrieve the next page of results. This token expires after 15 minutes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_GET_ZRA_CONVERSATION_INTERACTIONSRetrieves 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.

Input Parameters

string
required
The conversation ID for which to retrieve interactions. This ID can be obtained from the list conversations endpoint. Note: If the conversation ID contains special characters like ’+’, ensure proper URL encoding.
integer
Number of records to return per page. Maximum 300.
string
Token for fetching the next page of results. Obtained from the previous response’s next_page_token field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_GET_ZRA_CONVERSATION_SCORECARDSTool 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.

Input Parameters

string
required
Conversation ID for which to retrieve scorecards. Obtain this ID from the list_zra_conversations action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_GET_ZRA_DEAL_ACTIVITIESTool 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.

Input Parameters

string
required
The unique identifier of the deal whose activities to retrieve.
integer
Number of records to return per page. Default is 30, maximum is 100.
string
Token for pagination to fetch the next page of results. Use the token returned in the previous response to get the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_IMPORT_WHITEBOARDInitiates 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.

Input Parameters

integer ("1" | "2" | "3")
required
The original file format of the file being imported. Use 1 for Miro boards, 2 for Microsoft Visio files, or 3 for Mural workspaces.
string
required
The ID of the file to convert to a whiteboard. This file must have been previously uploaded to Zoom.
string
The ID of the project to add the whiteboard to. The whiteboard will be organized under this project in Zoom.
string
The email address of the user who should be set as the whiteboard owner. Only usable with admin-level scopes.
array
List of users or team chat channels to add as collaborators on the whiteboard. Each entry should contain an email address.
string
The name to assign to the newly created whiteboard.
boolean
If set to true, collaborators will not receive email notifications when the whiteboard is shared with them.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_ALL_RECORDINGSThis 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.

Input Parameters

string
The query metadata of the recording if using an on-premise meeting connector for the meeting.
string
The end date in “yyyy-mm-dd” UTC format. Maximum date range from start is 1 month. If no value is provided, defaults to the day after the ‘from’ date.
string
The start date in “yyyy-mm-dd” UTC format. Maximum date range is 1 month - if a larger range is requested, the API will adjust the ‘from’ date to be 1 month before the ‘to’ date. If no value is provided, defaults to current date. Note: trash files cannot be filtered by date range.
boolean
The query trash. * true - List recordings from trash. * false - Do not list recordings from the trash. The default value is false. If you set it to true, you can use the trash_type property to indicate the type of Cloud recording that you need to retrieve.
string
required
The user’s ID or email address. For user-level apps, pass the me value. Using another user’s ID instead of me requires admin-level permissions.
integer
The number of records returned within a single API call.
integer
The meeting ID.
string
The type of cloud recording to retrieve from the trash. * meeting_recordings: List all meeting recordings from the trash. * recording_file: List all individual recording files from the trash.
string
The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. Loop calls until next_page_token is empty to retrieve all records; results are silently truncated at page_size per call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_ARCHIVED_FILESLists 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.

Input Parameters

string
The query end date, in yyyy-MM-dd"T"HH:mm:ssZ format. This value and the from query parameter value cannot exceed seven days.
string
The query start date, in yyyy-MM-dd"T"HH:mm:ssZ format. This value and the to query parameter value cannot exceed seven days.
string
The group ID. To get a group ID, use the List groups API.
integer
The number of records returned within a single API call.
string
Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token’s expiration period is 15 minutes.
string ("meeting_start_time" | "archive_complete_time")
The type of query date. * meeting_start_time * archive_complete_time This value defaults to meeting_start_time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_DEVICESLists devices in a Zoom account, including Zoom Room computers, controllers, scheduling displays, and whiteboards. Results can be filtered by enrollment, device type, and other device attributes; Zoom defaults to ZDM-enrolled devices when the enrollment filter is omitted.

Input Parameters

integer
The number of records returned within a single API call.
integer
Filter devices by device type. Device Type: -1 - All Zoom Room devices, 0 - Zoom Rooms Computer, 1 - Zoom Rooms Controller, 2 - Zoom Rooms Scheduling Display, 3 - Zoom Rooms Control System, 4 - Zoom Rooms Whiteboard, 5 - Zoom Phone Appliance, 6 - Zoom Rooms Computer (with Controller). Leave empty to include all device types.
string ("win" | "mac" | "ipad" | "iphone" | "android" | "linux")
Filter devices by platform operating system.
string
Filter devices by name or serial number.
string
Filter devices by model.
integer
Filter devices by status. Device Status: 0 - offline, 1 - online, -1 - unlinked. Leave empty to include all devices regardless of status.
string
Filter devices by vendor.
string
Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token’s expiration period is 15 minutes.
boolean
Filter devices by enrollment in Zoom Device Management (ZDM). Set to true to show only ZDM-enrolled devices, false to show only non-enrolled devices, or leave empty to include all devices.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_IQ_CONVERSATIONSDEPRECATED: Use ZOOM_LIST_ZRA_CONVERSATIONS instead (Zoom rebranded IQ to ZRA). Tool to list Zoom Revenue Accelerator (formerly Zoom IQ) conversations. Use when you need to retrieve conversation metadata including meeting and phone conversations from Zoom Revenue Accelerator.

Input Parameters

integer
Number of records to return per page. Default is 30, maximum is 100.
string
Token for pagination to fetch the next page of results. Use the token returned in the previous response to get the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_IQ_DEALSDEPRECATED: Use ZOOM_LIST_ZRA_DEALS instead (Zoom rebranded IQ to ZRA). Tool to list deals from Zoom Revenue Accelerator (IQ). Returns deal information including name, amount, stage, and owner details. Use when you need to retrieve CRM deal data from Zoom IQ.

Input Parameters

integer
The number of records returned within a single API call. Maximum 300, default 30.
string
Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_MARKETPLACE_APP_CUSTOM_FIELDSTool to retrieve custom fields configured for a Zoom Marketplace app. Use when you need to list all custom fields available for the marketplace app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_MEETING_NOTESLists My Notes documents associated with a Zoom meeting.

Input Parameters

string
required
Meeting ID whose associated My Notes documents to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_MEETINGSThis 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.

Input Parameters

string
The end date.
string
The start date.
string ("scheduled" | "live" | "upcoming" | "upcoming_meetings" | "previous_meetings")
The type of meeting. * scheduled - All valid previous (unexpired) meetings, live meetings, and upcoming scheduled meetings. * live - All the ongoing meetings. * upcoming - All upcoming meetings, including live meetings. * upcoming_meetings - All upcoming meetings, including live meetings. * previous_meetings - All the previous meetings.
string
required
The user’s user ID or email address. For user-level apps, pass the me value.
string
The timezone to assign to the from and to value. For a list of supported timezones and their formats, see our timezone list.
integer
The number of records returned within a single API call.
integer
The page number of the current page in the returned records.
string
Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token’s expiration period is 15 minutes. Iterate until next_page_token is empty/null to avoid missing meetings. Do not introduce long delays between paginated requests as the token expires after 15 minutes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_MEETING_SUMMARY_TEMPLATESTool 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.

Input Parameters

string
required
The user ID or email address of the user. Use ‘me’ for the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_PAST_MEETING_INSTANCESList UUIDs for ended instances of a meeting, including recurring meeting occurrences. Zoom does not return instances from meetings more than 15 months old.

Input Parameters

string
required
The meeting’s numeric ID (e.g. ‘83767991819’). This endpoint only accepts numeric meeting IDs, not UUIDs. Use the numeric meeting ID to retrieve the list of all past instance UUIDs for a recurring meeting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_PROJECT_COLLABORATORSLists 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).

Input Parameters

integer
Number of collaborators to return per page. Maximum: 300.
string
required
The unique identifier of the whiteboard project.
string
Token to retrieve the next page of results. Use this from previous response’s next_page_token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_PROJECTSLists 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.

Input Parameters

string
The email address or user ID of the project owner. Use ‘me’ to refer to the current user.
integer
The number of records returned from a single API call. The maximum value is 50. If not specified, defaults to 10.
string
The name of a project to search for. This filters results to projects whose names contain the specified value.
string
The next page token for pagination. Use this value when paginating through large result sets. The token expires after 15 minutes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_TASKSLists tasks assigned to or created by the current user. Zoom defaults to tasks with status To do when no status filter is provided.

Input Parameters

string ("To do" | "In progress" | "Done" | "Blocked" | "Recommended")
Filter tasks by their current status.
boolean
Filter to tasks that are unread for the current user.
string ("update_time" | "create_time" | "due_date" | "status" | "priority")
Task field used to sort the results.
boolean
Filter tasks by whether the current user starred them.
boolean
Whether to sort results in ascending order. The provider default depends on sort_by.
integer
The number of task records returned in one API call, from 1 to 50.
string
Search keyword, up to 50 characters, matched against task titles and descriptions.
string ("user" | "aic_meeting_summary" | "whiteboard" | "notes" | "docs" | "phone" | "chat" | "email" | "meeting" | "aic")
Filter tasks by the source that created them.
string
Inclusive due-date upper bound in YYYY-MM-DD format.
string
Filter tasks by assignee email address.
string
Inclusive due-date lower bound in YYYY-MM-DD format.
string
Continuation token from the previous response. The token expires after 15 minutes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_USERS_COLLABORATION_DEVICESTool 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.

Input Parameters

string
required
The user ID or email address of the user. For user-level apps, pass the me value to fetch the authenticated user’s collaboration devices.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_USERS_SETTINGSTool 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.

Input Parameters

string ("meeting_authentication" | "recording_authentication" | "security" | "meeting_security" | "schedule_meeting" | "in_meeting" | "email_notification" | "recording" | "telephony" | "feature" | "tsp" | "profile" | "audio_conferencing")
Options for filtering the response fields
string
required
The user ID or email address of the user. For user-level apps, pass the ‘me’ value to fetch the authenticated user’s settings.
integer
The user’s login method. Use this parameter to filter settings for users with a specific login type: 0 - Facebook OAuth, 1 - Google OAuth, 24 - Apple OAuth, 27 - Microsoft OAuth, 97 - Mobile device, 98 - RingCentral OAuth, 99 - API user, 100 - Zoom Work email, 101 - Single Sign-On (SSO).
string
Comma-separated list of custom field names to include in the response. Use this to request specific custom attributes for the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_WEBINAR_PARTICIPANTSGet 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.

Input Parameters

integer
The number of records returned within a single API call.
string
required
The webinar’s ID or universally unique ID (UUID). If you provide a webinar ID, the API returns a response for the latest webinar instance.
string
Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token’s expiration period is 15 minutes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_WEBINAR_REGISTRANTSLists webinar registrants with optional occurrence, status, and tracking-source filters. Results are paginated and default to approved registrants when status is omitted.

Input Parameters

string ("approved" | "pending" | "denied")
Status filter for webinar registrants
integer
The number of records returned within a single API call. Maximum is 300.
string
required
The webinar’s ID or universally unique ID (UUID). When storing this value in your database, store it as a long format integer.
string
The webinar occurrence ID for which to list registrants. Use this to filter registrants for a specific occurrence of a recurring webinar.
string
Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token’s expiration period is 15 minutes.
string
Filter registrants by tracking source ID. Use this to get registrants attributed to a specific campaign or source.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_WEBINARSThe 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.

Input Parameters

string ("scheduled" | "upcoming")
The type of webinar. * scheduled - All valid previous (unexpired) webinars, live webinars, and upcoming scheduled webinars. * upcoming - All upcoming webinars, including live webinars.
string
required
The user’s user ID or email address. For user-level apps, pass the me value.
integer
The number of records returned within a single API call.
integer
Deprecated We will no longer support this field in a future release. Instead, use the next_page_token for pagination.
string
Token for fetching the next page of results. Received from the previous response’s next_page_token field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_WHITEBOARDSLists 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.

Input Parameters

string
The queried end date and time in UTC format. Use ‘yyyy-MM-dd’T’HH:mm:ss’Z” format, for example: ‘2024-12-31T23:59:59Z’.
string
The queried start date and time in UTC format. Use ‘yyyy-MM-dd’T’HH:mm:ss’Z” format, for example: ‘2024-01-01T00:00:00Z’.
string
The email address or user ID of the whiteboard owner. Use ‘me’ to refer to the current user.
integer
The number of records returned from a single API call. The maximum value is 50. If not specified, defaults to 10.
string
Filter whiteboards by project ID. Only returns whiteboards that belong to the specified project.
string
Search for whiteboards by name. This filters results to whiteboards whose names contain the specified value.
string
The next page token for pagination. Use this value when paginating through large result sets. The token expires after 15 minutes.
string ("created_date" | "modified_date")
Date filter type for whiteboard listing

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_ZRA_CONVERSATIONSTool 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.

Input Parameters

string
End date for filtering conversations in ISO 8601 format (e.g., ‘2024-01-31T23:59:59Z’). Use with ‘from’ parameter to define a date range.
string
Start date for filtering conversations in ISO 8601 format (e.g., ‘2024-01-01T00:00:00Z’). Use with ‘to’ parameter to define a date range.
string
Filter conversations by deal ID. Use this to see conversations linked to a specific deal.
string
Filter conversations by host ID. Use this to see only conversations hosted by a specific user.
string
Filter conversations by team ID. Use this to see conversations associated with a specific team.
integer
Number of records to return per page. Maximum 300.
string ("meetingStartTime" | "iqProcessedTime")
Period type for filtering conversations
string
Filter conversations by participant ID. Use this to find conversations involving a specific participant.
string
Token for fetching the next page of results. Obtained from the previous response’s next_page_token field. This token expires in 15 minutes.
string ("all" | "meeting" | "phone")
Conversation type filter

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_ZRA_CRM_ACCOUNTSLists 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).

Input Parameters

string
required
Comma-separated list of CRM account IDs, up to a maximum of 100 IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_ZRA_CRM_CONTACTSTool 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.

Input Parameters

string
required
Comma-separated list of CRM contact IDs to retrieve. Maximum of 100 IDs per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_ZRA_CRM_DEALSTool 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.

Input Parameters

string
required
Comma-separated list of CRM deal IDs to retrieve. Maximum of 100 IDs per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_ZRA_CRM_LEADSTool 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.

Input Parameters

string
required
Comma-separated list of CRM lead IDs to retrieve. Maximum of 100 IDs per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_ZRA_CRM_SETTINGSTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_ZRA_DEALSTool 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.

Input Parameters

integer
The number of records returned within a single API call. Maximum 300, default 30.
string
Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_ZRA_SCHEDULEDTool 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.

Input Parameters

integer
Number of records to return per page. Use this to control pagination.
string
Token for fetching the next page of results. Obtained from the previous response’s next_page_token field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_ZRA_SETTINGS_INDICATORSTool 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.

Input Parameters

string ("basic" | "advanced" | "guiding_sentences")
Type of indicator to filter by
integer
Number of records to return per API call. Must be between 1 and 300
string
Filter indicators by category ID to show only indicators belonging to a specific category
string
Token for retrieving the next page of results. This token expires after 15 minutes

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_LIST_ZRA_USER_CONVERSATION_PLAYLISTSTool 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.

Input Parameters

string
required
The user ID to retrieve playlists for. Use ‘me’ to refer to the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_MOVE_WHITEBOARDS_TO_PROJECTMove one or more whiteboards into a specified Zoom Whiteboard project to organize them. A request can include up to 50 whiteboard IDs.

Input Parameters

string
required
The Project ID. This is a path parameter identifying the target project.
array
required
List of whiteboard IDs to move to the specified project. Maximum 50 whiteboards per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_REMOVE_WHITEBOARD_CLASSIFICATIONRemoves 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.

Input Parameters

string
required
The whiteboard’s unique identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_REMOVE_WHITEBOARDS_FROM_PROJECTRemoves 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.

Input Parameters

string
required
The project ID from which to remove the whiteboards.
array
required
The list of whiteboard IDs to remove from the project. Maximum of 50 IDs allowed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_SEARCH_COMPANY_CONTACTSTool 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.

Input Parameters

integer
The number of records to be returned with a single API call. Default value is 30, maximum is 50.
string
required
Provide the keyword - either first name, last name or email of the contact whom you have to search for.
string
The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
boolean
Set query_presence_status to true in order to include the presence status of a contact in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_UPDATE_A_MEETINGUpdates a Zoom meeting or a specified occurrence. The request also sends default meeting type, recurrence and settings values when omitted, which can affect existing configuration.

Input Parameters

integer
Meeting types. 1 - Instant meeting. 2 - Scheduled meeting. 3 - Recurring meeting with no fixed time. 8 - Recurring meeting with a fixed time.
string
Meeting topic.
string
Meeting description.
integer
Meeting duration in minutes. Used for scheduled meetings only.
string
Meeting passcode. Passcodes may only contain these characters [a-z A-Z 0-9 @ - _ *] and can have a maximum of 10 characters. Note If the account owner or the admin has configured minimum passcode requirement settings, the passcode value provided here must meet those requirements. If the requirements are enabled, view those requirements by calling either the Get user settings API or the Get account settings API.
string
The timezone to assign to the start_time value. Only use this field ifor scheduled or recurring meetings with a fixed time. For a list of supported timezones and their formats, see our timezone list.
integer
required
The meeting’s ID. When storing this value in your database, store it as a long format integer and not an integer. Meeting IDs can be greater than 10 digits.
string
Meeting start time. When using a format like yyyy-MM-dd"T"HH:mm:ss"Z", always use GMT time. When using a format like yyyy-MM-dd"T"HH:mm:ss, use local time and specify the time zone. Only used for scheduled meetings and recurring meetings with a fixed time.
string
Unique identifier of the meeting template. Schedule the meeting from a meeting template. Retrieve this field’s value by calling the List meeting templates API.
boolean
Whether to create a prescheduled meeting through the GSuite app. This only supports the meeting type value of 2 - scheduled meetings- and 3 - recurring meetings with no fixed time. * true - Create a prescheduled meeting. * false - Create a regular meeting.
string
The email address or userId of the user to schedule a meeting for.
string
Meeting occurrence ID. Support change of agenda, start_time, duration, or settings {host_video, participant_video, join_before_host, mute_upon_entry, waiting_room, watermark, auto_recording}. Omitting this field applies changes to the entire recurring series.
string ("both" | "telephony" | "voip" | "thirdParty")
Determine how participants can join the audio portion of the meeting. both - Both Telephony and VoIP. telephony - Telephony only. voip - VoIP only. thirdParty - Third party audio conference.
array
Tracking fields.
integer
Recurrence meeting types. Required when meeting type is 3 (recurring with no fixed time) or 8 (recurring with fixed time). 1 - Daily. 2 - Weekly. 3 - Monthly.
boolean
Use a personal meeting ID (PMI). Only used for scheduled meetings and recurring meetings with no fixed time.
integer
If the value of join_before_host field is set to true, use this field to indicate time limits for a participant to join a meeting before a host. * 0 - Allow participant to join anytime. * 5 - Allow participant to join 5 minutes before meeting start time. * 10 - Allow participant to join 10 minutes before meeting start time.
array
The meeting’s resources. Each resource must include resource_id and resource_type fields.
boolean
Add a watermark when viewing a shared screen.
boolean
Host the meeting in China.
boolean
Whether the Focus Mode feature is enabled when the meeting starts.
boolean
Start video when the host joins the meeting.
boolean
Host meeting in India.
integer
Select how many times the meeting should recur before it is canceled. If end_times is set to 0, it means there is no end time. The maximum number of recurrences is 60. Cannot be used with end_date_time.
array
Custom keys and values assigned to the meeting.
string
Contact name for registration.
boolean
Enable waiting room.
integer
Use this field only if you’re scheduling a recurring meeting of type 3 to state the day in a month when the meeting should recur. The value range is from 1 to 31. For instance, if the meeting should recur on 23rd of each month, provide 23 as this field’s value and 1 as the repeat_interval field’s value. If the meeting should recur every three months on 23rd of the month, change the repeat_interval field’s value to 3.
string ("1" | "2" | "3" | "4" | "5" | "6" | "7")
This field is required if you’re scheduling a recurring meeting of type 2, to state which days of the week the meeting should repeat. The value must be a single number between 1 to 7 in string format. For instance, if the meeting should recur on Sunday, provide 1 as this field’s value. To set the meeting to occur on multiple days, you must call the API multiple times or use a different recurrence pattern. 1 - Sunday. 2 - Monday. 3 - Tuesday. 4 - Wednesday. 5 - Thursday. 6 - Friday. 7 - Saturday.
integer
Enable registration and set approval for the registration. Note that this feature requires the host to be of Licensed user type. Registration cannot be enabled for a basic user. 0 - Automatically approve. 1 - Manually approve. 2 - No registration required.
integer
The type of calendar integration used to schedule the meeting. * 1 - Zoom Outlook add-in * 2 - Zoom for Google Workspace add-on Works with the private_meeting field to determine whether to share details of meetings.
string
Contact email for registration.
boolean
Only signed in users can join this meeting. This field is deprecated and will not be supported in the future. As an alternative, use the meeting_authentication, authentication_option, and authentication_domains fields to understand the authentication configurations set for the meeting.
integer
Use this field only if you’re scheduling a recurring meeting of type 3 to state the week of the month when the meeting should recur. If you use this field, you must also use the monthly_week_day field to state the day of the week when the meeting should recur. -1 - Last week of the month. 1 - First week of the month. 2 - Second week of the month. 3 - Third week of the month. 4 - Fourth week of the month.
string ("local" | "cloud" | "none")
Automatic recording. local - Record on local. cloud - Record on cloud. none - Disabled.
string ("enhanced_encryption" | "e2ee")
Choose between enhanced encryption and end-to-end encryption when starting or a meeting. When using end-to-end encryption, several features such cloud recording and phone/SIP/H.323 dial-in, will be automatically disabled. enhanced_encryption - Enhanced encryption. Encryption is stored in the cloud if you enable this option. e2ee - End-to-end encryption. The encryption key is stored in your local device and can not be obtained by anyone else. Enabling this setting also disables the features join before host, cloud recording, streaming, live transcription, breakout rooms, polling, 1:1 private chat, and meeting reactions.
boolean
Whether the meeting is set as private.
string
Select the final date when the meeting recurs before it is canceled. Should be in UTC time, such as 2017-11-25T12:00:00Z. Cannot be used with end_times.
boolean
Whether to set the meeting as an internal meeting.
array
A list of the meeting’s invitees.
boolean
Mute participants upon entry.
integer
Define the interval when the meeting should recur. For instance, to schedule a meeting that recurs every two months, set this field’s value as 2 and the type parameter’s value to 3. For a daily meeting, the maximum interval is 90 days. For a weekly meeting, the maximum interval is 12 weeks. For a monthly meeting, the maximum value is 3 months.
string
A semicolon-separated list of the meeting’s alternative hosts” email addresses or IDs.
boolean
Allow participants to join the meeting before the host starts the meeting. Only used for scheduled or recurring meetings.
boolean
Start video when participants join the meeting.
integer
Registration type. Used for recurring meeting with fixed time only. 1 - Attendees register once and can attend any of the occurrences. 2 - Attendees need to register for each occurrence to attend. 3 - Attendees register once and can choose one or more occurrences to attend.
boolean
Close registration after the event date.
boolean
Whether to send email notifications to alternative hosts and users with scheduling privileges. This value defaults to true.
boolean
Show social share buttons on the meeting registration page. This setting only works for meetings that require registration.
integer
Use this field only if you”re scheduling a recurring meeting of type 3 to state a specific day in a week when a monthly meeting should recur. To use this field, you must also use the monthly_week field. 1 - Sunday. 2 - Monday. 3 - Tuesday. 4 - Wednesday. 5 - Thursday. 6 - Friday. 7 - Saturday.
string
Authentication name set in the authentication profile.
array
Create room(s).
string
Meeting authentication option ID.
boolean
Set this field’s value to true to enable the breakout room pre-assign option.
string
Third party audio conference info.
string
If user has configured Sign Into Zoom with Specified Domains option, this will list the domains that are authenticated.
string
Only signed in users with specified domains can join meetings. This field is deprecated and will not be supported in the future. As an alternative, use the meeting_authentication, authentication_option. and authentication_domains fields to understand the authentication configurations set for the meeting.
boolean
true- Only authenticated users can join meetings.
boolean
Allow attendees to join the meeting from multiple devices. This setting only works for meetings that require registration.
boolean
Whether the Allow host to save video order feature is enabled.
array
The participants added here will receive unique meeting invite links and bypass authentication. Each exception must include name and email fields.
array
Global dial-in countries or regions
array
List of global dial-in countries
boolean
Whether to automatically start meeting summary.
boolean
Whether to set the meeting as a participant focused meeting.
boolean
Whether the Allow alternative hosts to add or edit polls feature is enabled. This requires Zoom version 5.8.0 or higher.
boolean
Whether to enable language interpretation for the meeting.
boolean
Whether to send registrants an email confirmation. * true - Send a confirmation email. * false - Do not send a confirmation email.
boolean
Whether to send registrants email notifications about their registration approval, cancellation, or rejection. * true - Send an email notification. * false - Do not send an email notification. Set this value to true to also use the registrants_confirmation_email parameter.
boolean
Whether to enable the Enable continuous meeting chat setting.
array
List of countries or regions from where participants can not join this meeting.
boolean
Whether to automatically start AI Companion questions.
array
Information about the meeting’s language interpreters. Each interpreter must include email and languages fields.
boolean
Whether to enable sign language interpretation for the meeting.
boolean
Flag to determine whether to send email notifications to alternative hosts, default value is true.
array
List of countries or regions from where participants can join this meeting.
boolean
Whether to enable the Automatically add invited external users setting.
array
Information about the meeting’s sign language interpreters. Each interpreter must include email and sign_language fields.
boolean
true - Setting enabled to either allow users or block users from specific regions to join your meetings. false - Setting disabled.
string ("approve" | "deny")
Specify whether to allow users from specific regions to join this meeting, or block users from specific regions from joining this meeting. approve - Allow users from specific regions or countries to join this meeting. If this setting is selected, include the approved regions or countries in the approved_list. deny - Block users from specific regions or countries from joining this meeting. If this setting is selected, include the approved regions or countries in the denied_list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_UPDATE_CLASSIFICATION_LABELUpdates 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.

Input Parameters

string
The display name of the classification label. The name must be between 1 and 30 characters.
string
The hex color code for the label. Must be in the format: # followed by 6 hexadecimal characters (e.g., #FF5733).
boolean
Whether this label should be automatically applied to new whiteboards. Only one label can be the default. If setting this to true, ensure no other label is currently set as default.
string
A description of what this classification label represents. The description can have a maximum of 1000 characters.
string
An HTTPS URL linking to classification guidelines or policies. The URL must be a valid HTTPS URL with a maximum of 512 characters.
string
required
The unique identifier of the classification label to update. This ID is returned when you create or list classification labels.
integer
The sensitivity rank of the label. This value must be between 1 and 5, where higher values indicate higher sensitivity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_UPDATE_IQ_CONVERSATION_COMMENTDEPRECATED: Use ZOOM_UPDATE_ZRA_CONVERSATION_COMMENT instead (Zoom rebranded IQ to ZRA). Tool to update a comment in a Zoom IQ conversation. Use when you need to modify an existing comment’s text, mentions, or recording timestamp.

Input Parameters

string
The updated text content of the comment.
string
required
The comment’s unique identifier within that conversation.
string
required
The conversation’s unique identifier.
array
List of team IDs mentioned in the comment.
array
List of user IDs mentioned in the comment.
string
The time in the recording where the comment should be anchored.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_UPDATE_IQ_CONVERSATION_HOSTDEPRECATED: Use ZOOM_UPDATE_ZRA_CONVERSATION_HOST instead (Zoom rebranded IQ to ZRA). Tool to update the host of a Zoom IQ (Revenue Accelerator) conversation. Use when you need to transfer conversation ownership to a different user.

Input Parameters

string
required
The conversation’s unique identifier.
string
required
The email address or user ID of the new host for the conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_UPDATE_PROJECTUpdates 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.

Input Parameters

string
required
The unique identifier of the whiteboard project you want to update. This ID is returned when you create or list projects.
string
The new name for the whiteboard project. The name must be between 1 and 50 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_UPDATE_PROJECT_COLLABORATORSUpdates 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

Input Parameters

string
required
The unique identifier of the whiteboard project.
array
required
List of collaborators to update with their new roles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_UPDATE_WHITEBOARD_COLLABORATORUpdates 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.

Input Parameters

string
required
The unique identifier of the whiteboard. This is the unique identifier assigned to the whiteboard when it was created.
array
required
List of collaborators to update. Each collaborator must have a collaborator_id and a role. Minimum 1 collaborator, maximum 100 collaborators per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_UPDATE_WHITEBOARD_SHARE_SETTINGSUpdates 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.

Input Parameters

string
required
The ID of the whiteboard. This is the unique identifier assigned to the whiteboard when it was created.
Share link settings for the whiteboard.
object
Advanced share settings for the whiteboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_UPDATE_ZRA_CONVERSATION_COMMENTTool 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.

Input Parameters

string
The updated comment text. Provide this to change the comment content.
string
required
The ID of the comment to update within the conversation.
string
required
The ID of the Zoom Revenue Accelerator conversation containing the comment to update.
array
List of team IDs to mention in the updated comment.
array
List of user IDs to mention in the updated comment.
string
The timestamp in the recording to associate with this comment (format: HH:MM:SS).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_UPDATE_ZRA_CONVERSATION_HOSTTool to update the host of a Zoom Revenue Accelerator (ZRA) conversation. Use when you need to transfer conversation ownership to a different user.

Input Parameters

string
required
The conversation’s unique identifier.
string
required
The email address or user ID of the new host for the conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_UPLOAD_WHITEBOARD_FILEUploads 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).

Input Parameters

object
required
The file to upload to the whiteboard. Supported formats: .pdf, .vsdx (Visio). The file name should match the whiteboard file filename (for example, ‘document.pdf’ or ‘diagram.vsdx’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_VALIDATE_MARKETPLACE_APP_MANIFESTTool 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.

Input Parameters

string
Optional app ID to validate the manifest against an existing marketplace app. If provided, validates compatibility with the specified app.
object
required
The complete app manifest object to validate. Must include display_information, oauth_information, and features sections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not

Triggers

Slug: ZOOM_DAILY_USAGE_REPORT_CHANGED_TRIGGERType: pollTriggers when the Zoom daily usage report changes for a selected year/month. This trigger monitors daily usage statistics including:
  • New users added
  • Number of meetings held
  • Participant counts
  • Meeting minutes consumed

Configuration

string
Optional group ID to filter results. When specified, only includes users who are members of the queried group. Use the List groups API to retrieve group IDs.
number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
integer
Month for the report (1-12). If not provided, defaults to the current month.
integer
Year for the report. If not provided, defaults to the current year.

Payload

array
List of dates that had changes in their statistics
string
Type of change detected (report_updated)
object
required
Current state of the daily usage report
Slug: ZOOM_MEETING_DETAILS_CHANGED_TRIGGERType: pollTriggers when a specific meeting’s details change. Detects changes such as:
  • Meeting topic changes
  • Agenda updates
  • Schedule changes (timezone, duration)
  • Settings modifications (waiting room, recording, video, etc.)
  • Password changes
  • Recurrence pattern updates

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
integer
required
The meeting ID to monitor for details changes. Use the numeric meeting ID from your Zoom meeting.

Payload

array
List of field names that changed
string
required
Type of change detected (meeting_updated, settings_changed)
object
required
Current state of the meeting details
Slug: ZOOM_MEETING_RECORDING_CHANGED_TRIGGERType: pollTriggers when a specific meeting’s cloud recordings change. Detects changes such as:
  • New recording files appearing
  • Recording processing completion (status changes)
  • Recording metadata changes (count, size, etc.)
  • New participant audio files

Configuration

boolean
Whether to include download access token in the response. Set to True if you need to download recordings.
number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
The meeting ID or UUID to monitor for recording changes. Use the meeting ID for the latest instance or UUID for a specific instance.
integer
Time to live (in seconds) for the download access token. Only used when include_download_token is True.

Payload

object
Dictionary describing what changed (e.g., new files, status changes, metadata updates)
string
required
Type of change detected (recording_added, recording_updated, recording_processing_completed)
object
required
Current state of the meeting recording
Slug: ZOOM_MEETING_SUMMARY_UPDATED_TRIGGERType: pollTriggers when a meeting summary is created or updated for a specific meeting.IMPORTANT: This trigger requires a PAID Zoom account (Pro, Business, or Enterprise plan). Free Zoom accounts cannot use this feature.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

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
The unique ID of the meeting to monitor for summary changes. This is the meeting UUID or meeting ID from your Zoom account.

Payload

array
List of fields that changed (for updates)
string
required
Type of event that occurred (created/updated)
object
required
The meeting summary that was created or updated
Slug: ZOOM_NEW_CLOUD_RECORDING_TRIGGERType: pollTriggers when a new cloud recording meeting instance appears for a user.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
integer
Number of recordings to fetch per page (1-300)
string
The user’s ID or email address. Use ‘me’ for the authenticated user.

Payload

string
Type of event
object
required
The meeting with new cloud recording
Slug: ZOOM_NEW_MEETING_CREATED_TRIGGERType: pollTriggers when a new Zoom meeting is created for a user.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
Type of meetings to monitor: ‘scheduled’, ‘live’, ‘upcoming’, ‘upcoming_meetings’, or ‘previous_meetings’
integer
Number of meetings to fetch per page (1-300)
string
The user’s ID or email address. Use ‘me’ for the authenticated user.

Payload

string
Type of event that occurred
object
required
The newly created meeting
Slug: ZOOM_NEW_MEETING_PARTICIPANT_TRIGGERType: pollTriggers when a new participant appears in a past meeting’s participant report.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
required
The meeting’s ID or universally unique ID (UUID). If you provide a meeting ID, the API returns a response for the latest meeting instance. If you provide a meeting UUID that begins with a / character or contains the // characters, you must double encode the meeting UUID before making an API request.
integer
The number of participants to fetch per API call (max 300).

Payload

string
The customer key associated with the participant.
integer
Duration the participant was in the meeting, in seconds.
boolean
Whether failover occurred during the meeting for this participant.
string
Unique identifier for the participant in UUID format.
string
The date and time when the participant joined the meeting (ISO 8601 format).
string
The date and time when the participant left the meeting (ISO 8601 format).
string
Participant’s display name shown during the meeting.
string
The participant’s unique registrant ID if they registered for the meeting.
string
The participant’s attendance status: ‘in_meeting’ or ‘in_waiting_room’.
string
The participant’s email address. May be empty for external attendees.
string
The participant’s Zoom user ID. Empty for external participants not in your account.
Slug: ZOOM_NEW_WEBINAR_CREATED_TRIGGERType: pollTriggers when a new webinar is created for a user.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
integer
The number of webinars to fetch per API call (1-300).
string
The user’s user ID or email address. Use ‘me’ for user-level apps to monitor your own webinars.

Payload

string
Agenda or description of the webinar.
string
Timestamp when the webinar was created in date-time format (ISO 8601).
integer
Duration of the webinar in minutes.
string
User ID of the webinar host.
integer
Webinar ID, also known as the webinar number.
string
URL for participants to join the webinar.
array
Array of occurrence objects for recurring webinars.
object
Webinar settings object containing various configuration options.
string
Scheduled start time of the webinar in date-time format (ISO 8601).
string
URL for the host to start the webinar. Expiration time is two hours for regular users and 90 days for API users.
string
Timezone in which the webinar is scheduled.
string
Topic or title of the webinar.
integer
Webinar type. Values: 5 (Webinar), 6 (Recurring webinar with no fixed time), 9 (Recurring webinar with fixed time).
string
Unique identifier for the webinar instance.
Slug: ZOOM_NEW_WEBINAR_PARTICIPANT_TRIGGERType: pollTriggers when a new participant appears in a past webinar’s participant list.

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
integer
The number of participants to fetch per API call (max 300).
string
required
The webinar’s ID or universally unique ID (UUID). If you provide a webinar ID, the API returns a response for the latest webinar instance. If you provide a webinar UUID that begins with a / character or contains the // characters, you must double encode the webinar UUID before making an API request.

Payload

string
Participant’s attentiveness score. Can be an empty string or a percentage value.
string
Breakout room ID for participants in breakout rooms.
integer
Participant duration in seconds.
string
Participant UUID. Unique identifier for the participant.
string
The time at which the participant joined the webinar. ISO 8601 date-time format.
string
The time at which the participant left the webinar. ISO 8601 date-time format.
string
Participant display name.
string
The unique identifier for the registrant. Used to identify external participants.
string
Email address of the participant.
string
Participant ID. User ID of the participant if they are an authenticated Zoom user.
Slug: ZOOM_USER_INFORMATION_CHANGED_TRIGGERType: pollTriggers when a Zoom user’s information changes. Detects changes such as:
  • Profile information updates (name, email, display name)
  • Role or type changes
  • Department, job title, or location updates
  • Contact information changes (phone, timezone)
  • Status changes (active, inactive, pending)
  • Settings updates (language, pronouns, etc.)

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
integer
The user’s login method to filter by (e.g., 1 for Google OAuth, 100 for Zoom Work email).
string
required
The user ID or email address of the user to monitor. Use ‘me’ for the authenticated user.

Payload

object
Dictionary describing what changed (field names to old/new values)
string
required
Type of change detected (user_updated)
object
required
Current state of the user information
Slug: ZOOM_WEBINAR_DETAILS_CHANGED_TRIGGERType: pollTriggers 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

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
string
Unique identifier for an occurrence of a recurring webinar. Leave blank for non-recurring webinars.
boolean
Set to True to view webinar details of all previous occurrences of a recurring webinar.
string
required
The webinar’s ID or universally unique ID (UUID) to monitor for changes.

Payload

object
Dictionary describing what changed (field names to old/new values)
string
required
Type of change detected (webinar_updated)
object
required
Current state of the webinar details