Zoom

The registrant"s organization.

The registrant"s ZIP or postal code.

The registrant"s city.

The registrant"s email address.

The registrant"s phone number.

The registrant"s state or province.

The registrant"s address.

The registrant"s two-letter [country code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries).

The registrant"s questions and comments.

The registrant"s industry.

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

The registrant"s job title.

The registrant"s last name.

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.

The registrant"s first name.

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

A comma-separated list of meeting occurrence IDs. You can get this value with the [Get a meeting](https://developers.zoom.us) API.

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`

Information about custom questions.

The registrant"s purchasing time frame: * `Within a month` * `1-3 months` * `4-6 months` * `More than 6 months` * `No timeframe`

The registrant"s role in the purchase process: * `Decision Maker` * `Evaluator/Recommender` * `Influencer` * `Not involved`

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The registrant"s organization.

The registrant"s ZIP or postal code.

The registrant"s city.

The registrant"s email address.

The registrant"s phone number.

The registrant"s state or province.

The registrant"s address.

The registrant"s two-letter [country code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries).

The registrant"s questions and comments.

The registrant"s industry.

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

The registrant"s job title.

The registrant"s last name.

The tracking source"s unique identifier.

The webinar"s ID.

The registrant"s first name.

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.

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`

Information about custom questions.

The registrant"s purchasing time frame: * `Within a month` * `1-3 months` * `4-6 months` * `More than 6 months` * `No timeframe`

The registrant"s role in the purchase process: * `Decision Maker` * `Evaluator/Recommender` * `Influencer` * `Not involved`

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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.

The meeting"s topic.

The meeting"s agenda. This value has a maximum length of 2,000 characters.

The user"s user ID or email address. For user-level apps, pass the `me` value.

The meeting"s scheduled duration, in minutes. This field is only used for scheduled meetings (`2`).

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.

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

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.

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

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.

The email address or user ID of the user to schedule a meeting for.

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.

Information about the meeting"s tracking fields.

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 meeting types. `1` - Daily. `2` - Weekly. `3` - Monthly.

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

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.

The meeting"s resources.

Whether to add a watermark when viewing a shared screen.

Whether to host the meeting in China (CN). This value defaults to `false`.

Whether to enable the [**Focus Mode** feature](https://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) when the meeting starts.

Whether to start meetings with the host video on.

Whether to host the meeting in India (IN). This value defaults to `false`.

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

The contact name for meeting registration.

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.

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

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 for this field could be a number between `1` to `7` in string format. For instance, if the meeting should recur on Sunday, provide `1` as this field"s value. **Note:** To set the meeting to occur on multiple days of a week, provide comma separated values for this field. For instance, if the meeting should recur on Sundays and Tuesdays, provide `1,3` as this field"s value. `1` - Sunday. `2` - Monday. `3` - Tuesday. `4` - Wednesday. `5` - Thursday. `6` - Friday. `7` - Saturday.

Enable meeting registration approval. * `0` - Automatically approve registration. * `1` - Manually approve registration. * `2` - No registration required. This value defaults to `2`.

Indicates 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 or not.

The contact email address for meeting registration.

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.

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

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

Whether to set the meeting as private.

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

Whether to set the meeting as an internal meeting.

A list of the meeting"s invitees.

Whether to mute participants upon entry.

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.

A semicolon-separated list of the meeting"s alternative hosts" email addresses or IDs.

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

Whether to start meetings with the participant video on.

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

Whether to close registration after the event date. This value defaults to `false`.

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

Whether to include social media sharing buttons on the meeting"s registration page. This setting is only applied to meetings with registration enabled.

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.

Information about the breakout rooms.

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.

Whether to enable the [**Breakout Room pre-assign**](https://support.zoom.us/hc/en-us/articles/360032752671-Pre-assigning-participants-to-breakout-rooms) option.

Third party audio conference info.

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.

If true, only [authenticated](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) users can join the meeting.

Whether to allow attendees to join a meeting from multiple devices. This setting is only applied to meetings with registration enabled.

Whether the **Allow host to save video order** feature is enabled.

A list of participants that can bypass meeting authentication. These participants will receive a unique meeting invite.

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.

A list of available global dial-in countries.

Whether to automatically start a meeting summary.

Whether to set the meeting as a participant focused meeting.

Whether the **Allow alternative hosts to add or edit polls** feature is enabled. This requires Zoom version 5.8.0 or higher.

Whether to enable [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars) for the meeting.

Whether to send registrants an email confirmation. * `true` - Send a confirmation email. * `false` - Do not send a confirmation email.

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.

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.

Whether to enable the **Enable continuous meeting chat** setting.

Whether to automatically start AI Companion questions.

Information about the meeting"s language interpreters.

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.

Whether to send email notifications to alternative hosts. This value defaults to `true`.

Information about the meeting"s sign language interpreters.

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.

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.

The list of blocked countries or regions.

The list of approved countries or regions.

Whether to enable the **Automatically add invited external users** setting.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The recording delete actions: `trash` - Move recording to trash. `delete` - Delete recording permanently.

To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must **[double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid)** the UUID before making an API request.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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.

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

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

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The meeting"s universally unique ID (UUID). When 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.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The webinar"s ID or universally unique ID (UUID).

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.

Set the value of this field to `true` if you would like to view Webinar details of all previous occurrences of a recurring Webinar.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Year for this report

Month for this report

The group ID. To get a group ID, use the [**List groups**](https://developers.zoom.us) API. **Note:** The API response will only contain users who are members of the queried group ID.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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.

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. If a UUID starts with `/` or contains `//` (example: `/ajXp112QmuoKj4854875==`), **[double encode](https://developers.zoom.us) the UUID** before making an API request.

The `download_access_token` value for downloading the meeting"s recordings.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The meeting"s ID or universally unique ID (UUID). * If you provide a meeting ID, the API will return 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.

The number of records returned within a single API call.

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.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The query metadata of the recording if using an on-premise meeting connector for the meeting.

The end date in "yyyy-mm-dd" "yyyy-mm-dd" UTC format.

The start date in "yyyy-mm-dd" UTC format for the date range where you would like to retrieve recordings. The maximum range can be a month. If no value is provided for this field, the default will be current date. For example, if you make the API request on June 30, 2020, without providing the `from` and `to` parameters, by default the value of "from" field will be `2020-06-30` and the value of the "to" field will be `2020-07-01`. **Note**: The `trash` files cannot be filtered by date range and thus, the `from` and `to` fields should not be used for trash files.

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.

The user"s ID or email address. For user-level apps, pass the `me` value.

The number of records returned within a single API call.

The meeting ID.

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.

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.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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.

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.

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.

The number of records returned within a single API call.

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.

The type of query date. * `meeting_start_time` * `archive_complete_time` This value defaults to `meeting_start_time`.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The number of records returned within a single API call.

Filter devices by device type. Device Type: `-1` - All Zoom Room device(0,1,2,3,4,6). `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).

Filter devices by platform operating system.

Filter devices by name or serial number.

Filter devices by model.

Filter devices by status. Device Status: `0` - offline. `1` - online. `-1` - unlink

Filter devices by vendor.

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.

Filter devices by enrollment of ZDM (Zoom Device Management).

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The end date.

The start date.

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.

The user"s user ID or email address. For user-level apps, pass the `me` value.

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

The number of records returned within a single API call.

The page number of the current page in the returned records.

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.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The number of records returned within a single API call.

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](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#meeting-id-and-uuid) the webinar UUID before making an API request.

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.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The type of webinar. * `scheduled` - All valid previous (unexpired) webinars, live webinars, and upcoming scheduled webinars. * `upcoming` - All upcoming webinars, including live webinars.

The user"s user ID or email address. For user-level apps, pass the `me` value.

The number of records returned within a single API call.

**Deprecated** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Meeting types. `1` - Instant meeting. `2` - Scheduled meeting. `3` - Recurring meeting with no fixed time. `8` - Recurring meeting with a fixed time.

Meeting topic.

Meeting description.

Meeting duration in minutes. Used for scheduled meetings only.

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.

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

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.

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.

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.

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.

The email address or `userId` of the user to schedule a meeting for.

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

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.

Recurrence meeting types. `1` - Daily. `2` - Weekly. `3` - Monthly.

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.

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.

The meeting"s resources.

Add a watermark when viewing a shared screen.

Host the meeting in China.

Whether the [**Focus Mode** feature](https://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) is enabled when the meeting starts.

Start video when the host joins the meeting.

Host meeting in India.

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

Custom keys and values assigned to the meeting.

Contact name for registration.

Enable waiting room.

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

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. Thiw field"s value could be a number between `1` to `7` in string format. For instance, if the meeting should recur on Sunday, provide `1` as this field"s value. **Note** If you would like the meeting to occur on multiple days of a week, you should provide comma separated values for this field. For instance, if the meeting should recur on Sundays and Tuesdays provide `1,3` as this field"s value. `1` - Sunday. `2` - Monday. `3` - Tuesday. `4` - Wednesday. `5` - Thursday. `6` - Friday. `7` - Saturday.

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.

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.

Contact email for registration.

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.

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.

Automatic recording. `local` - Record on local. `cloud` - Record on cloud. `none` - Disabled.

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.

Whether the meeting is set as private.

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

Whether to set the meeting as an internal meeting.

A list of the meeting"s invitees.

Mute participants upon entry.

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.

A semicolon-separated list of the meeting"s alternative hosts" email addresses or IDs.

Allow participants to join the meeting before the host starts the meeting. Only used for scheduled or recurring meetings.

Start video when participants join the meeting.

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.

Close registration after the event date.

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

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

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.

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

Create room(s).

Meeting authentication option ID.

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.

Third party audio conference info.

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.

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.

`true`- Only authenticated users can join meetings.

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

Whether the **Allow host to save video order** feature is enabled.

The participants added here will receive unique meeting invite links and bypass authentication.

Global dial-in countries or regions

List of global dial-in countries

Whether to automatically start meeting summary.

Whether to set the meeting as a participant focused meeting.

Whether the **Allow alternative hosts to add or edit polls** feature is enabled. This requires Zoom version 5.8.0 or higher.

Whether to enable [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars) for the meeting.

Whether to send registrants an email confirmation. * `true` - Send a confirmation email. * `false` - Do not send a confirmation email.

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.

Whether to enable the **Enable continuous meeting chat** setting.

Whether to automatically start AI Companion questions.

Information about the meeting"s language interpreters.

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.

Flag to determine whether to send email notifications to alternative hosts, default value is true.

Information about the meeting"s sign language interpreters.

`true` - Setting enabled to either allow users or block users from specific regions to join your meetings. `false` - Setting disabled.

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 orcountries in the `denied_list`

List of countries or regions from where participants can not join this meeting.

List of countries or regions from where participants can join this meeting.

Whether to enable the **Automatically add invited external users** setting.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not