# Zoom Zoom is a video conferencing and online meeting platform featuring breakout rooms, screen sharing, and integrations with various enterprise tools - **Category:** video conferencing - **Auth:** OAUTH2 - **Composio Managed App Available?** Yes - **Tools:** 73 - **Triggers:** 11 - **Slug:** `ZOOM` - **Version:** 20260316_00 ## Frequently Asked Questions ### How do I set up custom OAuth credentials for Zoom? 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](https://composio.dev/auth/zoom). ## Tools ### Add a meeting registrant **Slug:** `ZOOM_ADD_A_MEETING_REGISTRANT` Registers a participant for a Zoom meeting that has registration enabled. **Prerequisites:** - The meeting host must have a **licensed (paid) Zoom account** - this will NOT work with free/basic accounts - The meeting must have registration enabled (approval_type = 0 for automatic or 1 for manual approval) - Maximum of 4,999 registrants per meeting **Required fields:** meetingId, 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `org` | string | No | The registrant's organization. | | `zip` | string | No | The registrant's ZIP or postal code. | | `city` | string | No | The registrant's city. | | `email` | string | Yes | The registrant's email address. | | `phone` | string | No | The registrant's phone number. | | `state` | string | No | The registrant's state or province. | | `address` | string | No | The registrant's address. | | `country` | string | No | The registrant's two-letter [country code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). | | `comments` | string | No | The registrant's questions and comments. | | `industry` | string | No | The registrant's industry. | | `language` | 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") | No | 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 | | `job_title` | string | No | The registrant's job title. | | `last_name` | string | Yes | The registrant's last name. | | `meetingId` | integer | Yes | 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. | | `first_name` | string | Yes | The registrant's first name. | | `auto_approve` | boolean | No | 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). | | `occurrence_ids` | string | No | A comma-separated list of meeting occurrence IDs. You can get this value with the [Get a meeting](https://developers.zoom.us) API. | | `no_of_employees` | string ("" | "1-20" | "21-50" | "51-100" | "101-500" | "500-1,000" | "1,001-5,000" | "5,001-10,000" | "More than 10,000") | No | 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` | | `custom_questions` | array | No | Information about custom questions. | | `purchasing_time_frame` | string ("" | "Within a month" | "1-3 months" | "4-6 months" | "More than 6 months" | "No timeframe") | No | The registrant's purchasing time frame: * `Within a month` * `1-3 months` * `4-6 months` * `More than 6 months` * `No timeframe` | | `role_in_purchase_process` | string ("" | "Decision Maker" | "Evaluator/Recommender" | "Influencer" | "Not involved") | No | The registrant's role in the purchase process: * `Decision Maker` * `Evaluator/Recommender` * `Influencer` * `Not involved` | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add a webinar registrant **Slug:** `ZOOM_ADD_A_WEBINAR_REGISTRANT` Registers a participant for a Zoom webinar that has registration enabled. **Prerequisites:** - The webinar host must have a **Pro or higher plan with Webinar add-on** - this will NOT work with basic/free accounts - The webinar must have registration enabled (approval_type = 0 for automatic or 1 for manual approval) - Registration type must be properly configured (1=once for all, 2=each occurrence, 3=choose occurrences) **Required fields:** webinarId, first_name, email **Optional fields:** last_name, address, city, state, zip, country, phone, comments, industry, job_title, org, language, occurrence_ids, source_id **Common errors:** - "Webinar plan is missing" - The host needs a Zoom webinar license/add-on - "Registration has not been enabled" - Enable registration via webinar settings with approval_type = 0 or 1 - "Webinar not found" (404) - Invalid webinar ID or webinar has ended - "Host cannot register" - The webinar host cannot register themselves as an attendee #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `org` | string | No | The registrant's organization. | | `zip` | string | No | The registrant's ZIP or postal code. | | `city` | string | No | The registrant's city. | | `email` | string | Yes | The registrant's email address. | | `phone` | string | No | The registrant's phone number. | | `state` | string | No | The registrant's state or province. | | `address` | string | No | The registrant's address. | | `country` | string | No | The registrant's two-letter [country code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries). | | `comments` | string | No | The registrant's questions and comments. | | `industry` | string | No | The registrant's industry. | | `language` | 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") | No | 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 | | `job_title` | string | No | The registrant's job title. | | `last_name` | string | No | The registrant's last name. | | `source_id` | string | No | The tracking source's unique identifier. | | `webinarId` | integer | Yes | The webinar's ID. | | `first_name` | string | Yes | The registrant's first name. | | `occurrence_ids` | string | No | A comma-separated list of webinar occurrence IDs. Get this value with the [Get a webinar](https://developers.zoom.us) API. Make sure the `registration_type` is 3 if updating multiple occurrences with this API. | | `no_of_employees` | string ("" | "1-20" | "21-50" | "51-100" | "101-500" | "500-1,000" | "1,001-5,000" | "5,001-10,000" | "More than 10,000") | No | 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` | | `custom_questions` | array | No | Information about custom questions. | | `purchasing_time_frame` | string ("" | "Within a month" | "1-3 months" | "4-6 months" | "More than 6 months" | "No timeframe") | No | The registrant's purchasing time frame: * `Within a month` * `1-3 months` * `4-6 months` * `More than 6 months` * `No timeframe` | | `role_in_purchase_process` | string ("" | "Decision Maker" | "Evaluator/Recommender" | "Influencer" | "Not involved") | No | The registrant's role in the purchase process: * `Decision Maker` * `Evaluator/Recommender` * `Influencer` * `Not involved` | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a meeting **Slug:** `ZOOM_CREATE_A_MEETING` Enable Zoom meeting creation via user-level apps with "me". "Start_url" for hosts expires in 2 hours, or 90 days for "custCreate" users. Renew via API, capped at 100 requests/day. Requires "meeting:write" permission, subject to medium rate limit. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | integer | No | 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. | | `topic` | string | No | The meeting's topic. | | `agenda` | string | No | The meeting's agenda. This value has a maximum length of 2,000 characters. | | `userId` | string | No | The user's user ID or email address. For user-level apps, pass the `me` value. Defaults to `me` for user-level apps. | | `duration` | integer | No | The meeting's scheduled duration, in minutes. This field is only used for scheduled meetings (`2`). Ignored for all other meeting types. | | `password` | string | No | 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](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604), the passcode **must** meet those requirements. * If passcode requirements are enabled, use the [**Get user settings**](https://developers.zoom.us/docs/api-reference/zoom-api/methods#operation/userSettings) API or the [**Get account settings**](https://developers.zoom.us/docs/api-reference/zoom-api/ma#operation/accountSettings) API to get the requirements. | | `timezone` | string | No | 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](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones). Omitting this silently falls back to the account's timezone, which may shift meeting times for participants. | | `start_time` | string | No | 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](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones) 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. | | `template_id` | string | No | The account admin meeting template ID used to schedule a meeting using a [meeting template](https://support.zoom.us/hc/en-us/articles/360036559151-Meeting-templates). For a list of account admin-provided meeting templates, use the [**List meeting templates**](https://developers.zoom.us/docs/api-reference/zoom-api/methods#operation/listMeetingTemplates) API. * At this time, this field **only** accepts account admin meeting template IDs. * To enable the account admin meeting templates feature, [contact Zoom support](https://support.zoom.us/hc/en-us). | | `pre_schedule` | boolean | No | Whether to create a prescheduled meeting via the [GSuite app](https://support.zoom.us/hc/en-us/articles/360020187492-Zoom-for-GSuite-add-on). 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. | | `schedule_for` | string | No | The email address or user ID of the user to schedule a meeting for. | | `settings__audio` | string ("both" | "telephony" | "voip" | "thirdParty") | No | 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. | | `tracking_fields` | array | No | Information about the meeting's tracking fields. | | `default_password` | boolean | No | 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. | | `recurrence__type` | integer | No | Recurrence meeting types. `1` - Daily. `2` - Weekly. `3` - Monthly. | | `settings__use__pmi` | boolean | No | Whether to use a [Personal Meeting ID (PMI)](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#understanding-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`. | | `settings__jbh__time` | integer | No | 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. | | `settings__resources` | array | No | The meeting's resources. Each resource must include resource_id and resource_type fields. | | `settings__watermark` | boolean | No | Whether to add a watermark when viewing a shared screen. | | `settings__cn__meeting` | boolean | No | Whether to host the meeting in China (CN). This value defaults to `false`. | | `settings__focus__mode` | boolean | No | Whether to enable the [**Focus Mode** feature](https://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) when the meeting starts. | | `settings__host__video` | boolean | No | Whether to start meetings with the host video on. | | `settings__in__meeting` | boolean | No | Whether to host the meeting in India (IN). This value defaults to `false`. | | `recurrence__end__times` | integer | No | 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`. | | `settings__contact__name` | string | No | The contact name for meeting registration. | | `settings__waiting__room` | boolean | No | Whether to enable the [**Waiting Room** feature](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room). If this value is `true`, this **disables** the `join_before_host` setting. | | `recurrence__monthly__day` | integer | No | 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`. | | `recurrence__weekly__days` | string ("1" | "2" | "3" | "4" | "5" | "6" | "7") | No | 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. | | `settings__approval__type` | integer | No | Enable meeting registration approval. * `0` - Automatically approve registration. * `1` - Manually approve registration. * `2` - No registration required. This value defaults to `2`. | | `settings__contact__email` | string | No | The contact email address for meeting registration. | | `recurrence__monthly__week` | integer | No | 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. | | `settings__auto__recording` | string ("local" | "cloud" | "none") | No | 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`. | | `settings__encryption__type` | string ("enhanced_encryption" | "e2ee") | No | The type of [end-to-end (E2EE) encryption](https://support.zoom.us/hc/en-us/articles/360048660871) 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](https://support.zoom.us/hc/en-us/articles/360048660871), such as cloud recording or phone and SIP/H.323 dial-in, are **disabled**. | | `settings__private__meeting` | boolean | No | Whether to set the meeting as private. | | `recurrence__end__date__time` | string | No | 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`. | | `settings__internal__meeting` | boolean | No | Whether to set the meeting as an internal meeting. | | `settings__meeting__invitees` | array | No | A list of the meeting's invitees. | | `settings__mute__upon__entry` | boolean | No | Whether to mute participants upon entry. | | `recurrence__repeat__interval` | integer | No | 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. | | `settings__alternative__hosts` | string | No | A semicolon-separated list of the meeting's alternative hosts" email addresses or IDs. | | `settings__join__before__host` | boolean | No | 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](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) is enabled, this setting is **disabled**. | | `settings__participant__video` | boolean | No | Whether to start meetings with the participant video on. | | `settings__registration__type` | integer | No | 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`. | | `settings__close__registration` | boolean | No | Whether to close registration after the event date. This value defaults to `false`. | | `settings__email__notification` | boolean | No | Whether to send email notifications to [alternative hosts](https://support.zoom.us/hc/en-us/articles/208220166) and [users with scheduling privileges](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-privilege). This value defaults to `true`. | | `settings__show__share__button` | boolean | No | Whether to include social media sharing buttons on the meeting's registration page. This setting is only applied to meetings with registration enabled. | | `recurrence__monthly__week__day` | integer | No | 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. | | `settings__breakout__room__rooms` | array | No | Information about the breakout rooms. | | `settings__authentication__option` | string | No | 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**](https://developers.zoom.us/docs/api-reference/zoom-api/methods#operation/userSettings) API response. | | `settings__breakout__room__enable` | boolean | No | Whether to enable the [**Breakout Room pre-assign**](https://support.zoom.us/hc/en-us/articles/360032752671-Pre-assigning-participants-to-breakout-rooms) option. | | `settings__audio__conference__info` | string | No | Third party audio conference info. | | `settings__authentication__domains` | string | No | 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. | | `settings__meeting__authentication` | boolean | No | If true, only [authenticated](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) users can join the meeting. | | `settings__allow__multiple__devices` | boolean | No | Whether to allow attendees to join a meeting from multiple devices. This setting is only applied to meetings with registration enabled. | | `settings__host__save__video__order` | boolean | No | Whether the **Allow host to save video order** feature is enabled. | | `settings__authentication__exception` | array | No | 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. | | `settings__push__change__to__calendar` | boolean | No | 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. | | `settings__global__dial__in__countries` | array | No | A list of available global dial-in countries. | | `settings__auto__start__meeting__summary` | boolean | No | Whether to automatically start a meeting summary. | | `settings__participant__focused__meeting` | boolean | No | Whether to set the meeting as a participant focused meeting. | | `settings__alternative__host__update__polls` | boolean | No | Whether the **Allow alternative hosts to add or edit polls** feature is enabled. This requires Zoom version 5.8.0 or higher. | | `settings__language__interpretation__enable` | boolean | No | Whether to enable [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars) for the meeting. | | `settings__registrants__confirmation__email` | boolean | No | Whether to send registrants an email confirmation. * `true` - Send a confirmation email. * `false` - Do not send a confirmation email. | | `settings__registrants__email__notification` | boolean | No | 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. | | `settings__additional__data__center__regions` | array | No | Add additional meeting [data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars). Provide this value as an array of [country codes](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries) for the countries available as data center regions in the [**Account Profile**](https://zoom.us/account/setting) interface but have been opted out of in the [user settings](https://zoom.us/profile). For example, the data center regions selected in your [**Account Profile**](https://zoom.us/account) are `Europe`, `Hong Kong SAR`, `Australia`, `India`, `Japan`, `China`, `United States`, and `Canada`. However, in the [**My Profile**](https://zoom.us/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. | | `settings__continuous__meeting__chat__enable` | boolean | No | Whether to enable the **Enable continuous meeting chat** setting. | | `settings__approved_denied_regions__denied__list` | array | No | The list of blocked countries or regions. | | `settings__auto__start__ai__companion__questions` | boolean | No | Whether to automatically start AI Companion questions. | | `settings__language__interpretation__interpreters` | array | No | Information about the meeting's language interpreters. Each interpreter must include email and languages fields. | | `settings__sign__language__interpretation__enable` | boolean | No | Whether to enable [sign language interpretation](https://support.zoom.us/hc/en-us/articles/9644962487309-Using-sign-language-interpretation-in-a-meeting-or-webinar) for the meeting. | | `settings__alternative__hosts__email__notification` | boolean | No | Whether to send email notifications to alternative hosts. This value defaults to `true`. | | `settings__approved_denied_regions__approved__list` | array | No | The list of approved countries or regions. | | `settings__meeting__chat__auto__add__external__users` | boolean | No | Whether to enable the **Automatically add invited external users** setting. | | `settings__sign__language__interpretation__interpreters` | array | No | Information about the meeting's sign language interpreters. Each interpreter must include email and sign_language fields. | | `settings__approved__or__denied__countries__or__regions__enable` | boolean | No | Whether to enable the [**Approve or block entry for users from specific countries/regions**](https://support.zoom.us/hc/en-us/articles/360060086231-Approve-or-block-entry-for-users-from-specific-countries-regions) setting. | | `settings__approved__or__denied__countries__or__regions__method` | string ("approve" | "deny") | No | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create IQ conversation **Slug:** `ZOOM_CREATE_IQ_CONVERSATION` DEPRECATED: 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `topic` | string | No | Topic or title of the conversation. | | `host_id` | string | No | User ID of the conversation host. If not provided, defaults to the authenticated user. | | `duration` | integer | No | Duration of the conversation in seconds. | | `meeting_id` | string | No | Meeting ID to associate with this conversation. | | `start_time` | string | No | Conversation start time in ISO 8601 date-time format (e.g., 2024-01-15T10:30:00Z). | | `primary_language` | string | No | Primary language code for the conversation (e.g., 'en', 'es', 'fr'). | | `conversation_type` | string | No | Type of conversation (e.g., 'meeting', 'phone', 'external'). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create IQ conversation comment **Slug:** `ZOOM_CREATE_IQ_CONVERSATION_COMMENT` DEPRECATED: 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `comment` | string | Yes | The text content of the comment to add to the conversation. | | `is_private` | boolean | No | Whether the comment is private (visible only to specific users) or public (visible to all conversation participants). | | `conversationId` | string | Yes | The conversation's unique identifier. | | `mention_team_ids` | array | No | Array of team IDs to mention in the comment. Team members will be notified. | | `mention_user_ids` | array | No | Array of user IDs to mention in the comment. These users will be notified. | | `parent_comment_id` | string | No | Parent comment ID for threaded replies. Leave empty for top-level comments. | | `time_in_recording` | string | No | Timestamp in the recording where the comment should be anchored. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create IQ user conversation **Slug:** `ZOOM_CREATE_IQ_USER_CONVERSATION` DEPRECATED: 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | No | The user ID or email address of the user. Use 'me' to create a conversation for the authenticated user. Defaults to 'me'. | | `type` | string | No | The type of conversation (e.g., 'meeting', 'phone_call'). | | `topic` | string | No | The topic or title of the conversation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create ZRA conversation **Slug:** `ZOOM_CREATE_ZRA_CONVERSATION` Tool to create a new conversation in Zoom Revenue Accelerator (ZRA). Use when uploading meeting recordings or phone calls for AI-powered analytics, including transcription, sentiment analysis, and engagement scoring. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `deal_id` | string | No | Zoom deal ID to associate this conversation with a specific deal in your CRM. | | `file_id` | string | No | IQ file's unique identifier for uploading a recording file that was already uploaded to Zoom IQ. | | `host_id` | string | No | Host user ID or email address. If not provided, the OAuth token owner will be set as the default host. | | `timeline` | array | No | Speech timeline showing when each participant spoke during the recording. Helps with speaker diarization and analytics. | | `timezone` | string | No | Time zone for formatting timestamps in the conversation analytics (e.g., 'America/New_York', 'Europe/London'). | | `download_url` | string | No | Third-party download URL for the recording file. Use this to directly upload a file from an external file service. | | `participants` | array | No | List of participants in the conversation. Maximum 200 participants. Each participant must have a display_name and optionally an email. | | `meeting_end_time` | string | No | End time of the meeting or call in ISO-8601 format. Optional but recommended for accurate duration tracking. | | `primary_language` | string ("en" | "es" | "fr" | "de" | "it" | "zh" | "ru" | "uk" | "ja" | "ko" | "vi" | "pt" | "nl" | "hi") | No | Supported primary languages for conversation analysis | | `conversation_type` | string ("meeting" | "phone") | Yes | Type of conversation to create. Use 'meeting' for Zoom meetings or video calls, 'phone' for phone calls. | | `conversation_topic` | string | No | Topic or title of the meeting or phone call. Helps identify the conversation in analytics. | | `meeting_start_time` | string | Yes | Start time of the meeting or call in ISO-8601 format (e.g., '2026-02-17T10:00:00Z'). Required for all conversations. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create ZRA conversation comment **Slug:** `ZOOM_CREATE_ZRA_CONVERSATION_COMMENT` Tool to create a comment on a Zoom Revenue Accelerator conversation. Use when you need to add comments, replies, or annotations to ZRA conversation recordings or transcripts. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The conversation identifier for the Zoom Revenue Accelerator conversation. | | `comment` | string | Yes | The text content of the comment to add to the conversation. | | `is_private` | boolean | No | Whether the comment is private (visible only to specific users) or public (visible to all conversation participants). | | `mention_team_ids` | array | No | Array of team IDs to mention in the comment. Team members will be notified. | | `mention_user_ids` | array | No | Array of user IDs to mention in the comment. These users will be notified. | | `parent_comment_id` | string | No | Parent comment ID for nested replies. Leave empty for top-level comments. | | `time_in_recording` | string | No | Timestamp in the recording where the comment should be anchored (format: HH:MM:SS). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create ZRA CRM accounts **Slug:** `ZOOM_CREATE_ZRA_CRM_ACCOUNTS` Tool to create or update CRM accounts in Zoom Revenue Accelerator (ZRA). Use when you need to sync CRM account data to Zoom IQ. Supports up to 2000 accounts per request and returns an async task ID for polling status. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | array | Yes | Array of CRM account objects to create or update. Maximum 2000 accounts per request. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create ZRA CRM contacts **Slug:** `ZOOM_CREATE_ZRA_CRM_CONTACTS` Tool to bulk import or delete CRM contacts in Zoom Revenue Accelerator. Use when syncing contacts from external CRM systems. Accepts up to 2,000 contacts per request and returns a task ID for async status tracking. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | array | Yes | Array of CRM contact objects. Up to 2,000 contacts can be submitted per request | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create ZRA CRM deals **Slug:** `ZOOM_CREATE_ZRA_CRM_DEALS` Tool to bulk import or delete CRM deals in Zoom Revenue Accelerator (ZRA). Use when you need to synchronize deals from an external CRM to Zoom's ZRA system. Supports up to 2000 deals per request and processes asynchronously. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | array | Yes | List of CRM deal objects for bulk import or deletion. Maximum of 2000 deals per request. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Bulk import ZRA CRM leads **Slug:** `ZOOM_CREATE_ZRA_CRM_LEADS` Tool to bulk import CRM leads into Zoom Revenue Accelerator (ZRA). Use when you need to import or update multiple leads asynchronously. Supports up to 2000 leads per request and returns a task_id to track import progress. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | array | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create ZRA CRM settings **Slug:** `ZOOM_CREATE_ZRA_CRM_SETTINGS` Tool to register a new CRM API integration for Zoom Revenue Accelerator (ZRA). Use when you need to configure CRM settings including type, name, currency, deal stages, and URL patterns for accessing CRM records. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `crm_name` | string | No | Display name for the CRM type. If not provided, defaults to the value of crm_type. | | `crm_type` | string | Yes | CRM type identifier, 1-16 alphanumeric characters, must start with letter (e.g., 'oracle', 'salesforce'). | | `deal_stages` | array | Yes | Array of deal stage definitions. Must include at least one stage for each type: OPEN, CLOSED_WON, and CLOSED_LOST. | | `currency_type` | string | No | Currency unit to use (e.g., 'USD', 'EUR', 'JPY'). Defaults to 'USD' if not specified. | | `url_pattern_deal` | string | No | 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}'). | | `url_pattern_lead` | string | No | URL pattern template for opening lead objects in the CRM. Use {id} as placeholder (e.g., 'https://example.com/leads/{id}'). | | `url_pattern_account` | string | No | URL pattern template for opening account objects in the CRM. Use {id} as placeholder (e.g., 'https://example.com/accounts/{id}'). | | `url_pattern_contact` | string | No | URL pattern template for opening contact objects in the CRM. Use {id} as placeholder (e.g., 'https://example.com/contacts/{id}'). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create ZRA user conversation **Slug:** `ZOOM_CREATE_ZRA_USER_CONVERSATION` Tool to create a new conversation in Zoom Revenue Accelerator for a specific user. Use when you need to initiate a ZRA conversation entry with topic and start time. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The user ID or 'me' to create a conversation for. Use 'me' for the authenticated user. | | `topic` | string | Yes | The conversation title/topic. Specifies the name or subject of the conversation. | | `start_time` | string | Yes | Meeting start timestamp in ISO 8601 format (e.g., '2026-02-17T10:00:00Z'). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a meeting **Slug:** `ZOOM_DELETE_A_MEETING` Delete or cancel a scheduled Zoom meeting. Use occurrence_id to delete a specific occurrence of a recurring meeting. Supports notification options for hosts and registrants. Returns HTTP 204 on success. Rate limit: Light. Required scopes: meeting:write or meeting:write:admin. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `meetingId` | string | Yes | 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. | | `occurrence_id` | string | No | 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. | | `schedule_for_reminder` | boolean | No | 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. | | `cancel_meeting_reminder` | boolean | No | Whether to send a cancellation notification to meeting registrants. Set to true to notify all registrants that the meeting has been cancelled. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete IQ conversation **Slug:** `ZOOM_DELETE_IQ_CONVERSATION` DEPRECATED: Use ZOOM_DELETE_ZRA_CONVERSATION instead (Zoom rebranded IQ to ZRA). Tool to delete a Zoom IQ conversation by its ID. Use when you need to permanently remove a specific Zoom IQ conversation from the system. Returns HTTP 200 with empty body on success. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The conversation ID to delete. This is the unique identifier for the Zoom IQ conversation that you want to remove. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete IQ conversation comment **Slug:** `ZOOM_DELETE_IQ_CONVERSATION_COMMENT` DEPRECATED: 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `commentId` | string | Yes | The comment's unique identifier within that conversation. | | `conversationId` | string | Yes | The conversation's unique identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete IQ deal activities **Slug:** `ZOOM_DELETE_IQ_DEAL_ACTIVITIES` DEPRECATED: 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the deal whose activities should be deleted. | | `activity_ids` | string | No | Comma-separated list of activity IDs to delete. If not provided, all activities for the deal will be deleted. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete meeting recordings **Slug:** `ZOOM_DELETE_MEETING_RECORDINGS` Deletes all cloud recordings for a meeting or webinar. Requires the account to have Cloud Recording enabled. Rate limit: Light. Required scopes: cloud_recording:delete:meeting_recording or cloud_recording:delete:meeting_recording:admin. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `action` | string ("trash" | "delete") | No | The delete action to perform: 'trash' (default) moves recordings to trash where they can be recovered; 'delete' permanently removes recordings and cannot be undone. | | `meetingId` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete ZRA conversation **Slug:** `ZOOM_DELETE_ZRA_CONVERSATION` Deletes a ZRA (Zoom Revenue Accelerator) conversation by ID. Use when you need to remove a conversation from the Revenue Accelerator system. This is an undocumented endpoint that returns HTTP 200 on success. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The ZRA (Zoom Revenue Accelerator) conversation ID to delete. This is a unique identifier for the conversation in Zoom's Revenue Accelerator system. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete ZRA conversation comment **Slug:** `ZOOM_DELETE_ZRA_CONVERSATION_COMMENT` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `comment_id` | string | Yes | The ID of the comment to delete from the conversation. | | `conversation_id` | string | Yes | The ID of the Zoom Revenue Accelerator conversation containing the comment to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete ZRA CRM settings **Slug:** `ZOOM_DELETE_ZRA_CRM_SETTINGS` Deletes CRM settings for Zoom Revenue Accelerator (ZRA). Use when you need to remove CRM configuration from the account. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete ZRA deal activities **Slug:** `ZOOM_DELETE_ZRA_DEAL_ACTIVITIES` Tool to delete activities from a Zoom Revenue Accelerator (ZRA) deal. Use when you need to remove one or more activities associated with a specific deal by providing the deal ID and comma-separated activity IDs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The deal ID for which to delete activities. This is the unique identifier of the deal in Zoom Revenue Accelerator. | | `activity_ids` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a meeting **Slug:** `ZOOM_GET_A_MEETING` Retrieves detailed information about a Zoom meeting by its ID. Returns comprehensive meeting data including topic, schedule, URLs, passwords, settings, and for recurring meetings, occurrence details and recurrence patterns. For recurring meetings, defaults to the latest occurrence unless occurrence_id or show_previous_occurrences is specified. Returned start_time must be interpreted using the meeting's timezone field. Requires meeting:read scope. Rate limit: LIGHT. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `meetingId` | integer | Yes | 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. | | `occurrence_id` | string | No | Meeting occurrence ID. Provide this field to view meeting details of a particular occurrence of the [recurring meeting](https://support.zoom.us/hc/en-us/articles/214973206-Scheduling-Recurring-Meetings). | | `show_previous_occurrences` | boolean | No | Set this field's value to `true` to view meeting details of all previous occurrences of a [recurring meeting](https://support.zoom.us/hc/en-us/articles/214973206-Scheduling-Recurring-Meetings). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a meeting summary (Paid accounts only) **Slug:** `ZOOM_GET_A_MEETING_SUMMARY` IMPORTANT: This action requires a PAID Zoom account (Pro, Business, or Enterprise plan). Free Zoom accounts cannot use this feature and will receive a 400 error. Additionally requires: - AI Companion feature enabled in account settings - Meeting must not be end-to-end encrypted (E2EE) - Meeting summary must be enabled and generated for the meeting Rate limit: LIGHT. Response fields such as `summary_details` and `next_steps` are optional and may be absent or empty arrays. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `meetingId` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a webinar **Slug:** `ZOOM_GET_A_WEBINAR` Access Zoom Webinar details requires Pro or higher plan and Webinar add-on. Scopes include `webinar:read:admin` and `webinar:read`. Granular scopes and a 'LIGHT' rate limit also apply. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `webinarId` | string | Yes | The webinar's ID or universally unique ID (UUID). | | `occurrence_id` | string | No | Unique identifier for an occurrence of a recurring webinar. [Recurring webinars](https://support.zoom.us/hc/en-us/articles/216354763-How-to-Schedule-A-Recurring-Webinar) can have a maximum of 50 occurrences. When you create a recurring Webinar using [**Create a webinar**](https://developers.zoom.us) API, you can retrieve the Occurrence ID from the response of the API call. | | `show_previous_occurrences` | boolean | No | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get daily usage report **Slug:** `ZOOM_GET_DAILY_USAGE_REPORT` The daily report provides Zoom service usage details, like new users, meetings, participants, and minutes per day for a month, requiring a Pro plan or higher. It has a 'Heavy' rate limit. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `year` | integer | No | Year for this report. Defaults to the current year if not provided. | | `month` | integer | No | Month for this report (1-12). Defaults to the current month if not provided. | | `group_id` | string | No | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get IQ conversation comments **Slug:** `ZOOM_GET_IQ_CONVERSATION_COMMENTS` DEPRECATED: 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page_size` | integer | No | Number of records per API call. Default is 30. | | `conversationId` | string | Yes | The conversation's ID. If the ID begins with a `/` character or contains `//` characters, you must double encode the ID value. | | `next_page_token` | string | No | For pagination through large result sets with 15-minute expiration. Use this token to retrieve the next page of results. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get IQ conversation content analysis **Slug:** `ZOOM_GET_IQ_CONVERSATION_CONTENT_ANALYSIS` Tool to retrieve content analysis for a Zoom IQ conversation by its ID. Use when you need to get AI-generated insights and analysis from a Revenue Accelerator conversation. Returns structured analysis data including conversation insights and extracted content. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The conversation ID to analyze. This identifies the specific conversation for which content analysis is requested. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get IQ conversation interactions **Slug:** `ZOOM_GET_IQ_CONVERSATION_INTERACTIONS` DEPRECATED: 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the conversation for which to retrieve interactions. | | `page_size` | integer | No | The number of records to return per page. Default is 30. | | `next_page_token` | string | No | Token to retrieve the next page of results. Use the token returned in the previous response to paginate through large result sets. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get IQ conversation scorecards **Slug:** `ZOOM_GET_IQ_CONVERSATION_SCORECARDS` DEPRECATED: 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The conversation ID to retrieve scorecards for. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get IQ deal **Slug:** `ZOOM_GET_IQ_DEAL` Tool to get details of a specific deal in Zoom Revenue Accelerator (formerly Zoom IQ). Returns deal information for the specified deal ID including name, amount, stage, owner, and dates. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the deal to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get IQ deal activities **Slug:** `ZOOM_GET_IQ_DEAL_ACTIVITIES` DEPRECATED: 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the deal whose activities to retrieve. | | `page_size` | integer | No | Number of records to return per page. Default is 30, maximum is 100. | | `next_page_token` | string | No | Token for pagination to fetch the next page of results. Use the token returned in the previous response to get the next page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get IQ user conversation playlists **Slug:** `ZOOM_GET_IQ_USER_CONVERSATIONS_PLAYLISTS` DEPRECATED: 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The user ID for which to retrieve conversation playlists. Use 'me' to get playlists for the authenticated user. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get marketplace user apps **Slug:** `ZOOM_GET_MARKETPLACE_USER_APPS` Retrieves a paginated list of Zoom Marketplace apps installed for a specific user. Returns app details including app ID, name, type, and installation status. Use when you need to check which marketplace apps a user has access to. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The user ID. Can be retrieved using GET /users/me or GET /users endpoints. | | `page_size` | integer | No | Number of records returned per page. | | `next_page_token` | string | No | Token for retrieving the next page of results. Use the token returned from the previous response. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get marketplace user entitlements **Slug:** `ZOOM_GET_MARKETPLACE_USER_ENTITLEMENTS` Retrieves marketplace entitlements for a specific Zoom user by ID or 'me'. Returns list of entitlements associated with the user's account. Use when you need to check user marketplace subscriptions or permissions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get meeting recordings **Slug:** `ZOOM_GET_MEETING_RECORDINGS` To download meeting recordings, use `download_url`. Include OAuth token in the header for passcode-protected ones. Supports `recording:read` and `phone_recording:read:admin` scopes, with a `LIGHT` rate limit. Requires a paid Zoom plan with cloud recording enabled; missing entitlements return empty results or entitlement errors, not system failures. Error code 3301 means no cloud recording exists for the meeting — an expected empty-result case. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ttl` | integer | No | 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. | | `meetingId` | string | Yes | 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. | | `include_fields` | string | No | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get past meeting participants **Slug:** `ZOOM_GET_PAST_MEETING_PARTICIPANTS` Retrieves the list of participants who attended a past (ended) Zoom meeting. Requires a paid Zoom account (Pro or higher). Meeting must have ended with at least one participant (excluding solo meetings). Use meeting ID for the latest instance, or instance UUID for a specific occurrence. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `meetingId` | string | Yes | 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. | | `page_size` | integer | No | The number of records returned within a single API call. | | `next_page_token` | string | No | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a user **Slug:** `ZOOM_GET_USER` Retrieves detailed information about a specific Zoom user by ID, email, or 'me'. Returns user type, role, license info, and account metadata. Use when you need to check user type/license or retrieve user profile details. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `userId` | string | Yes | The user ID or email address of the user. For user-level apps, pass the `me` value to fetch the authenticated user. | | `login_type` | integer | No | 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. | | `encrypted_email` | boolean | No | Whether the email address in the response should be encrypted. Set to `true` to encrypt the email in the response. | | `search_by_unique_id` | boolean | No | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get ZRA conversation comments **Slug:** `ZOOM_GET_ZRA_CONVERSATION_COMMENTS` Tool to retrieve comments for a specific Zoom Revenue Accelerator (ZRA) conversation. Use when you need to access user comments, replies, and annotations associated with a conversation recording or transcript. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The conversation identifier for which to retrieve comments. | | `page_size` | integer | No | Number of records to return per API call. Maximum value is 300, default is 30. | | `next_page_token` | string | No | Token for pagination to retrieve the next page of results. This token expires after 15 minutes. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get ZRA conversation interactions **Slug:** `ZOOM_GET_ZRA_CONVERSATION_INTERACTIONS` Retrieves interaction details for a specific Zoom Revenue Accelerator (ZRA) conversation. Returns interaction data including speakers, timestamps, content, and metadata for conversation analysis. Use when you need detailed interaction-level data from ZRA conversations. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | 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. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get ZRA conversation scorecards **Slug:** `ZOOM_GET_ZRA_CONVERSATION_SCORECARDS` Tool to retrieve scorecards for a specific conversation in Zoom Revenue Accelerator. Use when you need to get scorecard data and performance metrics for a particular conversation. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Conversation ID for which to retrieve scorecards. Obtain this ID from the list_zra_conversations action. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get ZRA deal activities **Slug:** `ZOOM_GET_ZRA_DEAL_ACTIVITIES` Tool to retrieve activities associated with a Zoom Revenue Accelerator (ZRA) deal. Use when you need to list all activities for a specific deal in ZRA. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the deal whose activities to retrieve. | | `page_size` | integer | No | Number of records to return per page. Default is 30, maximum is 100. | | `next_page_token` | string | No | Token for pagination to fetch the next page of results. Use the token returned in the previous response to get the next page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List all recordings **Slug:** `ZOOM_LIST_ALL_RECORDINGS` This text details how to list Zoom cloud recordings for a user, notably by using "me" for user-level apps and requiring an OAuth token for access. It requires a Pro plan, Cloud Recording enabled, and has a MEDIUM rate limit. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `mc` | string | No | The query metadata of the recording if using an on-premise meeting connector for the meeting. | | `to` | string | No | 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. | | `from` | string | No | 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. | | `trash` | boolean | No | 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. | | `userId` | string | Yes | 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. | | `page_size` | integer | No | The number of records returned within a single API call. | | `meeting_id` | integer | No | The meeting ID. | | `trash_type` | string | No | 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. | | `next_page_token` | string | No | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List archived files **Slug:** `ZOOM_LIST_ARCHIVED_FILES` Lists archived meeting and webinar files within a specified date range (max 7 days). Requires the 'Meeting and Webinar Archiving' feature to be enabled by Zoom Support. Use this to retrieve compliance recordings archived to third-party storage platforms. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `to` | string | No | 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. | | `from` | string | No | 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. | | `group_id` | string | No | The group ID. To get a group ID, use the [List groups](https://developers.zoom.us/docs/api/rest/reference/scim-api/methods/#operation/groupSCIM2List) API. | | `page_size` | integer | No | The number of records returned within a single API call. | | `next_page_token` | string | No | 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. | | `query_date_type` | string ("meeting_start_time" | "archive_complete_time") | No | The type of query date. * `meeting_start_time` * `archive_complete_time` This value defaults to `meeting_start_time`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List devices **Slug:** `ZOOM_LIST_DEVICES` Lists devices in your Zoom account managed through Zoom Device Management (ZDM). Returns information about Zoom Room devices including computers, controllers, scheduling displays, and whiteboards. **Scopes:** `device:read:admin`, `device:write:admin`, `device:read:list_zdm_devices:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY` #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page_size` | integer | No | The number of records returned within a single API call. | | `device_type` | integer | No | 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. | | `platform_os` | string ("win" | "mac" | "ipad" | "iphone" | "android" | "linux") | No | Filter devices by platform operating system. | | `search_text` | string | No | Filter devices by name or serial number. | | `device_model` | string | No | Filter devices by model. | | `device_status` | integer | No | Filter devices by status. Device Status: `0` - offline, `1` - online, `-1` - unlinked. Leave empty to include all devices regardless of status. | | `device_vendor` | string | No | Filter devices by vendor. | | `next_page_token` | string | No | 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. | | `is_enrolled_in_zdm` | boolean | No | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List IQ conversations **Slug:** `ZOOM_LIST_IQ_CONVERSATIONS` DEPRECATED: 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page_size` | integer | No | Number of records to return per page. Default is 30, maximum is 100. | | `next_page_token` | string | No | Token for pagination to fetch the next page of results. Use the token returned in the previous response to get the next page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List IQ deals **Slug:** `ZOOM_LIST_IQ_DEALS` DEPRECATED: 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page_size` | integer | No | The number of records returned within a single API call. Maximum 300, default 30. | | `next_page_token` | string | No | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List marketplace app custom fields **Slug:** `ZOOM_LIST_MARKETPLACE_APP_CUSTOM_FIELDS` Tool to retrieve custom fields configured for a Zoom Marketplace app. Use when you need to list all custom fields available for the marketplace app. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List meetings **Slug:** `ZOOM_LIST_MEETINGS` This Zoom API lists a user's scheduled meetings using the `me` value for user-level apps, excluding instant meetings and only showing unexpired ones. 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `to` | string | No | The end date. | | `from` | string | No | The start date. | | `type` | string ("scheduled" | "live" | "upcoming" | "upcoming_meetings" | "previous_meetings") | No | 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. | | `userId` | string | Yes | The user's user ID or email address. For user-level apps, pass the `me` value. | | `timezone` | string | No | The timezone to assign to the `from` and `to` value. For a list of supported timezones and their formats, see our [timezone list](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones). | | `page_size` | integer | No | The number of records returned within a single API call. | | `page_number` | integer | No | The page number of the current page in the returned records. | | `next_page_token` | string | No | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List meeting summary templates **Slug:** `ZOOM_LIST_MEETING_SUMMARY_TEMPLATES` Tool to retrieve a list of meeting summary templates for a specified user. Use when you need to view available meeting summary templates or select a template for meeting summaries. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `userId` | string | Yes | The user ID or email address of the user. Use 'me' for the authenticated user. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List past meeting instances **Slug:** `ZOOM_LIST_PAST_MEETING_INSTANCES` Tool to retrieve all UUIDs for past instances of a given meeting. Use when you need to get the list of all occurrences (instances) of a recurring meeting that have already ended. Each instance has a unique UUID that can be used to query specific details about that occurrence. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `meetingId` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List user collaboration devices **Slug:** `ZOOM_LIST_USERS_COLLABORATION_DEVICES` Tool to list collaboration devices associated with a user. Use when you need to retrieve information about a user's collaboration devices. For user-level apps, pass 'me' instead of the userId parameter to get devices for the authenticated user. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `userId` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get user settings **Slug:** `ZOOM_LIST_USERS_SETTINGS` Tool to retrieve a user's settings including meeting scheduling, in-meeting features, email notifications, recording, telephony, and security preferences. Use when you need to check or display a user's Zoom configuration settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `option` | string ("meeting_authentication" | "recording_authentication" | "security" | "meeting_security" | "schedule_meeting" | "in_meeting" | "email_notification" | "recording" | "telephony" | "feature" | "tsp" | "profile" | "audio_conferencing") | No | Options for filtering the response fields | | `userId` | string | Yes | The user ID or email address of the user. For user-level apps, pass the 'me' value to fetch the authenticated user's settings. | | `login_type` | integer | No | 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). | | `custom_query_fields` | string | No | Comma-separated list of custom field names to include in the response. Use this to request specific custom attributes for the user. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List webinar participants **Slug:** `ZOOM_LIST_WEBINAR_PARTICIPANTS` Get a list of past webinar participants with a Pro plan or above plus an add-on. Requires specific scopes and has a medium rate limit. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page_size` | integer | No | The number of records returned within a single API call. | | `webinarId` | string | Yes | 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. | | `next_page_token` | string | No | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List webinar registrants **Slug:** `ZOOM_LIST_WEBINAR_REGISTRANTS` Retrieves the list of registrants for a webinar with registration enabled. This endpoint returns registrants (people who registered for the webinar), not participants (people who attended). Use this action when you need to view registrant details for CRM sync, reporting, or managing approvals for registration-based webinars. Supports filtering by occurrence, status (approved/pending/denied), and tracking source for targeted queries. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `status` | string ("approved" | "pending" | "denied") | No | Status filter for webinar registrants | | `page_size` | integer | No | The number of records returned within a single API call. Maximum is 300. | | `webinarId` | string | Yes | The webinar's ID or universally unique ID (UUID). When storing this value in your database, store it as a long format integer. | | `occurrence_id` | string | No | The webinar occurrence ID for which to list registrants. Use this to filter registrants for a specific occurrence of a recurring webinar. | | `next_page_token` | string | No | 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. | | `tracking_source_id` | string | No | Filter registrants by tracking source ID. Use this to get registrants attributed to a specific campaign or source. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List webinars **Slug:** `ZOOM_LIST_WEBINARS` The API lists all scheduled webinars for Zoom users with a webinar plan, using `me` for user-level apps. It only shows unexpired webinars for hosts broadcasting to up to 10,000 attendees. Requires Pro plan upwards and specific scopes. Rate limit: MEDIUM. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("scheduled" | "upcoming") | No | The type of webinar. * `scheduled` - All valid previous (unexpired) webinars, live webinars, and upcoming scheduled webinars. * `upcoming` - All upcoming webinars, including live webinars. | | `userId` | string | Yes | The user's user ID or email address. For user-level apps, pass the `me` value. | | `page_size` | integer | No | The number of records returned within a single API call. | | `page_number` | integer | No | **Deprecated** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination. | | `next_page_token` | string | No | Token for fetching the next page of results. Received from the previous response's next_page_token field. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List ZRA conversations **Slug:** `ZOOM_LIST_ZRA_CONVERSATIONS` Tool to list all conversations in Zoom Revenue Accelerator. Use when you need to retrieve analytics data from Revenue Accelerator conversations, including engagement scores, sentiment analysis, and meeting metrics. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `to` | string | No | 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. | | `from` | string | No | 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. | | `deal_id` | string | No | Filter conversations by deal ID. Use this to see conversations linked to a specific deal. | | `host_id` | string | No | Filter conversations by host ID. Use this to see only conversations hosted by a specific user. | | `team_id` | string | No | Filter conversations by team ID. Use this to see conversations associated with a specific team. | | `page_size` | integer | No | Number of records to return per page. Maximum 300. | | `period_type` | string ("meetingStartTime" | "iqProcessedTime") | No | Period type for filtering conversations | | `participant_id` | string | No | Filter conversations by participant ID. Use this to find conversations involving a specific participant. | | `next_page_token` | string | No | Token for fetching the next page of results. Obtained from the previous response's next_page_token field. This token expires in 15 minutes. | | `conversation_type` | string ("all" | "meeting" | "phone") | No | Conversation type filter | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List ZRA CRM accounts **Slug:** `ZOOM_LIST_ZRA_CRM_ACCOUNTS` Lists CRM accounts from Zoom Revenue Accelerator by account IDs. Use when you need to retrieve CRM account information for specific account identifiers (up to 100 IDs). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `crm_account_ids` | string | Yes | Comma-separated list of CRM account IDs, up to a maximum of 100 IDs. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List ZRA CRM contacts **Slug:** `ZOOM_LIST_ZRA_CRM_CONTACTS` Tool to retrieve CRM contact information from Zoom IQ Revenue Accelerator (ZRA). Use when you need to fetch detailed contact information for specific CRM contacts. Supports up to 100 contact IDs per request. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `crm_contact_ids` | string | Yes | Comma-separated list of CRM contact IDs to retrieve. Maximum of 100 IDs per request. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List ZRA CRM deals **Slug:** `ZOOM_LIST_ZRA_CRM_DEALS` Tool to retrieve CRM deal information from Zoom Revenue Accelerator (ZRA). Use when you need to fetch detailed deal information for specific CRM deals. Supports up to 100 deal IDs per request. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `crm_deal_ids` | string | Yes | Comma-separated list of CRM deal IDs to retrieve. Maximum of 100 IDs per request. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List ZRA CRM leads **Slug:** `ZOOM_LIST_ZRA_CRM_LEADS` Tool to retrieve CRM lead information from Zoom IQ Revenue Accelerator (ZRA). Use when you need to fetch detailed lead information for specific CRM leads. Supports up to 100 lead IDs per request. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `crm_lead_ids` | string | Yes | Comma-separated list of CRM lead IDs to retrieve. Maximum of 100 IDs per request. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List ZRA CRM settings **Slug:** `ZOOM_LIST_ZRA_CRM_SETTINGS` Tool to retrieve the current CRM API registration information for Zoom Revenue Accelerator (ZRA). Use when you need to view the configured CRM settings including type, name, currency, deal stages, and URL patterns. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List ZRA deals **Slug:** `ZOOM_LIST_ZRA_DEALS` Tool to list deals from Zoom Revenue Accelerator (ZRA). Returns deal information including name, amount, stage, and owner details. Use when you need to retrieve CRM deal data from Zoom ZRA. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page_size` | integer | No | The number of records returned within a single API call. Maximum 300, default 30. | | `next_page_token` | string | No | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List ZRA scheduled items **Slug:** `ZOOM_LIST_ZRA_SCHEDULED` Tool to list scheduled Zoom Revenue Accelerator (ZRA) items. Use when you need to retrieve scheduled ZRA-related data. Returns an empty list when no scheduled items are available for the authenticated account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page_size` | integer | No | Number of records to return per page. Use this to control pagination. | | `next_page_token` | string | No | Token for fetching the next page of results. Obtained from the previous response's next_page_token field. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List ZRA settings indicators **Slug:** `ZOOM_LIST_ZRA_SETTINGS_INDICATORS` Tool to retrieve account indicator settings for Zoom Revenue Accelerator (ZRA). Use when you need to view configured indicators that identify specific words, phrases, or sentences in conversations. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("basic" | "advanced" | "guiding_sentences") | No | Type of indicator to filter by | | `page_size` | integer | No | Number of records to return per API call. Must be between 1 and 300 | | `category_id` | string | No | Filter indicators by category ID to show only indicators belonging to a specific category | | `next_page_token` | string | No | Token for retrieving the next page of results. This token expires after 15 minutes | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List ZRA user conversation playlists **Slug:** `ZOOM_LIST_ZRA_USER_CONVERSATION_PLAYLISTS` Tool to list conversation playlists for a specific user in Zoom Revenue Accelerator. Use when you need to retrieve playlists containing conversation clips for coaching or sharing purposes. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The user ID to retrieve playlists for. Use 'me' to refer to the authenticated user. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search company contacts **Slug:** `ZOOM_SEARCH_COMPANY_CONTACTS` Tool to search company contacts in Zoom by first name, last name, or email. Use when you need to find specific contacts within the organization. Supports pagination for large result sets and optionally includes presence status. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page_size` | integer | No | The number of records to be returned with a single API call. Default value is 30, maximum is 50. | | `search_key` | string | Yes | Provide the keyword - either first name, last name or email of the contact whom you have to search for. | | `next_page_token` | string | No | 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. | | `query_presence_status` | boolean | No | Set `query_presence_status` to `true` in order to include the presence status of a contact in the response. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a meeting **Slug:** `ZOOM_UPDATE_A_MEETING` To update a meeting via API, ensure `start_time` is future-dated; `recurrence` is needed. Limit: 100 requests/day, 100 updates/meeting in 24 hrs. Requires `meeting:write` and `meeting:write:admin` scopes, with a `LIGHT` rate limit. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | integer | No | Meeting types. `1` - Instant meeting. `2` - Scheduled meeting. `3` - Recurring meeting with no fixed time. `8` - Recurring meeting with a fixed time. | | `topic` | string | No | Meeting topic. | | `agenda` | string | No | Meeting description. | | `duration` | integer | No | Meeting duration in minutes. Used for scheduled meetings only. | | `password` | string | No | 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](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604), the passcode value provided here must meet those requirements. If the requirements are enabled, view those requirements by calling either the [**Get user settings**](https://developers.zoom.us) API or the [**Get account settings**](https://developers.zoom.us) API. | | `timezone` | string | No | 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](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones). | | `meetingId` | integer | Yes | 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. | | `start_time` | string | No | 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. | | `template_id` | string | No | Unique identifier of the meeting template. [Schedule the meeting from a meeting template](https://support.zoom.us/hc/en-us/articles/360036559151-Meeting-templates#h_86f06cff-0852-4998-81c5-c83663c176fb). Retrieve this field's value by calling the [List meeting templates](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/listMeetingTemplates) API. | | `pre_schedule` | boolean | No | Whether to create a prescheduled meeting through the [GSuite app](https://support.zoom.us/hc/en-us/articles/360020187492-Zoom-for-GSuite-add-on). 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. | | `schedule_for` | string | No | The email address or `userId` of the user to schedule a meeting for. | | `occurrence_id` | string | No | 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. | | `settings__audio` | string ("both" | "telephony" | "voip" | "thirdParty") | No | 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. | | `tracking_fields` | array | No | Tracking fields. | | `recurrence__type` | integer | No | 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. | | `settings__use__pmi` | boolean | No | Use a [personal meeting ID (PMI)](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#understanding-personal-meeting-id-pmi). Only used for scheduled meetings and recurring meetings with no fixed time. | | `settings__jbh__time` | integer | No | 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. | | `settings__resources` | array | No | The meeting's resources. Each resource must include resource_id and resource_type fields. | | `settings__watermark` | boolean | No | Add a watermark when viewing a shared screen. | | `settings__cn__meeting` | boolean | No | Host the meeting in China. | | `settings__focus__mode` | boolean | No | Whether the [**Focus Mode** feature](https://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) is enabled when the meeting starts. | | `settings__host__video` | boolean | No | Start video when the host joins the meeting. | | `settings__in__meeting` | boolean | No | Host meeting in India. | | `recurrence__end__times` | integer | No | 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`. | | `settings__custom__keys` | array | No | Custom keys and values assigned to the meeting. | | `settings__contact__name` | string | No | Contact name for registration. | | `settings__waiting__room` | boolean | No | Enable waiting room. | | `recurrence__monthly__day` | integer | No | 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`. | | `recurrence__weekly__days` | string ("1" | "2" | "3" | "4" | "5" | "6" | "7") | No | 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. | | `settings__approval__type` | integer | No | 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. | | `settings__calendar__type` | integer | No | The type of calendar integration used to schedule the meeting. * `1` - [Zoom Outlook add-in](https://support.zoom.us/hc/en-us/articles/360031592971-Getting-started-with-Outlook-plugin-and-add-in) * `2` - [Zoom for Google Workspace add-on](https://support.zoom.us/hc/en-us/articles/360020187492-Using-the-Zoom-for-Google-Workspace-add-on) Works with the `private_meeting` field to determine whether to share details of meetings. | | `settings__contact__email` | string | No | Contact email for registration. | | `settings__enforce__login` | boolean | No | 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](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) set for the meeting. | | `recurrence__monthly__week` | integer | No | 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. | | `settings__auto__recording` | string ("local" | "cloud" | "none") | No | Automatic recording. `local` - Record on local. `cloud` - Record on cloud. `none` - Disabled. | | `settings__encryption__type` | string ("enhanced_encryption" | "e2ee") | No | Choose between enhanced encryption and [end-to-end encryption](https://support.zoom.us/hc/en-us/articles/360048660871) 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](https://support.zoom.us/hc/en-us/articles/360048660871). 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. | | `settings__private__meeting` | boolean | No | Whether the meeting is set as private. | | `recurrence__end__date__time` | string | No | 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`. | | `settings__internal__meeting` | boolean | No | Whether to set the meeting as an internal meeting. | | `settings__meeting__invitees` | array | No | A list of the meeting's invitees. | | `settings__mute__upon__entry` | boolean | No | Mute participants upon entry. | | `recurrence__repeat__interval` | integer | No | 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. | | `settings__alternative__hosts` | string | No | A semicolon-separated list of the meeting's alternative hosts" email addresses or IDs. | | `settings__join__before__host` | boolean | No | Allow participants to join the meeting before the host starts the meeting. Only used for scheduled or recurring meetings. | | `settings__participant__video` | boolean | No | Start video when participants join the meeting. | | `settings__registration__type` | integer | No | 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. | | `settings__close__registration` | boolean | No | Close registration after the event date. | | `settings__email__notification` | boolean | No | Whether to send email notifications to [alternative hosts](https://support.zoom.us/hc/en-us/articles/208220166) and [users with scheduling privileges](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-privilege). This value defaults to `true`. | | `settings__show__share__button` | boolean | No | Show social share buttons on the meeting registration page. This setting only works for meetings that require [registration](https://support.zoom.us/hc/en-us/articles/211579443-Setting-up-registration-for-a-meeting). | | `recurrence__monthly__week__day` | integer | No | 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. | | `settings__authentication__name` | string | No | Authentication name set in the [authentication profile](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars#h_5c0df2e1-cfd2-469f-bb4a-c77d7c0cca6f). | | `settings__breakout__room__rooms` | array | No | Create room(s). | | `settings__authentication__option` | string | No | Meeting authentication option ID. | | `settings__breakout__room__enable` | boolean | No | Set this field's value to `true` to enable the [breakout room pre-assign](https://support.zoom.us/hc/en-us/articles/360032752671-Pre-assigning-participants-to-breakout-rooms#h_36f71353-4190-48a2-b999-ca129861c1f4) option. | | `settings__audio__conference__info` | string | No | Third party audio conference info. | | `settings__authentication__domains` | string | No | If user has configured [Sign Into Zoom with Specified Domains](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars#h_5c0df2e1-cfd2-469f-bb4a-c77d7c0cca6f) option, this will list the domains that are authenticated. | | `settings__enforce__login__domains` | string | No | 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](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) set for the meeting. | | `settings__meeting__authentication` | boolean | No | `true`- Only authenticated users can join meetings. | | `settings__allow__multiple__devices` | boolean | No | Allow attendees to join the meeting from multiple devices. This setting only works for meetings that require [registration](https://support.zoom.us/hc/en-us/articles/211579443-Setting-up-registration-for-a-meeting). | | `settings__host__save__video__order` | boolean | No | Whether the **Allow host to save video order** feature is enabled. | | `settings__authentication__exception` | array | No | The participants added here will receive unique meeting invite links and bypass authentication. Each exception must include name and email fields. | | `settings__global__dial__in__numbers` | array | No | Global dial-in countries or regions | | `settings__global__dial__in__countries` | array | No | List of global dial-in countries | | `settings__auto__start__meeting__summary` | boolean | No | Whether to automatically start meeting summary. | | `settings__participant__focused__meeting` | boolean | No | Whether to set the meeting as a participant focused meeting. | | `settings__alternative__host__update__polls` | boolean | No | Whether the **Allow alternative hosts to add or edit polls** feature is enabled. This requires Zoom version 5.8.0 or higher. | | `settings__language__interpretation__enable` | boolean | No | Whether to enable [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars) for the meeting. | | `settings__registrants__confirmation__email` | boolean | No | Whether to send registrants an email confirmation. * `true` - Send a confirmation email. * `false` - Do not send a confirmation email. | | `settings__registrants__email__notification` | boolean | No | 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. | | `settings__continuous__meeting__chat__enable` | boolean | No | Whether to enable the **Enable continuous meeting chat** setting. | | `settings__approved_denied_regions__denied__list` | array | No | List of countries or regions from where participants can not join this meeting. | | `settings__auto__start__ai__companion__questions` | boolean | No | Whether to automatically start AI Companion questions. | | `settings__language__interpretation__interpreters` | array | No | Information about the meeting's language interpreters. Each interpreter must include email and languages fields. | | `settings__sign__language__interpretation__enable` | boolean | No | Whether to enable [sign language interpretation](https://support.zoom.us/hc/en-us/articles/9644962487309-Using-sign-language-interpretation-in-a-meeting-or-webinar) for the meeting. | | `settings__alternative__hosts__email__notification` | boolean | No | Flag to determine whether to send email notifications to alternative hosts, default value is true. | | `settings__approved_denied_regions__approved__list` | array | No | List of countries or regions from where participants can join this meeting. | | `settings__meeting__chat__auto__add__external__users` | boolean | No | Whether to enable the **Automatically add invited external users** setting. | | `settings__sign__language__interpretation__interpreters` | array | No | Information about the meeting's sign language interpreters. Each interpreter must include email and sign_language fields. | | `settings__approved__or__denied__countries__or__regions__enable` | boolean | No | `true` - Setting enabled to either allow users or block users from specific regions to join your meetings. `false` - Setting disabled. | | `settings__approved__or__denied__countries__or__regions__method` | string ("approve" | "deny") | No | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update IQ conversation comment **Slug:** `ZOOM_UPDATE_IQ_CONVERSATION_COMMENT` DEPRECATED: 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `comment` | string | No | The updated text content of the comment. | | `commentId` | string | Yes | The comment's unique identifier within that conversation. | | `conversationId` | string | Yes | The conversation's unique identifier. | | `mention_team_ids` | array | No | List of team IDs mentioned in the comment. | | `mention_user_ids` | array | No | List of user IDs mentioned in the comment. | | `time_in_recording` | string | No | The time in the recording where the comment should be anchored. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update IQ conversation host **Slug:** `ZOOM_UPDATE_IQ_CONVERSATION_HOST` DEPRECATED: 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The conversation's unique identifier. | | `host_id` | string | Yes | The email address or user ID of the new host for the conversation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update ZRA conversation comment **Slug:** `ZOOM_UPDATE_ZRA_CONVERSATION_COMMENT` Tool to update a comment in a Zoom Revenue Accelerator conversation. Use when you need to modify the text, mentions, or timestamp of an existing comment. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `comment` | string | No | The updated comment text. Provide this to change the comment content. | | `comment_id` | string | Yes | The ID of the comment to update within the conversation. | | `conversation_id` | string | Yes | The ID of the Zoom Revenue Accelerator conversation containing the comment to update. | | `mention_team_ids` | array | No | List of team IDs to mention in the updated comment. | | `mention_user_ids` | array | No | List of user IDs to mention in the updated comment. | | `time_in_recording` | string | No | The timestamp in the recording to associate with this comment (format: HH:MM:SS). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update ZRA conversation host **Slug:** `ZOOM_UPDATE_ZRA_CONVERSATION_HOST` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The conversation's unique identifier. | | `host_id` | string | Yes | The email address or user ID of the new host for the conversation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Validate marketplace app manifest **Slug:** `ZOOM_VALIDATE_MARKETPLACE_APP_MANIFEST` Tool to validate a Zoom Marketplace app manifest before submission or update. Use when you need to verify that an app manifest configuration is valid and meets Zoom's requirements. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `app_id` | string | No | Optional app ID to validate the manifest against an existing marketplace app. If provided, validates compatibility with the specified app. | | `manifest` | object | Yes | The complete app manifest object to validate. Must include display_information, oauth_information, and features sections. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ## Triggers ### Daily Usage Report Changed **Slug:** `ZOOM_DAILY_USAGE_REPORT_CHANGED_TRIGGER` **Type:** poll Triggers 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | string | No | 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. | | `interval` | number | No | Periodic Interval to Check for Updates & Send a Trigger in Minutes | | `month` | integer | No | Month for the report (1-12). If not provided, defaults to the current month. | | `year` | integer | No | Year for the report. If not provided, defaults to the current year. | #### Payload | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `changed_dates` | array | No | List of dates that had changes in their statistics | | `event_type` | string | No | Type of change detected (report_updated) | | `report` | object | Yes | Current state of the daily usage report | ### Meeting Details Changed **Slug:** `ZOOM_MEETING_DETAILS_CHANGED_TRIGGER` **Type:** poll Triggers 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `interval` | number | No | Periodic Interval to Check for Updates & Send a Trigger in Minutes | | `meeting_id` | integer | Yes | The meeting ID to monitor for details changes. Use the numeric meeting ID from your Zoom meeting. | #### Payload | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `changed_fields` | array | No | List of field names that changed | | `event_type` | string | Yes | Type of change detected (meeting_updated, settings_changed) | | `meeting_details` | object | Yes | Current state of the meeting details | ### Meeting Recording Changed **Slug:** `ZOOM_MEETING_RECORDING_CHANGED_TRIGGER` **Type:** poll Triggers 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `include_download_token` | boolean | No | Whether to include download access token in the response. Set to True if you need to download recordings. | | `interval` | number | No | Periodic Interval to Check for Updates & Send a Trigger in Minutes | | `meeting_id` | string | Yes | The meeting ID or UUID to monitor for recording changes. Use the meeting ID for the latest instance or UUID for a specific instance. | | `token_ttl` | integer | No | Time to live (in seconds) for the download access token. Only used when include_download_token is True. | #### Payload | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `changes_detected` | object | No | Dictionary describing what changed (e.g., new files, status changes, metadata updates) | | `event_type` | string | Yes | Type of change detected (recording_added, recording_updated, recording_processing_completed) | | `meeting_recording` | object | Yes | Current state of the meeting recording | ### Meeting Summary Created or Updated **Slug:** `ZOOM_MEETING_SUMMARY_UPDATED_TRIGGER` **Type:** poll Triggers 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `interval` | number | No | Periodic Interval to Check for Updates & Send a Trigger in Minutes | | `meeting_id` | string | Yes | The unique ID of the meeting to monitor for summary changes. This is the meeting UUID or meeting ID from your Zoom account. | #### Payload | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `changed_fields` | array | No | List of fields that changed (for updates) | | `event_type` | string | Yes | Type of event that occurred (created/updated) | | `summary` | object | Yes | The meeting summary that was created or updated | ### New Cloud Recording **Slug:** `ZOOM_NEW_CLOUD_RECORDING_TRIGGER` **Type:** poll Triggers when a new cloud recording meeting instance appears for a user. #### Configuration | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `interval` | number | No | Periodic Interval to Check for Updates & Send a Trigger in Minutes | | `page_size` | integer | No | Number of recordings to fetch per page (1-300) | | `user_id` | string | No | The user's ID or email address. Use 'me' for the authenticated user. | #### Payload | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `event_type` | string | No | Type of event | | `meeting` | object | Yes | The meeting with new cloud recording | ### New Meeting Created **Slug:** `ZOOM_NEW_MEETING_CREATED_TRIGGER` **Type:** poll Triggers when a new Zoom meeting is created for a user. #### Configuration | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `interval` | number | No | Periodic Interval to Check for Updates & Send a Trigger in Minutes | | `meeting_type` | string | No | Type of meetings to monitor: 'scheduled', 'live', 'upcoming', 'upcoming_meetings', or 'previous_meetings' | | `page_size` | integer | No | Number of meetings to fetch per page (1-300) | | `user_id` | string | No | The user's ID or email address. Use 'me' for the authenticated user. | #### Payload | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `event_type` | string | No | Type of event that occurred | | `meeting` | object | Yes | The newly created meeting | ### New Meeting Participant **Slug:** `ZOOM_NEW_MEETING_PARTICIPANT_TRIGGER` **Type:** poll Triggers when a new participant appears in a past meeting's participant report. #### Configuration | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `interval` | number | No | Periodic Interval to Check for Updates & Send a Trigger in Minutes | | `meeting_id` | string | Yes | 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. | | `page_size` | integer | No | The number of participants to fetch per API call (max 300). | #### Payload | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `customer_key` | string | No | The customer key associated with the participant. | | `duration` | integer | No | Duration the participant was in the meeting, in seconds. | | `failover` | boolean | No | Whether failover occurred during the meeting for this participant. | | `id` | string | No | Unique identifier for the participant in UUID format. | | `join_time` | string | No | The date and time when the participant joined the meeting (ISO 8601 format). | | `leave_time` | string | No | The date and time when the participant left the meeting (ISO 8601 format). | | `name` | string | No | Participant's display name shown during the meeting. | | `registrant_id` | string | No | The participant's unique registrant ID if they registered for the meeting. | | `status` | string | No | The participant's attendance status: 'in_meeting' or 'in_waiting_room'. | | `user_email` | string | No | The participant's email address. May be empty for external attendees. | | `user_id` | string | No | The participant's Zoom user ID. Empty for external participants not in your account. | ### New Webinar Created **Slug:** `ZOOM_NEW_WEBINAR_CREATED_TRIGGER` **Type:** poll Triggers when a new webinar is created for a user. #### Configuration | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `interval` | number | No | Periodic Interval to Check for Updates & Send a Trigger in Minutes | | `page_size` | integer | No | The number of webinars to fetch per API call (1-300). | | `user_id` | string | No | The user's user ID or email address. Use 'me' for user-level apps to monitor your own webinars. | #### Payload | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agenda` | string | No | Agenda or description of the webinar. | | `created_at` | string | No | Timestamp when the webinar was created in date-time format (ISO 8601). | | `duration` | integer | No | Duration of the webinar in minutes. | | `host_id` | string | No | User ID of the webinar host. | | `id` | integer | No | Webinar ID, also known as the webinar number. | | `join_url` | string | No | URL for participants to join the webinar. | | `occurrences` | array | No | Array of occurrence objects for recurring webinars. | | `settings` | object | No | Webinar settings object containing various configuration options. | | `start_time` | string | No | Scheduled start time of the webinar in date-time format (ISO 8601). | | `start_url` | string | No | URL for the host to start the webinar. Expiration time is two hours for regular users and 90 days for API users. | | `timezone` | string | No | Timezone in which the webinar is scheduled. | | `topic` | string | No | Topic or title of the webinar. | | `type` | integer | No | Webinar type. Values: 5 (Webinar), 6 (Recurring webinar with no fixed time), 9 (Recurring webinar with fixed time). | | `uuid` | string | No | Unique identifier for the webinar instance. | ### New Webinar Participant **Slug:** `ZOOM_NEW_WEBINAR_PARTICIPANT_TRIGGER` **Type:** poll Triggers when a new participant appears in a past webinar's participant list. #### Configuration | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `interval` | number | No | Periodic Interval to Check for Updates & Send a Trigger in Minutes | | `page_size` | integer | No | The number of participants to fetch per API call (max 300). | | `webinar_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `attentiveness_score` | string | No | Participant's attentiveness score. Can be an empty string or a percentage value. | | `bo_mtg_id` | string | No | Breakout room ID for participants in breakout rooms. | | `duration` | integer | No | Participant duration in seconds. | | `id` | string | No | Participant UUID. Unique identifier for the participant. | | `join_time` | string | No | The time at which the participant joined the webinar. ISO 8601 date-time format. | | `leave_time` | string | No | The time at which the participant left the webinar. ISO 8601 date-time format. | | `name` | string | No | Participant display name. | | `registrant_id` | string | No | The unique identifier for the registrant. Used to identify external participants. | | `user_email` | string | No | Email address of the participant. | | `user_id` | string | No | Participant ID. User ID of the participant if they are an authenticated Zoom user. | ### User Information Changed **Slug:** `ZOOM_USER_INFORMATION_CHANGED_TRIGGER` **Type:** poll Triggers 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `interval` | number | No | Periodic Interval to Check for Updates & Send a Trigger in Minutes | | `login_type` | integer | No | The user's login method to filter by (e.g., 1 for Google OAuth, 100 for Zoom Work email). | | `user_id` | string | Yes | The user ID or email address of the user to monitor. Use 'me' for the authenticated user. | #### Payload | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `changes_detected` | object | No | Dictionary describing what changed (field names to old/new values) | | `event_type` | string | Yes | Type of change detected (user_updated) | | `user` | object | Yes | Current state of the user information | ### Webinar Details Changed **Slug:** `ZOOM_WEBINAR_DETAILS_CHANGED_TRIGGER` **Type:** poll Triggers when a Zoom webinar's details change. Detects changes such as: - Topic updates - Start time changes - Agenda modifications - Duration changes - Settings updates (host video, registration type, audio options, etc.) - Status changes - Occurrence updates for recurring webinars - Recurrence pattern changes #### Configuration | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `interval` | number | No | Periodic Interval to Check for Updates & Send a Trigger in Minutes | | `occurrence_id` | string | No | Unique identifier for an occurrence of a recurring webinar. Leave blank for non-recurring webinars. | | `show_previous_occurrences` | boolean | No | Set to True to view webinar details of all previous occurrences of a recurring webinar. | | `webinar_id` | string | Yes | The webinar's ID or universally unique ID (UUID) to monitor for changes. | #### Payload | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `changes_detected` | object | No | Dictionary describing what changed (field names to old/new values) | | `event_type` | string | Yes | Type of change detected (webinar_updated) | | `webinar` | object | Yes | Current state of the webinar details |