Zoom Meeting

Video conferencing and meeting API

developers.zoom.us/docs/api/rest/reference/zoom-api ↗

Version

OpenAPI

3.0.0

Endpoints

172

Schemas

172

Updated

3 days ago

Video video conferencing meetings

Use this API in your AI agent

Query structured spec data via REST or MCP. Get exactly what your agent needs.

Get API Key

Server URLs

https://api.zoom.us/v2

Authentication

apiKey oauth2

Endpoints

Clear filters

GET POST PUT PATCH DELETE

Archiving 1 endpoints

DELETE /past_meetings/{meetingUUID}/archive_files Delete a meeting's archived files

Use this API to delete all of a meeting's archived files. **Prerequisites:** * The [**Meeting and Webinar Archiving** feature](https://support.zoom.us/hc/en-us/articles/4405656451213--Archiving-for-meetings-and-webinars) enabled for your account by [Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003). **Scopes:** `recording:write:admin`,`recording:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`

operationId: Archiving_meetingFilesDelete

Parameters

Name	In	Required	Type	Description
meetingUUID	path	required	string	The meeting's universally unique identifier (UUID). Each meeting instance generates a UUID. For example, after a meeting ends, a new UUID is generated for the next meeting instance. If the meeting UUID begins with a `/` character or contains a `//` character, you must [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the meeting UUID when using the meeting UUID for other API calls.

Responses

204 **HTTP Status Code:** `200` Meeting archived files returned.

400 **HTTP Status Code:** `400` Bad Request **Error Code:** `200` Only available for Paid account. **Error Code:** `200` Not available for this account.

404 **HTTP Status Code:** `404` Not Found **Error Code:** `3001` Meeting does not exist: {0}

DELETE /past_meetings/{meetingUUID}/archive_files

Cloud recording 2 endpoints

DELETE /meetings/{meetingId}/recordings Delete meeting recordings

Delete all recording files of a meeting. **Prerequisites**: * Cloud Recording should be enabled on the user's account. **Scopes:** `recording:write:admin`,`recording:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`

operationId: CloudRecording_deleteMeetingRecordings

Parameters

Name	In	Required	Type	Description
meetingId	path	required	string	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.
action	query	optional	string	The recording delete actions: `trash` - Move recording to trash. `delete` - Delete recording permanently.

Responses

200 **HTTP Status Code:** `200` Recordings deleted. **Error Code:** `200` You do not have the right permission.

204 **HTTP Status Code:** `204` Meeting recording deleted.

400 **HTTP Status Code:** `400` Bad Request **Error Code:** `1010` User does not belong to this account: {accountId}. **Error Code:** `3332` This recording was selected for a simulive webinar. You cannot delete or trash it.

404 **HTTP Status Code:** `404` Not Found **Error Code:** `1001` User {userId} does not exist or does not belong to this account. **Error Code:** `3301` There is no recording for this meeting.

DELETE /meetings/{meetingId}/recordings

DELETE /meetings/{meetingId}/recordings/{recordingId} Delete a meeting recording file

Delete a specific recording file from a meeting. Note: To use this API, you must enable the The host can delete cloud recordings setting. You can find this setting in the Recording tab of the Settings interface in the [Zoom web portal](https://zoom.us/). **Scopes:** `recording:write:admin`,`recording:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`

operationId: CloudRecording_deleteRecording

Parameters

Name	In	Required	Type	Description
meetingId	path	required	string	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.
recordingId	path	required	string	The recording ID.
action	query	optional	string	The recording delete actions: `trash` - Move recording to trash. `delete` - Delete recording permanently.

Responses

200 **HTTP Status Code:** `200` Recording deleted. **Error Code:** `200` You do not have the right permissions.

204 **HTTP Status Code:** `204` Meeting recording file deleted.

400 **HTTP Status Code:** `400` Bad Request **Error Code:** `1010` User does not belong to this account: {accountId}. **Error Code:** `3303` You can not delete an uncompleted meeting. **Error Code:** `3332` This recording was selected for a simulive webinar. You cannot delete or trash it. **Error Code:** `3332` Unable to delete this file because this recording is being used for Zoom IQ for Sales.

DELETE /meetings/{meetingId}/recordings/{recordingId}

Devices 2 endpoints

DELETE /devices/zpa/vendors/{vendor}/mac_addresses/{macAddress} Delete ZPA device by vendor and mac address

Remove a ZPA device from the device manager, by vendor and mac address. **Scopes:** `device:write:admin` **Granular Scopes:** `device:delete:zpa_device:admin`,`device:delete:zpa_device:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`

operationId: Devices_removeZpaDeviceByVendorAndMacAddress

Parameters

Name	In	Required	Type	Description
vendor	path	required	string	The device's manufacturer.
macAddress	path	required	string	The device's mac address.

Responses

204 **HTTP Status Code:** `204` **No Content** Device deleted successfully.

400 **HTTP Status Code:** `400` Bad Request **Error Code:** `30052026` Device is not ZPA. **Error Code:** `30055003` Device vendor does not support. **Error Code:** `30055007` Mac address is wrong.

404 **HTTP Status Code:** `404` Not Found **Error Code:** `30051039` Zdm device not found.

DELETE /devices/zpa/vendors/{vendor}/mac_addresses/{macAddress}

DELETE /devices/{deviceId} Delete device

Delete a device from a Zoom account. **Prerequisites:** * Device must be enrolled in ZMD (Zoom Device Management) **Scopes:** `device:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`

operationId: Devices_removeDeviceZMD

Parameters

Name	In	Required	Type	Description
deviceId	path	required	string	Unique identifier of the device.

Responses

204 **HTTP Status Code:** `204` **No Content** Device deleted successfully.

400 **HTTP Status Code:** `400` Bad Request **Error Code:** `30055008` no permission.

404 **HTTP Status Code:** `404` Not Found **Error Code:** `30055012` no found unified deviceId.

DELETE /devices/{deviceId}

H323 devices 1 endpoints

DELETE /h323/devices/{deviceId} Delete a H.323/SIP device

A H.323 or SIP device can make a video call to a [Room Connector](https://support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to delete a H.323/SIP device from your Zoom account. **Scopes:** `h323:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`

operationId: H323Devices_deleteDevice

Parameters

Name	In	Required	Type	Description
deviceId	path	required	string	The device ID.

Responses

200 You do not have the permission to delete this device.

204 H.323/SIP device deleted.

404 **HTTP Status Code:** `404` Not Found

DELETE /h323/devices/{deviceId}

Meetings 5 endpoints

DELETE /live_meetings/{meetingId}/chat/messages/{messageId} Delete a live meeting message

Delete a message in a live meeting, based on ID. **Prerequisites:** * Have Zoom enable the DLP for the in-meeting chat feature to use this API. **Scopes:** `meeting:write`,`meeting:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`

operationId: Meetings_deleteMeetingChatMessage

Parameters

Name	In	Required	Type	Description
meetingId	path	required	integer	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 exceed 10 digits.
messageId	path	required	string	The live meeting chat message's unique identifier (UUID), in base64-encoded format.
file_ids	query	optional	string	The live webinar chat file's universally unique identifier (UUID), in base64-encoded format. Separate multiple values with commas.

Responses

204 **HTTP Status Code:** `204` Meeting chat message deleted.

400 **HTTP Status Code:** `400` Bad Request **Error Code:** `200` * Only available for Paid accounts. * DLP is not enabled.

404 **HTTP Status Code:** `404` Not Found **Error Code:** `3001` Meeting {meetingId} does not exist.

DELETE /live_meetings/{meetingId}/chat/messages/{messageId}

DELETE /meetings/{meetingId} Delete a meeting

Delete a meeting. **Scopes:** `meeting:write:admin`,`meeting:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`

operationId: Meetings_removeMeeting

Parameters

Name	In	Required	Type	Description
meetingId	path	required	integer	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.
occurrence_id	query	optional	string	The meeting or webinar occurrence ID.
schedule_for_reminder	query	optional	boolean	`true`: Notify host and alternative host about the meeting cancellation via email. `false`: Do not send any email notification.
cancel_meeting_reminder	query	optional	boolean	`true`: Notify registrants about the meeting cancellation via email. `false`: Do not send any email notification to meeting registrants. The default value of this field is `false`.

Responses

204 **HTTP Status Code**: `204` Meeting deleted.

400 **HTTP Status Code:** `400` Bad Request **Error Code:** `1010` User does not belong to this account: {accountId}. **Error Code:** `3000` Cannot access meeting information. Invalid occurrence_id. **Error Code:** `3002` Sorry, you cannot delete this meeting since it is in progress. **Error Code:** `3003` You are not the meeting host. **Error Code:** `3007` Sorry, you cannot delete this meeting since it has ended. **Error Code:** `3018` Not allowed to delete PMI. **Error Code:** `3037` Not allowed to delete PAC. **Error Code:** `3161` Meeting hosting and scheduling capabilities are not allowed for your user account.

404 **HTTP Status Code:** `404` Not Found **Error Code:** `1001` User does not exist: {userId}. **Error Code:** `3001` Meeting with this {meetingId} is not found or has expired.

DELETE /meetings/{meetingId}

DELETE /meetings/{meetingId}/polls/{pollId} Delete a meeting poll

Polls allow the meeting host to survey attendees. Delete a meeting [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings). **Prerequisites**: * Host user type must be **Pro**. * Polling feature should be enabled in the host's account. * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled. **Scopes:** `meeting:write:admin`,`meeting:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`

operationId: Meetings_pollDelete

Parameters

Name	In	Required	Type	Description
meetingId	path	required	integer	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.
pollId	path	required	string	The poll ID

Responses

204 **HTTP Status Code:** `204` Meeting Poll deleted

400 **HTTP Status Code:** `400` Bad Request **Error Code:** `4400` Meeting polls disabled. To enable this feature, enable the "Meeting Polls/Quizzes" setting in the Zoom web portal's "Settings" interface. **Error Code:** `3161` Meeting hosting and scheduling capabilities are not allowed for your user account.

404 **HTTP Status Code:** `404` Not Found **Error Code:** `404` Meeting Poll not found

DELETE /meetings/{meetingId}/polls/{pollId}

DELETE /meetings/{meetingId}/registrants/{registrantId} Delete a meeting registrant

Delete a meeting registrant. **Scopes:** `meeting:write:admin`,`meeting:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`

operationId: Meetings_deleteRegistrant

Parameters

Name	In	Required	Type	Description
occurrence_id	query	optional	string	The meeting occurrence ID.
meetingId	path	required	integer	The meeting ID.
registrantId	path	required	string	The meeting registrant ID.

Responses

204 **HTTP status code:** `204` OK

400 **HTTP Status Code:** `400` Bad Request **Error Code:** `200` Only available for paid users: {0}. **Error Code:** `300` The value that you entered for the Registrant ID field is invalid. Enter a valid value and try again. **Error Code:** `404` Registration has not been enabled for this meeting: {0}. **Error Code:** `1001` User {userId} does not exist or does not belong to this account. **Error Code:** `3000` Cannot access webinar info. **Error Code:** `3001` Meeting does not exist: {0}. **Error Code:** `3161` Meeting hosting and scheduling capabilities are not allowed for your user account.

DELETE /meetings/{meetingId}/registrants/{registrantId}

DELETE /meetings/{meetingId}/survey Delete a meeting survey

Delete a [meeting survey](https://support.zoom.us/hc/en-us/articles/4404969060621-Post-meeting-survey-and-reporting). **Prerequisites:** * The host must be a **Pro** user type. * The [**Meeting Survey**](https://support.zoom.us/hc/en-us/articles/4404939095053-Enabling-meeting-surveys) feature enabled in the host's account. * The meeting must be a scheduled meeting. Instant meetings do not have survey features enabled. **Scopes:** `meeting:write`,`meeting:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`

operationId: Meetings_deleteMeetingSurvey

Parameters

Name	In	Required	Type	Description
meetingId	path	required	integer	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.

Responses

204 **HTTP Status Code:** `204` Meeting survey deleted.

400 **HTTP Status Code:** `400` Bad Request **Error Code:** `300` Invalid meeting ID. **Error Code:** `3000` * Cannot access Webinar information. * Meeting survey disabled. To enable this feature, enable the "Meeting Survey" setting in the Zoom web portal's "Settings" interface. **Error Code:** `3161` Meeting hosting and scheduling capabilities are not allowed for your user account.

404 **HTTP Status Code:** `404` Not Found **Error Code:** `300` Meeting ID does not exist. **Error Code:** `3001` Meeting does not exist: {meetingId}.

DELETE /meetings/{meetingId}/survey

Sip phone 1 endpoints

DELETE /sip_phones/{phoneId} Delete SIP phone

Use this API to delete a Zoom account's SIP phone. **Prerequisites**: * Currently only supported on Cisco and Avaya PBX systems. * The user must enable **SIP Phone Integration** by contacting the [Zoom Sales](https://zoom.us/contactsales) team. **Scopes:** `sip_phone:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`

operationId: SipPhone_deletePhone

Parameters

Name	In	Required	Type	Description
phoneId	path	required	string	The SIP phone ID. It can be retrieved from the List SIP Phones API.

Responses

200 **Error Code:** `200` Permission missing: Enable SIP Phone Integration by contacting a Zoom Admin first.

204 **HTTP Status Code:** `204` SIP Phone deleted.

DELETE /sip_phones/{phoneId}

Tsp 1 endpoints

DELETE /users/{userId}/tsp/{tspId} Delete a user's TSP account

Delete a user's TSP account. **Scopes:** `tsp:write:admin`,`tsp:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`

operationId: Tsp_deleteUserTspAccount

Parameters

Name	In	Required	Type	Description
userId	path	required		The user ID or email address of the user. For user-level apps, pass the `me` value.
tspId	path	required	string	TSP account ID.

Responses

204 **Status Code:** `204` **No Content** TSP account deleted.

400 **HTTP Status Code:** `400` Bad Request **Error Code:** `2024` Account not enable TSP. **Error Code:** `300` The TSP id provided does not exist. **Error Code:** `300` TSP Config does not exist. **Error Code:** `300` At least one tsp config must be available.

404 **HTTP Status Code:** `404` Not Found **Error Code:** `1001` User does not exist: $userId. **Error Code:** `1120` A valid invitation to join the Zoom account was not found for this user. This error is thrown if you added a user in your account but the user did not accept the invitation on time and the invitation expired - thus making the userId invalid.

DELETE /users/{userId}/tsp/{tspId}

Tracking field 1 endpoints

DELETE /tracking_fields/{fieldId} Delete a tracking field

Use this API to delete a [tracking field](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields). **Prerequisites:** * A Business, Education, API or higher plan. **Scopes:** `tracking_fields:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`

operationId: TrackingField_deleteField

Parameters

Name	In	Required	Type	Description
fieldId	path	required	string	The Tracking Field ID

Responses

204 **HTTP Status Code:** `204` Tracking Field deleted

404 **HTTP Status Code:** `404` Not Found

DELETE /tracking_fields/{fieldId}

Webinars 10 endpoints

DELETE /live_webinars/{webinarId}/chat/messages/{messageId} Delete a live webinar message

Deletes a message in a live webinar based on ID. **Prerequisites:** * Have Zoom enable the DLP for the in-meeting chat feature to use this API. **Scopes:** `webinar:write`,`webinar:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`

operationId: Webinars_deleteMessageById

Parameters

Name	In	Required	Type	Description
webinarId	path	required	integer	The webinar's ID.
messageId	path	required	string	The live webinar chat message's unique identifier (UUID), in base64-encoded format.
file_ids	query	optional	string	The live webinar chat file's universally unique identifier (UUID), in base64-encoded format. Separate multiple values with commas.

Responses

204 **HTTP Status Code:** `204` Webinar chat message deleted.

400 **HTTP Status Code:** `400` Bad Request **Error Code:** `200` * Only available for paid accounts. * DLP is not enabled.

404 **HTTP Status Code:** `404` Not Found **Error Code:** `3001` Webinar {webinarId} does not exist.

DELETE /live_webinars/{webinarId}/chat/messages/{messageId}

DELETE /webinars/{webinarId} Delete a webinar

Delete a webinar. **Prerequisites:** * Pro or higher plan with the webinar add-on. **Scopes:** `webinar:write`,`webinar:write:admin` **Granular Scopes:** `webinar:delete:webinar`,`webinar:delete:webinar:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`

operationId: Webinars_removeWebinar

Parameters

Name	In	Required	Type	Description
webinarId	path	required	integer	The webinar's ID.
occurrence_id	query	optional	string	The meeting or webinar occurrence ID.
cancel_webinar_reminder	query	optional	boolean	`true` - Notify panelists and registrants about the webinar cancellation via email. `false` - Do not send any email notification to webinar registrants and panelists. The default value of this field is `false`.

Responses

204 **HTTP Status Code:** `204` Webinar deleted.

400 **HTTP Status Code:** `400` Bad Request **Error Code:** `1010` User does not belong to this account:{accountId}. **Error Code:** `3002` Sorry, you cannot delete this webinar since it is in progress. **Error Code:** `3003` You are not the webinar host. **Error Code:** `3007` Sorry, you cannot delete this webinar since it has ended. **Error Code:** `3018` Not allowed to delete PMI. **Error Code:** `3037` Not allowed to delete PAC.

404 **HTTP Status Code:** `404` Not Found **Error Code:** `1001` User {userId} does not exist or does not belong to this account. **Error Code:** `3001` Webinar {webinarId} not found or has expired.

DELETE /webinars/{webinarId}

DELETE /webinars/{webinarId}/branding/name_tags Delete a webinar's branding name tag

Use this API to delete a webinar's [Session Branding](https://support.zoom.us/hc/en-us/articles/4836268732045-Using-Webinar-Session-Branding) name tag. **Prerequisites:** * The **Webinar Session Branding** setting enabled. **Scopes:** `webinar:write`,`webinar:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`

operationId: Webinars_deleteBrandingNameTag

Parameters

Name	In	Required	Type	Description
name_tag_ids	query	optional	string	A comma-separated list of the name tag IDs to delete.
webinarId	path	required	integer	The webinar's ID.

Responses

204 **HTTP Status Code:** `204` * No content. * Name tag(s) deleted.

400 **HTTP Status Code:** `400` Bad Request **Error Code:** `300` Invalid parameter: name_tag_ids **Error Code:** `3000` This webinar does not have session branding enabled.

404 **HTTP Status Code:** `404` Not Found

DELETE /webinars/{webinarId}/branding/name_tags

DELETE /webinars/{webinarId}/branding/virtual_backgrounds Delete a webinar's branding Virtual Backgrounds

Use this API to delete a webinar's session branding [Virtual Background](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background). **Prerequisites:** * The **Webinar Session Branding** setting enabled. **Scopes:** `webinar:write`,`webinar:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`

operationId: Webinars_deleteBrandingVirtualBackground

Parameters

Name	In	Required	Type	Description
ids	query	optional	string	A comma-separated list of the Virtual Background file IDs to delete.
webinarId	path	required	integer	The webinar's ID.

Responses

204 **HTTP Status Code:** `204` * No content. * Virtual Background file(s) deleted.

400 **HTTP Status Code:** `400` Bad Request **Error Code:** `1010` User does not belong to this account: {accountId} **Error Code:** `300` Invalid parameter: ids **Error Code:** `3000` This webinar does not have session branding enabled.

404 **HTTP Status Code:** `404` Not Found **Error Code:** `1001` User "{userId}" does not exist or does not belong to this account. **Error Code:** `3001` Webinar "{webinarId}" not found or has expired.

DELETE /webinars/{webinarId}/branding/virtual_backgrounds

DELETE /webinars/{webinarId}/branding/wallpaper Delete a webinar's branding wallpaper

Use this API to delete a webinar's session branding wallpaper file. **Prerequisites:** * The **Webinar Session Branding** setting enabled. **Scopes:** `webinar:write`,`webinar:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`

operationId: Webinars_deleteBrandingWallpaper

Parameters

Name	In	Required	Type	Description
webinarId	path	required	integer	The webinar's ID.

Responses

204 **HTTP Status Code:** `204` * No content. * Webinar wallpaper deleted.

400 **HTTP Status Code:** `400` Bad Request **Error Code:** `1010` User does not belong to this account: {accountId} **Error Code:** `300` Invalid parameter: {id} **Error Code:** `3000` This webinar does not have session branding enabled.

DELETE /webinars/{webinarId}/branding/wallpaper

DELETE /webinars/{webinarId}/panelists Remove webinar panelists

Remove all the panelists from a webinar. **Prerequisites:** * Pro or a higher plan with the [webinar add-on](https://zoom.us/webinar). **Scopes:** `webinar:write`,`webinar:write:admin` **Granular Scopes:** `webinar:delete:panelist`,`webinar:delete:panelist:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`

operationId: Webinars_removePanelists

Parameters

Name	In	Required	Type	Description
webinarId	path	required	integer	The webinar's ID.

Responses

204 **HTTP Status Code:** `204` Panelists removed.

400 **HTTP Status Code:** `400` Bad Request **Error Code:** `1010` User does not belong to this account:{accountId}.

DELETE /webinars/{webinarId}/panelists

DELETE /webinars/{webinarId}/panelists/{panelistId} Remove a panelist

[Remove](https://support.zoom.us/hc/en-us/articles/115005657826-Inviting-Panelists-to-a-Webinar#h_de31f237-a91c-4fb2-912b-ecfba8ec5ffb) a single panelist from a webinar. Retrieve the `panelistId` by calling **List Panelists API**. **Prerequisites:** * Pro or a higher plan with the [webinar add-on](https://zoom.us/webinar). **Scopes:** `webinar:write`,`webinar:write:admin` **Granular Scopes:** `webinar:delete:panelist`,`webinar:delete:panelist:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`

operationId: Webinars_removePanelist

Parameters

Name	In	Required	Type	Description
webinarId	path	required	integer	The webinar's ID.
panelistId	path	required	string	The panelist's ID or email.

Responses

204 **HTTP Status Code:** `204` Panelist removed.

400 **HTTP Status Code:** `400` Bad Request **Error Code:** `1010` User {accountId} does not belong to this account.

404 **HTTP Status Code:** `404` Not Found **Error Code:** `1001` User {email} does not exist or does not belong to this account. **Error Code:** `3001` Webinar {webinarId} not found or has expired.

DELETE /webinars/{webinarId}/panelists/{panelistId}

DELETE /webinars/{webinarId}/polls/{pollId} Delete a webinar poll

Delete a webinar's [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars). **Scopes:** `webinar:write`,`webinar:write:admin` **Granular Scopes:** `webinar:delete:poll`,`webinar:delete:poll:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`

operationId: Webinars_deletePoll

Parameters

Name	In	Required	Type	Description
webinarId	path	required	integer	The webinar's ID.
pollId	path	required	string	The poll ID

Responses

204 **HTTP Status Code:** `204` Webinar Poll deleted

400 **HTTP Status Code:** `400` Bad Request **Error Code:** `4400` Webinar polls disabled. To enable this feature, enable the "Webinar Polls/Quizzes" setting in the Zoom web portal's "Settings" interface.

404 **HTTP Status Code:** `404` Not Found **Error Code:** `3001` Webinar {webinarId} not found or has expired.

DELETE /webinars/{webinarId}/polls/{pollId}

DELETE /webinars/{webinarId}/registrants/{registrantId} Delete a webinar registrant

Delete a webinar registrant. **Scopes:** `webinar:write`,`webinar:write:admin` **Granular Scopes:** `webinar:delete:registrant`,`webinar:delete:registrant:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`

operationId: Webinars_deleteRegistrant

Parameters

Name	In	Required	Type	Description
webinarId	path	required	integer	The webinar ID.
registrantId	path	required	string	The registrant ID.
occurrence_id	query	optional	string	The webinar occurrence ID.

Responses

204 **HTTP status code:** `204` OK

400 **HTTP Status Code:** `400` Bad Request **Error Code:** `200` Webinar plan is missing. You must subscribe to the webinar plan and enable webinars for this user in order to perform this action: {0}. **Error Code:** `300` The value that you entered for the Registrant ID field is invalid. Enter a valid value and try again. **Error Code:** `404` Registration has not been enabled for this webinar: {0}. **Error Code:** `3000` Registrant {0} was not found. **Error Code:** `3001` Webinar does not exist: {0}.

DELETE /webinars/{webinarId}/registrants/{registrantId}

DELETE /webinars/{webinarId}/survey Delete a webinar survey

Use this API to delete a [webinar survey](https://support.zoom.us/hc/en-us/articles/360048745651). **Prerequisites:** * A Pro or higher plan with the Webinar Add-on. * The [**Webinar Survey**](https://support.zoom.us/hc/en-us/articles/360061293191-Enabling-webinar-survey) feature enabled in the host's account. **Scopes:** `webinar:write`,`webinar:write:admin` **Granular Scopes:** `webinar:delete:survey`,`webinar:delete:survey:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`

operationId: Webinars_deleteSurvey

Parameters

Name	In	Required	Type	Description
webinarId	path	required	integer	The webinar's ID.

Responses

204 **HTTP Status Code:** `204` Webinar survey deleted.

400 **HTTP Status Code:** `400` Bad Request **Error Code:** `300` Invalid webinar ID. **Error Code:** `3000` Webinar survey disabled. To enable this feature, enable the "Webinar Survey" setting in the Zoom web portal's "Settings" interface.

404 **HTTP Status Code:** `404` Not Found **Error Code:** `300` Webinar ID does not exist. **Error Code:** `3001` Webinar does not exist: {webinarId}.

DELETE /webinars/{webinarId}/survey

Schemas

object AnalyticsDetailsResponse

{
  "type": "object",
  "properties": {
    "to": {
      "type": "string",
      "format": "date",
      "example": "2020-07-30",
      "description": "The queried end date."
    },
    "from": {
      "type": "string",
      "format": "date",
      "example": "2020-07-30",
      "description": "The queried start date"
    },
    "page_size": {
      "type": "integer",
      "example": 30,
      "maximum": 300,
      "description": "The number of records returned within a single API call."
    },
    "total_records": {
      "type": "integer",
      "example": 5,
      "description": "The total number of all the records available across pages."
    },
    "next_page_token": {
      "type": "string",
      "example": "R4aF9Oj0fVM2hhezJTEmSKaBSkfesDwGy42",
      "description": "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."
    },
    "analytics_details": {
      "type": "array",
      "items": {
        "properties": {
          "name": {
            "type": "string",
            "example": "2",
            "description": "The user's name who watched or downloaded."
          },
          "email": {
            "type": "string",
            "example": "2",
            "description": "The user's email who downloaded this Meeting Recording."
          },
          "duration": {
            "type": "integer",
            "example": 60,
            "description": "When the query type is `by_view`, this field indicates the viewing time, unit: seconds"
          },
          "date_time": {
            "type": "string",
            "format": "date-time",
            "example": "2021-07-04T22:14:57Z",
            "description": "Explicit time to watch or download the recording."
          }
        }
      },
      "description": "Analytics Detail."
    }
  }
}

object AnalyticsSummaryResponse

{
  "type": "object",
  "properties": {
    "to": {
      "type": "string",
      "format": "date",
      "example": "2020-07-30",
      "description": "The queried end date."
    },
    "from": {
      "type": "string",
      "format": "date",
      "example": "2020-07-30",
      "description": "The queried start date"
    },
    "analytics_summary": {
      "type": "array",
      "items": {
        "properties": {
          "date": {
            "type": "string",
            "example": "2022-07-06",
            "description": "Date of viewing or downloading the recording."
          },
          "views_total_count": {
            "type": "integer",
            "example": 2,
            "description": "The number of people who have watched this Meeting Recording."
          },
          "downloads_total_count": {
            "type": "integer",
            "example": 2,
            "description": "The number of people who downloaded this Meeting Recording."
          }
        }
      },
      "description": "Analytics Summary."
    }
  }
}

object ArchivingGetStatisticsResponse

{
  "type": "object",
  "properties": {
    "to": {
      "type": "string",
      "format": "date-time",
      "example": "2021-03-18T05:41:36Z",
      "description": "The queried end date."
    },
    "from": {
      "type": "string",
      "format": "date-time",
      "example": "2021-03-18T05:41:36Z",
      "description": "The queried start date."
    },
    "total_records": {
      "type": "integer",
      "example": 20,
      "description": "The total number of returned meeting records."
    },
    "statistic_by_file_status": {
      "type": "object",
      "properties": {
        "failed_file_count": {
          "type": "integer",
          "example": 1,
          "description": "The number of failed files."
        },
        "completed_file_count": {
          "type": "integer",
          "example": 1,
          "description": "The number of completed files."
        },
        "processing_file_count": {
          "type": "integer",
          "example": 1,
          "description": "The number of processing files."
        }
      },
      "description": "Statistics about archive files, by file status."
    },
    "statistic_by_file_extension": {
      "type": "object",
      "properties": {
        "m4a_file_count": {
          "type": "integer",
          "example": 1,
          "description": "The number of m4a files."
        },
        "mp4_file_count": {
          "type": "integer",
          "example": 1,
          "description": "The number of mp4 files."
        },
        "txt_file_count": {
          "type": "integer",
          "example": 1,
          "description": "The number of txt files."
        },
        "vtt_file_count": {
          "type": "integer",
          "example": 1,
          "description": "The number of vtt files."
        },
        "json_file_count": {
          "type": "integer",
          "example": 1,
          "description": "The number of json files."
        }
      },
      "description": "Statistics about archive files, by file extension."
    }
  }
}

object ArchivingMeetingFilesList200Response

{
  "type": "object",
  "required": [
    "account_name",
    "archive_files",
    "complete_time",
    "duration",
    "duration_in_second",
    "host_id",
    "id",
    "is_breakout_room",
    "meeting_type",
    "recording_count",
    "start_time",
    "status",
    "timezone",
    "topic",
    "total_size",
    "type",
    "uuid"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 553068284,
      "description": "The meeting or webinar ID, either `meetingId` or `webinarId`."
    },
    "type": {
      "enum": [
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        100
      ],
      "type": "integer",
      "example": 1,
      "description": "The type of archived meeting or webinar. \n\n If the recording is of a meeting: \n* `1` - Instant meeting. \n* `2` - Scheduled meeting. \n* `3` - A recurring meeting with no fixed time. \n* `4` - A meeting created via PMI (Personal Meeting ID). \n* `7` - A [Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC). \n* `8` - Recurring meeting with a fixed time. \n\n If the recording is of a webinar: \n* `5` - A webinar. \n* `6` - A recurring webinar without a fixed time. \n* `9` - A recurring webinar with a fixed time. \n\n If the recording is **not** from a meeting or webinar: \n\n* `100` - A [breakout room](https://support.zoom.us/hc/en-us/articles/115005769646-Participating-in-breakout-rooms)."
    },
    "uuid": {
      "type": "string",
      "example": "yO3dfhh3t467UkQ==",
      "description": "The universally unique identifier (UUID) of the recorded meeting or webinar instance. Each meeting or webinar instance generates a UUID."
    },
    "topic": {
      "type": "string",
      "example": "My Personal Meeting Room",
      "description": "The meeting or webinar topic."
    },
    "status": {
      "enum": [
        "completed",
        "processing"
      ],
      "type": "string",
      "example": "completed",
      "description": "The archive's processing status. \n* `completed` - The archive's processing is complete. \n* `processing` - The archive is processing."
    },
    "host_id": {
      "type": "string",
      "example": "Dhjdfgdkg8w",
      "description": "The host's user ID for the archived meeting or webinar."
    },
    "duration": {
      "type": "integer",
      "example": 1,
      "description": "The meeting or webinar's scheduled duration."
    },
    "group_id": {
      "type": "string",
      "example": "pvFIYKSDTum9iCDOOtQL4w,_FsqLyI0RlO6LVPeUVWi8g",
      "description": "Primary group IDs of participants who belong to your account. Each group ID is separated by a comma."
    },
    "timezone": {
      "type": "string",
      "example": "Asia/Shanghai",
      "description": "The meeting or webinar's [timezone](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones)."
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2021-04-26T05:23:18Z",
      "description": "The meeting or webinar's start time."
    },
    "total_size": {
      "type": "integer",
      "example": 364463,
      "description": "The total size of the archive file, in bytes."
    },
    "account_name": {
      "type": "string",
      "example": "account_01",
      "description": "The user's account name."
    },
    "meeting_type": {
      "enum": [
        "internal",
        "external"
      ],
      "type": "string",
      "example": "internal",
      "description": "Whether the meeting or webinar is internal or external. \n* `internal` - An internal meeting or webinar. \n* `external` - An external meeting or webinar. \n\n The `id`, `host_id`, and `topic` PII (Personal Identifiable Information) values in this response are removed when this value is `external`."
    },
    "archive_files": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "download_url",
          "encryption_fingerprint",
          "file_extension",
          "file_size",
          "file_type",
          "id",
          "individual",
          "participant_join_time",
          "participant_leave_time",
          "recording_type",
          "status"
        ],
        "properties": {
          "id": {
            "type": "string",
            "example": "a2f19f96-9294-4f51-8134-6f0eea108eb2",
            "description": "The archive file's unique ID."
          },
          "status": {
            "enum": [
              "completed",
              "processing",
              "failed"
            ],
            "type": "string",
            "example": "completed",
            "description": "The archived file's processing status. \n* `completed` - The processing of the file is complete. \n* `processing` - The file is processing. \n* `failed` - The processing of the file failed."
          },
          "file_path": {
            "type": "string",
            "example": "/9090876528/path01/demo.mp4",
            "description": "The file path to the on-premise account archive file. \n\n **Note:** The API only returns this field for [Zoom On-Premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). It does **not** return the `download_url` field."
          },
          "file_size": {
            "type": "integer",
            "example": 165743,
            "description": "The archived file's size, in bytes."
          },
          "file_type": {
            "enum": [
              "MP4",
              "M4A",
              "CHAT",
              "CC",
              "CHAT_MESSAGE"
            ],
            "type": "string",
            "example": "CHAT",
            "description": "The archive file's type. \n* `MP4` - Video file. \n* `M4A` - Audio-only file. \n* `CHAT` - A TXT file containing in-meeting chat messages. \n* `CC` - A file containing the closed captions of the recording, in VTT file format. \n* `CHAT_MESSAGE` - A JSON file encoded in base64 format containing chat messages. The file also includes waiting room chats, deleted messages, meeting emojis and non-verbal feedback."
          },
          "individual": {
            "type": "boolean",
            "example": true,
            "description": "Whether the archive file is an individual recording file. \n* `true` - An individual recording file. \n * `false` - An entire meeting file."
          },
          "auto_delete": {
            "type": "boolean",
            "example": false,
            "description": "Whether to auto delete the archived file.\n\n **Prerequisites:** \n\n* The \"Tag Archiving Files for Deletion\" feature must be enabled in OP. Contact [Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) to open.\n"
          },
          "download_url": {
            "type": "string",
            "example": "https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngBBBB",
            "description": "The URL to download the the archive file. \n\n **OAuth apps** \n\n If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) to download the file. For example: \n\n `https://{{base-domain}}/rec/archive/download/xxx--header 'Authorization: Bearer {{OAuth-access-token}}'` \n\n **Note:** This field does **not** return for [Zoom On-Premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). Instead, this API will return the `file_path` field."
          },
          "file_extension": {
            "type": "string",
            "example": "JSON",
            "description": "The archived file's extension."
          },
          "recording_type": {
            "enum": [
              "shared_screen_with_speaker_view",
              "audio_only",
              "chat_file",
              "closed_caption",
              "chat_message"
            ],
            "type": "string",
            "example": "chat_message",
            "description": "The archive file's recording type. \n* `shared_screen_with_speaker_view` \n* `audio_only` \n* `chat_file` \n* `closed_caption` \n* `chat_message` \n\n For more information, read our [Managing and sharing cloud recordings](https://support.zoom.us/hc/en-us/articles/205347605-Managing-and-sharing-cloud-recordings#h_9898497b-e736-4980-a749-d55608f10773) documentation."
          },
          "storage_location": {
            "enum": [
              "US",
              "AU",
              "BR",
              "CA",
              "EU",
              "IN",
              "JP",
              "SG",
              "CH"
            ],
            "type": "string",
            "example": "US",
            "description": "The region where the file is stored. This field returns only `Enable Distributed Compliance Archiving` op feature is enabled."
          },
          "participant_email": {
            "type": "string",
            "format": "email",
            "example": "jchill@example.com",
            "description": "The individual recording file's participant email address. This value is returned when the `individual` value is `true`. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details."
          },
          "number_of_messages": {
            "type": "integer",
            "example": 150,
            "description": "The number of `TXT` or `JSON` file messages. This field returns only when the `file_extension` is `JSON` or `TXT`"
          },
          "participant_join_time": {
            "type": "string",
            "format": "date-time",
            "example": "2021-03-12T02:07:27Z",
            "description": "The join time for the generated recording file. If this value is returned when the individual value is true, then it is the recording file's participant join time. When the individual value is false, it returns the join time for the archiving gateway."
          },
          "encryption_fingerprint": {
            "type": "string",
            "example": "abf85f0fe6a4db3cdd8c37e505e1dd18a34d9696170a14b5bc6395677472cf43",
            "description": "The archived file's encryption fingerprint, using the SHA256 hash algorithm."
          },
          "participant_leave_time": {
            "type": "string",
            "format": "date-time",
            "example": "2021-03-12T02:12:27Z",
            "description": "The leave time for the generated recording file. If this value is returned when the individual value is true, then it is the recording file's participant leave time. When the individual value is false, it returns the leave time for the archiving gateway."
          }
        }
      },
      "description": "Information about the archive files."
    },
    "complete_time": {
      "type": "string",
      "anyOf": [
        {
          "type": "object",
          "format": "date-time",
          "example": "2021-03-12T02:12:27Z",
          "minLength": 1,
          "description": "The archive completion time."
        },
        {
          "enum": [
            ""
          ],
          "type": "string",
          "description": "An empty string."
        }
      ],
      "format": "date-time",
      "example": "2021-03-12T02:57:27Z",
      "description": "The meeting or webinar's archive completion time."
    },
    "recording_count": {
      "type": "integer",
      "example": 2,
      "description": "The number of archived files returned in the API call response."
    },
    "is_breakout_room": {
      "type": "boolean",
      "example": false,
      "description": "Whether the room is a [breakout room](https://support.zoom.us/hc/en-us/articles/115005769646-Participating-in-breakout-rooms)."
    },
    "parent_meeting_id": {
      "type": "string",
      "example": "atsXxhSEQWit9t+U02HXNQ==",
      "description": "The parent meeting's universally unique ID (UUID). Each meeting or webinar instance generates a UUID. If the `is_breakout_room` value is `true`, the API returns this value."
    },
    "duration_in_second": {
      "type": "integer",
      "example": 1800,
      "description": "The meeting or webinar's duration, in seconds."
    }
  }
}

object ArchivingMeetingFilesListResponse

{
  "type": "object",
  "properties": {
    "to": {
      "type": "string",
      "format": "date-time",
      "example": "2021-03-12T02:12:27Z",
      "description": "The queried end date."
    },
    "from": {
      "type": "string",
      "format": "date-time",
      "example": "2021-03-12T02:12:27Z",
      "description": "The queried start date."
    },
    "meetings": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "account_name",
          "archive_files",
          "complete_time",
          "duration",
          "duration_in_second",
          "host_id",
          "id",
          "is_breakout_room",
          "meeting_type",
          "recording_count",
          "start_time",
          "status",
          "timezone",
          "topic",
          "total_size",
          "type",
          "uuid"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64",
            "example": 553068284,
            "description": "The meeting or webinar ID, either `meetingId` or `webinarId`."
          },
          "type": {
            "enum": [
              1,
              2,
              3,
              4,
              5,
              6,
              7,
              8,
              9,
              100
            ],
            "type": "integer",
            "example": 1,
            "description": "The type of archived meeting or webinar. \n\n Meeting recordings use these archive types. \n* `1` - Instant meeting. \n* `2` - Scheduled meeting. \n* `3` - A recurring meeting with no fixed time. \n* `4` - A meeting created via PMI (Personal Meeting ID). \n* `7` - A [Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC). \n* `8` - Recurring meeting with a fixed time. \n\n Webinar recordings use these archive types. \n* `5` - A webinar. \n* `6` - A recurring webinar without a fixed time. \n* `9` - A recurring webinar with a fixed time. \n\n If the recording is **not** from a meeting or webinar: \n\n* `100` - A [breakout room](https://support.zoom.us/hc/en-us/articles/115005769646-Participating-in-breakout-rooms)."
          },
          "uuid": {
            "type": "string",
            "example": "yO3dfhh3t467UkQ==",
            "description": "The recorded meeting or webinar instance's universally unique identifier (UUID). Each meeting or webinar instance generates a UUID."
          },
          "topic": {
            "type": "string",
            "example": "My Personal Meeting Room",
            "description": "The meeting or webinar topic."
          },
          "status": {
            "enum": [
              "completed",
              "processing"
            ],
            "type": "string",
            "example": "completed",
            "description": "The archive's processing status. \n* `completed` - The archive's processing is complete. \n* `processing` - The archive is processing."
          },
          "host_id": {
            "type": "string",
            "example": "Dhjdfgdkg8w",
            "description": "The ID of the user set as the host of the archived meeting or webinar."
          },
          "duration": {
            "type": "integer",
            "example": 1,
            "description": "The meeting or webinar's scheduled duration."
          },
          "group_id": {
            "type": "string",
            "example": "pvFIYKSDTum9iCDOOtQL4w,_FsqLyI0RlO6LVPeUVWi8g",
            "description": "Primary group IDs of participants who belong to your account. Each group ID is separated by a comma."
          },
          "timezone": {
            "type": "string",
            "example": "Asia/Shanghai",
            "description": "The meeting or webinar's [timezone](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones)."
          },
          "start_time": {
            "type": "string",
            "format": "date-time",
            "example": "2021-04-26T05:23:18Z",
            "description": "The meeting or webinar's start time."
          },
          "total_size": {
            "type": "integer",
            "example": 364463,
            "description": "The total size of the archive file, in bytes."
          },
          "account_name": {
            "type": "string",
            "example": "account_01",
            "description": "The user's account name."
          },
          "meeting_type": {
            "enum": [
              "internal",
              "external"
            ],
            "type": "string",
            "example": "internal",
            "description": "Whether the meeting or webinar is internal or external. \n* `internal` - An internal meeting or webinar. \n* `external` - An external meeting or webinar. \n\n The `id`, `host_id`, and `topic` PII (Personal Identifiable Information) values in this response are removed when this value is `external`."
          },
          "archive_files": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "download_url",
                "encryption_fingerprint",
                "file_extension",
                "file_size",
                "file_type",
                "id",
                "individual",
                "participant_join_time",
                "participant_leave_time",
                "recording_type",
                "status"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "example": "a2f19f96-9294-4f51-8134-6f0eea108eb2",
                  "description": "The archive file's unique ID."
                },
                "status": {
                  "enum": [
                    "completed",
                    "processing",
                    "failed"
                  ],
                  "type": "string",
                  "example": "completed",
                  "description": "The archived file's processing status. \n* `completed` - The processing of the file is complete. \n* `processing` - The file is processing. \n* `failed` - The processing of the file failed."
                },
                "file_path": {
                  "type": "string",
                  "example": "/9090876528/path01/demo.mp4",
                  "description": "The file path to the on-premise account archive file. \n\n **Note:** The API only returns this field for [Zoom on-premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). It does **not** return the `download_url` field."
                },
                "file_size": {
                  "type": "integer",
                  "example": 165743,
                  "description": "The archived file's size, in bytes."
                },
                "file_type": {
                  "enum": [
                    "MP4",
                    "M4A",
                    "CHAT",
                    "CC",
                    "CHAT_MESSAGE"
                  ],
                  "type": "string",
                  "example": "CHAT",
                  "description": "The archive file's type. \n* `MP4` - Video file. \n* `M4A` - Audio-only file. \n* `CHAT` - A TXT file containing in-meeting chat messages. \n* `CC` - A file containing the closed captions of the recording, in VTT file format. \n*  `CHAT_MESSAGE` - A JSON file encoded in base64 format containing chat messages. The file also includes waiting room chats, deleted messages, meeting emojis and non-verbal feedback."
                },
                "individual": {
                  "type": "boolean",
                  "example": true,
                  "description": "Whether the archive file is an individual recording file. \n* `true` - An individual recording file. \n * `false` - An entire meeting file."
                },
                "auto_delete": {
                  "type": "boolean",
                  "example": false,
                  "description": "Whether to auto delete the archived file.\n\n**Prerequisites:** \n\nEnable the \"Tag Archiving Files for Deletion\" feature in OP. Contact [Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) to open."
                },
                "download_url": {
                  "type": "string",
                  "example": "https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngBBBB",
                  "description": "The URL to download the the archive file. \n\n **OAuth apps** \n\n If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) to download the file. For example, `https://{{base-domain}}/rec/archive/download/xxx--header 'Authorization: Bearer {{OAuth-access-token}}'` \n\n **Note:** This field does **not** return for [Zoom on-premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). Instead, this API will return the `file_path` field."
                },
                "file_extension": {
                  "type": "string",
                  "example": "JSON",
                  "description": "The archived file's extension."
                },
                "recording_type": {
                  "enum": [
                    "shared_screen_with_speaker_view",
                    "audio_only",
                    "chat_file",
                    "closed_caption",
                    "chat_message"
                  ],
                  "type": "string",
                  "example": "chat_message",
                  "description": "The archive file's recording type. \n* `shared_screen_with_speaker_view` \n* `audio_only` \n* `chat_file` \n* `closed_caption` \n* `chat_message` \n\n For more information, read our [Managing and sharing cloud recordings](https://support.zoom.us/hc/en-us/articles/205347605-Managing-and-sharing-cloud-recordings#h_9898497b-e736-4980-a749-d55608f10773) documentation."
                },
                "storage_location": {
                  "enum": [
                    "US",
                    "AU",
                    "BR",
                    "CA",
                    "EU",
                    "IN",
                    "JP",
                    "SG",
                    "CH"
                  ],
                  "type": "string",
                  "example": "US",
                  "description": "The region where the file is stored. This field returns only `Enable Distributed Compliance Archiving` op feature is enabled."
                },
                "participant_email": {
                  "type": "string",
                  "format": "email",
                  "example": "jchill@example.com",
                  "description": "The individual recording file's participant email address. This value is returned when the `individual` value is `true`. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details."
                },
                "number_of_messages": {
                  "type": "integer",
                  "example": 150,
                  "description": "The number of `TXT` or `JSON` file messages. This field returns only when the `file_extension` is `JSON` or `TXT`."
                },
                "participant_join_time": {
                  "type": "string",
                  "format": "date-time",
                  "example": "2021-03-12T02:07:27Z",
                  "description": "The join time for the generated recording file. If this value is returned when the individual value is `true`, it is the recording file's participant join time. When the individual value is `false`, it returns the join time for the archiving gateway."
                },
                "encryption_fingerprint": {
                  "type": "string",
                  "example": "abf85f0fe6a4db3cdd8c37e505e1dd18a34d9696170a14b5bc6395677472cf43",
                  "description": "The archived file's encryption fingerprint, using the SHA256 hash algorithm."
                },
                "participant_leave_time": {
                  "type": "string",
                  "format": "date-time",
                  "example": "2021-03-12T02:12:27Z",
                  "description": "The leave time for the generated recording file. If this value is returned when the individual value is `true`, it is the recording file's participant leave time. When the individual value is `false`, it returns the leave time for the archiving gateway."
                }
              }
            },
            "description": "Information about the archive files."
          },
          "complete_time": {
            "type": "string",
            "anyOf": [
              {
                "type": "object",
                "format": "date-time",
                "example": "2021-03-12T02:12:27Z",
                "minLength": 1,
                "description": "The archive completion time."
              },
              {
                "enum": [
                  ""
                ],
                "type": "string",
                "description": "An empty string."
              }
            ],
            "format": "date-time",
            "example": "2021-03-12T02:57:27Z",
            "description": "The meeting or webinar's archive completion time."
          },
          "recording_count": {
            "type": "integer",
            "example": 2,
            "description": "The number of archived files returned in the API call response."
          },
          "is_breakout_room": {
            "type": "boolean",
            "example": false,
            "description": "Whether the room is a [breakout room](https://support.zoom.us/hc/en-us/articles/115005769646-Participating-in-breakout-rooms)."
          },
          "parent_meeting_id": {
            "type": "string",
            "example": "atsXxhSEQWit9t+U02HXNQ==",
            "description": "The parent meeting's universally unique ID (UUID). Each meeting or webinar instance generates a UUID. If the `is_breakout_room` value is `true`, the API returns this value."
          },
          "duration_in_second": {
            "type": "integer",
            "example": 1800,
            "description": "The meeting or webinar's duration, in seconds."
          }
        }
      },
      "description": "Information about the meeting or webinar."
    },
    "page_size": {
      "type": "integer",
      "example": 20,
      "description": "The number of records returned within a single API call."
    },
    "total_records": {
      "type": "integer",
      "example": 20,
      "description": "The total number of returned meeting records."
    },
    "next_page_token": {
      "type": "string",
      "example": "At6eWnFZ1FB3arCXnRxqHLXKhbDW18yz2i2",
      "description": "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.\n\n **Note:** if you use `next_page_token` as a parameter, your other request parameters should be changeless to make sure that the large result set is what you want. For example, if your `to` parameter is for a future time, Zoom resets this value to the current time and returns this value in the response body, along with the `next_page_token` value. Use these same `to` and `next_page_token` values in requests for the remaining results set; otherwise you will get an invalid token error."
    }
  }
}

object ArchivingUpdateAutoDeleteStatusRequest

{
  "type": "object",
  "required": [
    "auto_delete"
  ],
  "properties": {
    "auto_delete": {
      "type": "boolean",
      "example": true,
      "description": "Whether to auto-delete the archived file."
    }
  }
}

object CloudRecordingCreateRegistrantRequest

{
  "type": "object",
  "required": [
    "email",
    "first_name"
  ],
  "properties": {
    "org": {
      "type": "string",
      "example": "Cooking Org",
      "description": "The registrant's organization."
    },
    "zip": {
      "type": "string",
      "example": "94045",
      "description": "The registrant's ZIP or postal code."
    },
    "city": {
      "type": "string",
      "example": "Mountain View",
      "description": "The registrant's city."
    },
    "email": {
      "type": "string",
      "format": "email",
      "example": "jchill@example.com",
      "maxLength": 128,
      "description": "The registrant's email address. See [Email address display rules](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#email-address) for return value details."
    },
    "phone": {
      "type": "string",
      "example": "5550100",
      "description": "The registrant's phone number."
    },
    "state": {
      "type": "string",
      "example": "CA",
      "description": "The registrant's state or province."
    },
    "status": {
      "enum": [
        "approved",
        "denied",
        "pending"
      ],
      "type": "string",
      "example": "approved",
      "description": "The registrant's status: \n* `approved` &mdash; Registrant is approved. \n* `denied` &mdash; Registrant is denied. \n* `pending` &mdash; Registrant is waiting for approval."
    },
    "address": {
      "type": "string",
      "example": "1800 Amphibious Blvd.",
      "description": "The registrant's address."
    },
    "country": {
      "type": "string",
      "example": "US",
      "description": "The registrant's two-letter [country code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries)."
    },
    "comments": {
      "type": "string",
      "example": "Looking forward to the discussion.",
      "description": "The registrant's questions and comments."
    },
    "industry": {
      "type": "string",
      "example": "Food",
      "description": "The registrant's industry."
    },
    "job_title": {
      "type": "string",
      "example": "Chef",
      "description": "The registrant's job title."
    },
    "last_name": {
      "type": "string",
      "example": "Chill",
      "maxLength": 64,
      "description": "The registrant's last name."
    },
    "first_name": {
      "type": "string",
      "example": "Jill",
      "maxLength": 64,
      "description": "The registrant's first name."
    },
    "no_of_employees": {
      "enum": [
        "",
        "1-20",
        "21-50",
        "51-100",
        "101-250",
        "251-500",
        "501-1,000",
        "1,001-5,000",
        "5,001-10,000",
        "More than 10,000"
      ],
      "type": "string",
      "example": "1-20",
      "description": "The registrant's number of employees: \n* `1-20` \n* `21-50` \n* `51-100` \n* `101-250` \n* `251-500` \n* `501-1,000` \n* `1,001-5,000` \n* `5,001-10,000` \n* `More than 10,000`"
    },
    "custom_questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "example": "What do you hope to learn from this?",
            "description": "The title of the custom question."
          },
          "value": {
            "type": "string",
            "example": "Look forward to learning how you come up with new recipes and what other services you offer.",
            "maxLength": 128,
            "description": "The custom question's response value. This has a limit of 128 characters."
          }
        },
        "description": "Information about custom questions."
      },
      "description": "Information about custom questions."
    },
    "purchasing_time_frame": {
      "enum": [
        "",
        "Within a month",
        "1-3 months",
        "4-6 months",
        "More than 6 months",
        "No timeframe"
      ],
      "type": "string",
      "example": "1-3 months",
      "description": "The registrant's purchasing time frame: \n* `Within a month` \n* `1-3 months` \n* `4-6 months` \n* `More than 6 months` \n* `No timeframe`"
    },
    "role_in_purchase_process": {
      "enum": [
        "",
        "Decision Maker",
        "Evaluator/Recommender",
        "Influencer",
        "Not involved"
      ],
      "type": "string",
      "example": "Influencer",
      "description": "The registrant's role in the purchase process: \n* `Decision Maker` \n* `Evaluator/Recommender` \n* `Influencer` \n* `Not involved`"
    }
  },
  "description": " Registrant."
}

object CloudRecordingCreateRegistrantResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 6840331990,
      "description": "[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-): Unique identifier of the meeting in &quot;**long**&quot; format(represented as int64 data type in JSON), also known as the meeting number."
    },
    "topic": {
      "type": "string",
      "example": "My Personal Meeting Room",
      "description": "Meeting Topic"
    },
    "share_url": {
      "type": "string",
      "example": "https://example.com/rec/share/Qg75t7xZBtEbAkjdlgbfdngBBBB",
      "description": "Share URL for the on-demand recording. This includes the &ldquo;tk&rdquo; token for the registrant. This is similar to the token that Zoom returns in the URL response to join a registered meeting, for example: `url?tk=xxxx`. Except while the meeting registration token can be used to join the meeting, this token can only be used to watch the recording."
    },
    "registrant_id": {
      "type": "string",
      "example": "3Z7sEm0TQQieLav3c3OD_g",
      "description": "Registrant ID"
    }
  }
}

object CloudRecordingGetMeetingRecordingsResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "example": 6840331990,
      "description": "The meeting ID, also known as the meeting number."
    },
    "type": {
      "enum": [
        "1",
        "2",
        "3",
        "4",
        "5",
        "6",
        "7",
        "8",
        "9",
        "99"
      ],
      "type": "string",
      "example": "1",
      "extensions": {
        "x-enum-descriptions": [
          "Instant Meeting",
          "Scheduled Meeting",
          "Recurring Meeting with no fixed time",
          "Meeting created using a Personal Meeting ID",
          "A webinar",
          "Recurring webinar without a fixed time",
          "Personal Audio Conference",
          "Recurring meeting with a fixed time",
          "Recurring webinar with a fixed time",
          "A recording uploaded"
        ]
      },
      "description": "The recording's associated type of meeting or webinar. \n\nIf the recording is of a meeting: \n* `1` - Instant meeting. \n* `2` - Scheduled meeting. \n* `3` - A recurring meeting with no fixed time. \n* `4` - A meeting created via PMI (Personal Meeting ID). \n* `7` - A [Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC). \n* `8` - Recurring meeting with a fixed time. \n\nIf the recording is of a webinar: \n* `5` - A webinar. \n* `6` - A recurring webinar without a fixed time \n* `9` - A recurring webinar with a fixed time.\n\nIf the recording is **not** from a meeting or webinar: \n\n* `99` - A recording uploaded via the [**Recordings**](https://zoom.us/recording) interface on the Zoom Web Portal."
    },
    "uuid": {
      "type": "string",
      "example": "BOKXuumlTAGXuqwr3bLyuQ==",
      "description": "The unique meeting identifier. Each instance of the meeting has its own UUID."
    },
    "topic": {
      "type": "string",
      "example": "My Personal Meeting",
      "description": "The meeting topic."
    },
    "host_id": {
      "type": "string",
      "example": "_0ctZtY0REqWalTmwvrdIw",
      "description": "The ID of the user set as host of meeting."
    },
    "duration": {
      "type": "integer",
      "example": 20,
      "description": "The meeting duration."
    },
    "password": {
      "type": "string",
      "example": "981651",
      "description": "The cloud recording's passcode."
    },
    "account_id": {
      "type": "string",
      "example": "Cx3wERazSgup7ZWRHQM8-w",
      "description": "The user account's unique identifier."
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2021-03-18T05:41:36Z",
      "description": "The time when the meeting started."
    },
    "total_size": {
      "type": "integer",
      "format": "int64",
      "example": 22,
      "description": "The recording's total file size. This includes the `recording_files` and `participant_audio_files` files."
    },
    "recording_count": {
      "type": "integer",
      "example": 22,
      "description": " The number of recording files returned in the response of this API call. This includes the `recording_files` and  `participant_audio_files` files."
    },
    "recording_files": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "72576a1f-4e66-4a77-87c4-f13f9808bd76",
            "description": "The recording file ID. It's included in the response of general query."
          },
          "status": {
            "enum": [
              "completed"
            ],
            "type": "string",
            "example": "completed",
            "description": "The recording status."
          },
          "play_url": {
            "type": "string",
            "example": "https://example.com/rec/play/Qg75t7xZBtEbAkjdlgbfdngBBBB",
            "description": "The URL that can play a recording file."
          },
          "file_path": {
            "type": "string",
            "example": "/9090876528/path01/demo.mp4",
            "description": "The file path to the on-premise account recording. \n\n**Note:** This API only returns this field for [Zoom On-Premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). It does **not** return the `download_url` field."
          },
          "file_size": {
            "type": "number",
            "example": 7220,
            "description": "The recording file size."
          },
          "file_type": {
            "enum": [
              "MP4",
              "M4A",
              "CHAT",
              "TRANSCRIPT",
              "CSV",
              "TB",
              "CC",
              "CHAT_MESSAGE",
              "SUMMARY"
            ],
            "type": "string",
            "example": "MP4",
            "description": "The recording file type. \n \n`MP4` - Video file of the recording.  \n `M4A` - Audio-only file of the recording.  \n `TIMELINE` - Timestamp file of the recording in JSON file format. To get a timeline file, the **Add a timestamp to the recording** setting must be enabled in the [recording settings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-recording#h_3f14c3a4-d16b-4a3c-bbe5-ef7d24500048). The time will display in the host's timezone, set on their Zoom profile.\n  \n  `TRANSCRIPT` - Transcription file of the recording in VTT format.  \n  `CHAT` - A TXT file containing in-meeting chat messages that were sent during the meeting.  \n `CC` - File containing closed captions of the recording in VTT file format.  \n `CSV` - File containing polling data in csv format.\n\n  \n \n\nA recording file object with file type of either `CC` or `TIMELINE` **does not have** these properties.  \n \n\t`id`, `status`, `file_size`, `recording_type`, and `play_url`.  \n `SUMMARY` - Summary file of the recording in JSON file format."
          },
          "meeting_id": {
            "type": "string",
            "example": "L0AGOEPVR9m5WSOOs/d+FQ==",
            "description": "The meeting ID. "
          },
          "deleted_time": {
            "type": "string",
            "example": "2021-03-18T05:41:36Z",
            "description": "The time when recording was deleted. Returned in the response only for trash query."
          },
          "download_url": {
            "type": "string",
            "example": "https://example.com/rec/download/Qg75t7xZBtEbAkjdlgbfdngBBBB",
            "description": "The URL to download the recording. \n\nIf a user has authorized and installed your OAuth app that contains recording scopes, use the `download_access_token` or the the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) to download the file, and set the `access_token` as a Bearer token in the Authorization header.\n\n`curl -H 'Authorization: Bearer <ACCESS_TOKEN>' https://{{base-domain}}/rec/archive/download/xyz`.\n\n**Note:** This field does **not** return for [Zoom on-premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). Instead, this API returns the `file_path` field."
          },
          "recording_end": {
            "type": "string",
            "example": "2021-03-18T05:41:36Z",
            "description": "The recording end time. The response is in general query."
          },
          "file_extension": {
            "enum": [
              "MP4",
              "M4A",
              "TXT",
              "VTT",
              "CSV",
              "JSON",
              "JPG"
            ],
            "type": "string",
            "example": "M4A",
            "description": "The file extension type of the recording file."
          },
          "recording_type": {
            "enum": [
              "shared_screen_with_speaker_view(CC)",
              "shared_screen_with_speaker_view",
              "shared_screen_with_gallery_view",
              "active_speaker",
              "gallery_view",
              "shared_screen",
              "audio_only",
              "audio_transcript",
              "chat_file",
              "poll",
              "host_video",
              "closed_caption",
              "timeline",
              "thumbnail",
              "audio_interpretation",
              "summary",
              "summary_next_steps",
              "summary_smart_chapters",
              "sign_interpretation",
              "production_studio"
            ],
            "type": "string",
            "example": "shared_screen_with_speaker_view",
            "description": "The recording type.  \n `shared_screen_with_speaker_view(CC)`  \n `shared_screen_with_speaker_view`  \n `shared_screen_with_gallery_view`  \n `speaker_view`  \n `gallery_view`  \n `shared_screen`  \n `audio_only`  \n `audio_transcript`  \n `chat_file`  \n `active_speaker`  \n `poll`  \n `timeline`  \n `closed_caption`  \n `audio_interpretation`  \n `summary`  \n `summary_next_steps`  \n `summary_smart_chapters`  \n `sign_interpretation`  \n `production_studio`"
          },
          "recording_start": {
            "type": "string",
            "example": "2021-03-18T05:41:36Z",
            "description": "The recording start time."
          }
        },
        "description": "Recording file object."
      },
      "description": "The list of recording file."
    },
    "download_access_token": {
      "type": "string",
      "example": "abJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJodHRwczovL2V2ZW50Lnpvb20udXMiLCJhY2NvdW50SWQiOiJNdDZzdjR1MFRBeVBrd2dzTDJseGlBIiwiYXVkIjoiaHR0cHM6Ly9vYXV0aC56b29tLnVzIiwibWlkIjoieFp3SEc0c3BRU2VuekdZWG16dnpiUT09IiwiZXhwIjoxNjI2MTM5NTA3LCJ1c2VySWQiOiJEWUhyZHBqclMzdWFPZjdkUGtrZzh3In0.a6KetiC6BlkDhf1dP4KBGUE1bb2brMeraoD45yhFx0eSSSTFdkHQnsKmlJQ-hdo9Zy-4vQw3rOxlyoHv583JyZ",
      "description": "The JWT token to download the meeting's recording. This response only returns if the `download_access_token` is included in the `include_fields` query parameter."
    },
    "participant_audio_files": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "a2f19f96-9294-4f51-8134-6f0eea108eb2",
            "description": "The recording file's unique ID. This is included in the general query response."
          },
          "status": {
            "enum": [
              "completed"
            ],
            "type": "string",
            "example": "completed",
            "description": "The recording file's status."
          },
          "play_url": {
            "type": "string",
            "example": "https://example.com/rec/play/Qg75t7xZBtEbAkjdlgbfdngBBBB",
            "description": "The URL where the recording file can be opened and played."
          },
          "file_name": {
            "type": "string",
            "example": "test.json",
            "description": "The recording file's name."
          },
          "file_path": {
            "type": "string",
            "example": "/9090876528/path01/demo.mp4",
            "description": "The file path to the on-premise account recording. \n\n**Note:** This API only returns this field for [Zoom on-premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). It does **not** return the `download_url` field."
          },
          "file_size": {
            "type": "number",
            "example": 65536,
            "description": "The recording file's size, in bytes."
          },
          "file_type": {
            "type": "string",
            "example": "M4A",
            "description": "The recording file's format. \n\n* `MP4` - Video file.\n* `M4A` - Audio-only file.\n* `TIMELINE` - Timestamp file of the recording, in JSON file format. To get a timeline file, the **Add a timestamp to the recording** setting **must** be enabled in the [recording settings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-recording#h_3f14c3a4-d16b-4a3c-bbe5-ef7d24500048). The time will display in the host's timezone.\n* `TRANSCRIPT` - A transcript of the recording, in VTT format.\n* `CHAT` - A text file containing chat messages sent during the meeting.\n* `CC` - A file containing the closed captions of the recording, in VTT file format.\n* `CSV` - A file containing polling data, in CSV format.\n\nA recording file object with file the `CC` or `TIMELINE` value **does not** have the `id`, `status`, `file_size`, `recording_type`, and `play_url` properties."
          },
          "download_url": {
            "type": "string",
            "example": "https://example.com/rec/download/Qg75t7xZBtEbAkjdlgbfdngBBBB",
            "description": "The URL to download the recording. If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) to download the file, and set the `access_token` as a Bearer token in the Authorization header.\n\n`curl -H 'Authorization: Bearer <ACCESS_TOKEN>' https://{{base-domain}}/rec/archive/download/xyz` \n\n**Note:** This field does **not** return for [Zoom On-Premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). Instead, this API will return the `file_path` field."
          },
          "recording_end": {
            "type": "string",
            "format": "date-time",
            "example": "2021-06-30T22:14:57Z",
            "description": "The recording file's end time. This is included in the general query response."
          },
          "recording_start": {
            "type": "string",
            "format": "date-time",
            "example": "2021-06-30T22:14:57Z",
            "description": "The recording file's start time."
          }
        },
        "description": "The recording file object."
      },
      "description": "A list of recording files. The API only returns this response when the **Record a separate audio file of each participant** setting is enabled."
    },
    "recording_play_passcode": {
      "type": "string",
      "example": "yNYIS408EJygs7rE5vVsJwXIz4-VW7MH",
      "description": "The cloud recording's passcode to be used in the URL. Directly splice this recording's passcode in `play_url` or `share_url` with `?pwd=` to access and play. Example: 'https://zoom.us/rec/share/**************?pwd=yNYIS408EJygs7rE5vVsJwXIz4-VW7MH'."
    }
  },
  "description": "This field returns a list of recording files for each participant. The API only returns this response when the **Record a separate audio file of each participant** setting is enabled."
}

object CloudRecordingGetSettingsResponse

{
  "type": "object",
  "title": "Recording settings",
  "properties": {
    "topic": {
      "type": "string",
      "example": "My Personal Meeting Room",
      "description": "The name of the recording."
    },
    "password": {
      "type": "string",
      "example": "975238724",
      "maxLength": 10,
      "minLength": 8,
      "description": "This field enables passcode protection for the recording by setting a passcode. The passcode must have a minimum of **eight** characters with a mix of numbers, letters and special characters.  \n   \n \n**Note:** If the account owner or the admin has set minimum passcode strength requirements for recordings through Account Settings, the passcode value provided here must meet those requirements.   \n   \n If the requirements are enabled, you can view those requirements by calling either the [**Get user settings**](/api-reference/zoom-api/methods#operation/userSettings) API or the [**Get account settings**](/api-reference/zoom-api/ma#operation/accountSettings) API."
    },
    "on_demand": {
      "type": "boolean",
      "example": false,
      "description": "This field determines whether registration is required to view the recording."
    },
    "approval_type": {
      "enum": [
        0,
        1,
        2
      ],
      "type": "integer",
      "example": 0,
      "extensions": {
        "x-enum-descriptions": [
          "Registrants can watch the recording directly after registration",
          "Registrants receive emails then watch the recording after you approve the registration",
          "Disabled"
        ]
      },
      "description": "The approval type for the registration.  \n \n`0`- Automatically approve the registration when a user registers.  \n \n`1` - Manually approve or deny the registration of a user.  \n \n`2` - No registration required to view the recording."
    },
    "share_recording": {
      "enum": [
        "publicly",
        "internally",
        "none"
      ],
      "type": "string",
      "example": "publicly",
      "extensions": {
        "x-enum-descriptions": [
          "Publicly",
          "Internally(account members only)",
          "None"
        ]
      },
      "description": "This field determines how the meeting recording is shared."
    },
    "viewer_download": {
      "type": "boolean",
      "example": true,
      "description": "This field determines whether a viewer can download the recording file or not."
    },
    "send_email_to_host": {
      "type": "boolean",
      "example": false,
      "description": "This field enables you to send an email to the host when someone registers to view the recording. This applies for On-demand recordings only."
    },
    "authentication_option": {
      "type": "string",
      "example": "auth_option",
      "description": "The options for authentication ."
    },
    "authentication_domains": {
      "type": "string",
      "example": "test.com",
      "description": "The domains for authentication."
    },
    "recording_authentication": {
      "type": "boolean",
      "example": true,
      "description": "THis field only authenticated users can view."
    },
    "show_social_share_buttons": {
      "type": "boolean",
      "example": true,
      "description": "This field shows social share buttons on registration page. This applies for On-demand recordings only."
    }
  }
}

object CloudRecordingListRecordingsResponse

{
  "type": "object",
  "properties": {
    "to": {
      "type": "string",
      "format": "date",
      "example": "2022-04-01",
      "description": "The end date."
    },
    "from": {
      "type": "string",
      "format": "date",
      "example": "2022-01-01",
      "description": "The start date."
    },
    "meetings": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "example": 6840331990,
            "description": "Meeting ID - also known as the meeting number."
          },
          "type": {
            "enum": [
              "1",
              "2",
              "3",
              "4",
              "5",
              "6",
              "7",
              "8",
              "9",
              "99"
            ],
            "type": "string",
            "example": "1",
            "extensions": {
              "x-enum-descriptions": [
                "Instant Meeting",
                "Scheduled Meeting",
                "Recurring Meeting with no fixed time",
                "Meeting created using a Personal Meeting ID",
                "A webinar",
                "Recurring webinar without a fixed time",
                "Personal Audio Conference",
                "Recurring meeting with a fixed time",
                "Recurring webinar with a fixed time",
                "A recording uploaded"
              ]
            },
            "description": "The recording's associated type of meeting or webinar: \n\nIf the recording is of a meeting: \n* `1` - Instant meeting. \n* `2` - Scheduled meeting. \n* `3` - A recurring meeting with no fixed time. \n* `4` - A meeting created viaPersonal Meeting ID (PMI). \n* `7` - A [Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC). \n* `8` - Recurring meeting with a fixed time. \n\nIf the recording is of a webinar: \n* `5` - A webinar. \n* `6` - A recurring webinar without a fixed time \n* `9` - A recurring webinar with a fixed time.\n\nIf the recording is **not** from a meeting or webinar: \n\n* `99` - A recording uploaded via the [**Recordings**](https://zoom.us/recording) interface on the Zoom Web Portal."
          },
          "uuid": {
            "type": "string",
            "example": "BOKXuumlTAGXuqwr3bLyuQ==",
            "description": "Unique Meeting Identifier. Each instance of the meeting will have its own UUID."
          },
          "topic": {
            "type": "string",
            "example": "My Personal Meeting",
            "description": "Meeting topic."
          },
          "host_id": {
            "type": "string",
            "example": "_0ctZtY0REqWalTmwvrdIw",
            "description": "ID of the user set as host of meeting."
          },
          "duration": {
            "type": "integer",
            "example": 20,
            "description": "Meeting duration."
          },
          "account_id": {
            "type": "string",
            "example": "Cx3wERazSgup7ZWRHQM8-w",
            "description": "Unique Identifier of the user account."
          },
          "start_time": {
            "type": "string",
            "format": "date-time",
            "example": "2021-03-18T05:41:36Z",
            "description": "The time when the meeting started."
          },
          "total_size": {
            "type": "integer",
            "format": "int64",
            "example": 22,
            "description": "The total file size of the recording. This includes the `recording_files` and `participant_audio_files` files."
          },
          "recording_count": {
            "type": "integer",
            "example": 22,
            "description": "Number of recording files returned in the response of this API call. This includes the `recording_files` and  `participant_audio_files` files."
          },
          "recording_files": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "example": "72576a1f-4e66-4a77-87c4-f13f9808bd76",
                  "description": "The recording file ID. Included in the response of general query."
                },
                "status": {
                  "enum": [
                    "completed"
                  ],
                  "type": "string",
                  "example": "completed",
                  "description": "The recording status."
                },
                "play_url": {
                  "type": "string",
                  "example": "https://example.com/rec/play/Qg75t7xZBtEbAkjdlgbfdngBBBB",
                  "description": "The URL to play a recording file."
                },
                "file_path": {
                  "type": "string",
                  "example": "/9090876528/path01/demo.mp4",
                  "description": "The file path to the On-Premise account recording. \n\n**Note:** This API only returns this field for [Zoom On-Premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). It does **not** return the `download_url` field."
                },
                "file_size": {
                  "type": "number",
                  "example": 7220,
                  "description": "The recording file size."
                },
                "file_type": {
                  "enum": [
                    "MP4",
                    "M4A",
                    "CHAT",
                    "TRANSCRIPT",
                    "CSV",
                    "TB",
                    "CC",
                    "CHAT_MESSAGE",
                    "SUMMARY"
                  ],
                  "type": "string",
                  "example": "MP4",
                  "description": "The recording file type.  \n \n`MP4` - Video file of the recording.  \n `M4A` Audio-only file of the recording.  \n `TIMELINE` - Timestamp file of the recording in JSON file format. To get a timeline file, the **Add a timestamp to the recording** setting must be enabled in the [recording settings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-recording#h_3f14c3a4-d16b-4a3c-bbe5-ef7d24500048). The time will display in the host's timezone, set on their Zoom profile.\n  \n  `TRANSCRIPT` - Transcription file of the recording in VTT format.  \n  `CHAT` - A TXT file containing in-meeting chat messages that were sent during the meeting.  \n `CC` - File containing closed captions of the recording in VTT file format.  \n `CSV` - File containing polling data in CSV format.\n\n  \n \n\nA recording file object with file type of either `CC` or `TIMELINE` **does not have** the following properties:  \n \n\t`id`, `status`, `file_size`, `recording_type`, and `play_url`.  \n `SUMMARY` - Summary file of the recording in JSON file format."
                },
                "meeting_id": {
                  "type": "string",
                  "example": "L0AGOEPVR9m5WSOOs/d+FQ==",
                  "description": "The meeting ID. "
                },
                "deleted_time": {
                  "type": "string",
                  "example": "2021-03-18T05:41:36Z",
                  "description": "The time when recording was deleted. Returned in the response only for trash query."
                },
                "download_url": {
                  "type": "string",
                  "example": "https://example.com/rec/download/Qg75t7xZBtEbAkjdlgbfdngBBBB",
                  "description": "The URL to download the recording. \n\n**OAuth apps** \n\nIf a user has authorized and installed your OAuth app that contains recording scopes, use the download_access_token or the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) to download the file, and set the access_token as a Bearer token in the Authorization header. \n\n`curl -H 'Authorization: Bearer <ACCESS_TOKEN>' https://{{base-domain}}/rec/archive/download/xyz`. \n\n**Note:** This field does **not** return for [Zoom On-Premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). Instead, this API will return the `file_path` field."
                },
                "recording_end": {
                  "type": "string",
                  "example": "2021-03-18T05:41:36Z",
                  "description": "The recording end time. Response in general query."
                },
                "file_extension": {
                  "enum": [
                    "MP4",
                    "M4A",
                    "TXT",
                    "VTT",
                    "CSV",
                    "JSON",
                    "JPG"
                  ],
                  "type": "string",
                  "example": "M4A",
                  "description": "The file extension type of the recording file."
                },
                "recording_type": {
                  "enum": [
                    "shared_screen_with_speaker_view(CC)",
                    "shared_screen_with_speaker_view",
                    "shared_screen_with_gallery_view",
                    "active_speaker",
                    "gallery_view",
                    "shared_screen",
                    "audio_only",
                    "audio_transcript",
                    "chat_file",
                    "poll",
                    "host_video",
                    "closed_caption",
                    "timeline",
                    "thumbnail",
                    "audio_interpretation",
                    "summary",
                    "summary_next_steps",
                    "summary_smart_chapters",
                    "sign_interpretation",
                    "production_studio"
                  ],
                  "type": "string",
                  "example": "shared_screen_with_speaker_view",
                  "description": "The recording type.  \n `shared_screen_with_speaker_view(CC)`  \n `shared_screen_with_speaker_view`  \n `shared_screen_with_gallery_view`  \n `speaker_view`  \n `gallery_view`  \n `shared_screen`  \n `audio_only`  \n `audio_transcript`  \n `chat_file`  \n `active_speaker`  \n `poll`  \n `timeline`  \n `closed_caption`  \n `audio_interpretation`  \n `summary`  \n `summary_next_steps`  \n `summary_smart_chapters`  \n `sign_interpretation`  \n `production_studio`"
                },
                "recording_start": {
                  "type": "string",
                  "example": "2021-03-18T05:41:36Z",
                  "description": "The recording start time."
                }
              },
              "description": "Recording file object."
            },
            "description": "List of recording file."
          },
          "recording_play_passcode": {
            "type": "string",
            "example": "yNYIS408EJygs7rE5vVsJwXIz4-VW7MH",
            "description": "The cloud recording's passcode to be used in the URL. This recording's passcode can be directly spliced in `play_url` or `share_url` with `?pwd=` to access and play. For example, 'https://zoom.us/rec/share/**************?pwd=yNYIS408EJygs7rE5vVsJwXIz4-VW7MH'. If you want to use this field, please contact Zoom support."
          }
        },
        "description": "The recording meeting object."
      },
      "description": "List of recordings."
    },
    "page_size": {
      "type": "integer",
      "default": 30,
      "example": 30,
      "maximum": 300,
      "description": "The number of records returned within a single API call."
    },
    "page_count": {
      "type": "integer",
      "example": 1,
      "description": "The number of pages returned for the request made."
    },
    "total_records": {
      "type": "integer",
      "example": 1,
      "description": "The number of all records available across pages."
    },
    "next_page_token": {
      "type": "string",
      "example": "Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3",
      "description": "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."
    }
  },
  "description": "The pagination object."
}

object CloudRecordingListRegistrantsResponse

{
  "type": "object",
  "title": "Meeting Cloud Recording Registration",
  "properties": {
    "page_size": {
      "type": "integer",
      "default": 30,
      "example": 30,
      "maximum": 300,
      "description": "The number of records returned with a single API call."
    },
    "page_count": {
      "type": "integer",
      "example": 1,
      "description": "The number of pages returned for the request made."
    },
    "page_number": {
      "type": "integer",
      "default": 1,
      "example": 1,
      "deprecated": true,
      "description": "**Deprecated.** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination."
    },
    "registrants": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "email",
          "first_name"
        ],
        "properties": {
          "id": {
            "type": "string",
            "example": "3Z7sEm0TQQieLav3c3OD_g",
            "description": "The registrant's ID."
          },
          "org": {
            "type": "string",
            "example": "Cooking Org",
            "description": "The registrant's organization."
          },
          "zip": {
            "type": "string",
            "example": "94045",
            "description": "The registrant's ZIP or postal code."
          },
          "city": {
            "type": "string",
            "example": "Mountain View",
            "description": "The registrant's city."
          },
          "email": {
            "type": "string",
            "format": "email",
            "example": "jchill@example.com",
            "maxLength": 128,
            "description": "The registrant's email address. See [Email address display rules](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#email-address) for return value details."
          },
          "phone": {
            "type": "string",
            "example": "5550100",
            "description": "The registrant's phone number."
          },
          "state": {
            "type": "string",
            "example": "CA",
            "description": "The registrant's state or province."
          },
          "status": {
            "enum": [
              "approved",
              "denied",
              "pending"
            ],
            "type": "string",
            "example": "approved",
            "description": "The registrant's status: \n* `approved` &mdash; Registrant is approved. \n* `denied` &mdash; Registrant is denied. \n* `pending` &mdash; Registrant is waiting for approval."
          },
          "address": {
            "type": "string",
            "example": "1800 Amphibious Blvd.",
            "description": "The registrant's address."
          },
          "country": {
            "type": "string",
            "example": "US",
            "description": "The registrant's two-letter [country code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries)."
          },
          "comments": {
            "type": "string",
            "example": "Looking forward to the discussion.",
            "description": "The registrant's questions and comments."
          },
          "industry": {
            "type": "string",
            "example": "Food",
            "description": "The registrant's industry."
          },
          "job_title": {
            "type": "string",
            "example": "Chef",
            "description": "The registrant's job title."
          },
          "last_name": {
            "type": "string",
            "example": "Chill",
            "maxLength": 64,
            "description": "The registrant's last name."
          },
          "first_name": {
            "type": "string",
            "example": "Jill",
            "maxLength": 64,
            "description": "The registrant's first name."
          },
          "no_of_employees": {
            "enum": [
              "",
              "1-20",
              "21-50",
              "51-100",
              "101-250",
              "251-500",
              "501-1,000",
              "1,001-5,000",
              "5,001-10,000",
              "More than 10,000"
            ],
            "type": "string",
            "example": "1-20",
            "description": "The registrant's number of employees: \n* `1-20` \n* `21-50` \n* `51-100` \n* `101-250` \n* `251-500` \n* `501-1,000` \n* `1,001-5,000` \n* `5,001-10,000` \n* `More than 10,000`"
          },
          "custom_questions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "title": {
                  "type": "string",
                  "example": "What do you hope to learn from this?",
                  "description": "The title of the custom question."
                },
                "value": {
                  "type": "string",
                  "example": "Look forward to learning how you come up with new recipes and what other services you offer.",
                  "maxLength": 128,
                  "description": "The custom question's response value. This has a limit of 128 characters."
                }
              },
              "description": "Information about custom questions."
            },
            "description": "Information about custom questions."
          },
          "purchasing_time_frame": {
            "enum": [
              "",
              "Within a month",
              "1-3 months",
              "4-6 months",
              "More than 6 months",
              "No timeframe"
            ],
            "type": "string",
            "example": "1-3 months",
            "description": "The registrant's purchasing time frame: \n* `Within a month` \n* `1-3 months` \n* `4-6 months` \n* `More than 6 months` \n* `No timeframe`"
          },
          "role_in_purchase_process": {
            "enum": [
              "",
              "Decision Maker",
              "Evaluator/Recommender",
              "Influencer",
              "Not involved"
            ],
            "type": "string",
            "example": "Influencer",
            "description": "The registrant's role in the purchase process: \n* `Decision Maker` \n* `Evaluator/Recommender` \n* `Influencer` \n* `Not involved`"
          }
        },
        "description": " Registrant."
      },
      "description": "Information about the cloud recording registrants."
    },
    "total_records": {
      "type": "integer",
      "example": 20,
      "description": "The total number of all the records available across pages."
    },
    "next_page_token": {
      "type": "string",
      "example": "w7587w4eiyfsudgf",
      "description": "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."
    }
  },
  "description": "Information about the meeting cloud recording registrant."
}

object CloudRecordingListRegistrationQuestionsResponse

{
  "type": "object",
  "title": "Recording Registrant Questions",
  "properties": {
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "required": {
            "type": "boolean",
            "example": true,
            "description": "State whether the field is required to be answered by the registrant or not."
          },
          "field_name": {
            "enum": [
              "last_name",
              "address",
              "city",
              "country",
              "zip",
              "state",
              "phone",
              "industry",
              "org",
              "job_title",
              "purchasing_time_frame",
              "role_in_purchase_process",
              "no_of_employees",
              "comments"
            ],
            "type": "string",
            "example": "last_name",
            "extensions": {
              "x-enum-descriptions": [
                "Last Name",
                "Address",
                "City",
                "Country/Region",
                "Zip/Postal Code",
                "State/Province",
                "Phone",
                "Industry",
                "Organization",
                "Job Title",
                "Purchasing Time Frame",
                "Role in Purchase Process",
                "Number of Employees",
                "Questions & Comments"
              ]
            },
            "description": "Field name."
          }
        }
      },
      "description": "Array of Registrant Questions"
    },
    "custom_questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "enum": [
              "short",
              "single",
              "multiple"
            ],
            "type": "string",
            "example": "short",
            "extensions": {
              "x-enum-descriptions": [
                "Short Answer",
                "Single Answer",
                "Multiple Answer"
              ]
            },
            "description": "The type of registration question and answers."
          },
          "title": {
            "type": "string",
            "example": "What's your name?",
            "description": "Title of the question."
          },
          "answers": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "Yes"
            },
            "description": "Answer choices for the question. Can not be used with Short answer type."
          },
          "required": {
            "type": "boolean",
            "example": true,
            "description": "State whether registrants are required to answer custom questions or not."
          }
        }
      },
      "description": "Array of Registrant Custom Questions"
    }
  },
  "description": "Recording Registrant Questions"
}

object CloudRecordingRecoverRecordingStatusRequest

{
  "type": "object",
  "properties": {
    "action": {
      "enum": [
        "recover"
      ],
      "type": "string",
      "example": "recover",
      "extensions": {
        "x-enum-descriptions": [
          "recover meeting recording"
        ]
      }
    }
  }
}

object CloudRecordingRecoverStatusRequest

{
  "type": "object",
  "properties": {
    "action": {
      "enum": [
        "recover"
      ],
      "type": "string",
      "example": "recover",
      "extensions": {
        "x-enum-descriptions": [
          "recover meeting recording"
        ]
      }
    }
  }
}

object CloudRecordingUpdateRegistrantStatusRequest

{
  "type": "object",
  "required": [
    "action"
  ],
  "properties": {
    "action": {
      "enum": [
        "approve",
        "deny"
      ],
      "type": "string",
      "example": "approve",
      "extensions": {
        "x-enum-descriptions": [
          "Approve registrant",
          "Deny registrant"
        ]
      }
    },
    "registrants": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "3Z7sEm0TQQieLav3c3OD_g"
          }
        }
      },
      "maximum": 30,
      "description": "List of registrants"
    }
  },
  "description": "Registrant Status"
}

object CloudRecordingUpdateRegistrationQuestionsRequest

{
  "type": "object",
  "title": "Recording Registrant Questions",
  "properties": {
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "required": {
            "type": "boolean",
            "example": true,
            "description": "State whether the field is required to be answered by the registrant or not."
          },
          "field_name": {
            "enum": [
              "last_name",
              "address",
              "city",
              "country",
              "zip",
              "state",
              "phone",
              "industry",
              "org",
              "job_title",
              "purchasing_time_frame",
              "role_in_purchase_process",
              "no_of_employees",
              "comments"
            ],
            "type": "string",
            "example": "last_name",
            "extensions": {
              "x-enum-descriptions": [
                "Last Name",
                "Address",
                "City",
                "Country/Region",
                "Zip/Postal Code",
                "State/Province",
                "Phone",
                "Industry",
                "Organization",
                "Job Title",
                "Purchasing Time Frame",
                "Role in Purchase Process",
                "Number of Employees",
                "Questions & Comments"
              ]
            },
            "description": "Field name."
          }
        }
      },
      "description": "Array of Registrant Questions"
    },
    "custom_questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "enum": [
              "short",
              "single",
              "multiple"
            ],
            "type": "string",
            "example": "short",
            "extensions": {
              "x-enum-descriptions": [
                "Short Answer",
                "Single Answer",
                "Multiple Answer"
              ]
            },
            "description": "The type of registration question and answers."
          },
          "title": {
            "type": "string",
            "example": "What's your name?",
            "description": "Title of the question."
          },
          "answers": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "Yes"
            },
            "description": "Answer choices for the question. Can not be used with Short answer type."
          },
          "required": {
            "type": "boolean",
            "example": true,
            "description": "State whether registrants are required to answer custom questions or not."
          }
        }
      },
      "description": "Array of Registrant Custom Questions"
    }
  },
  "description": "Recording Registrant Questions"
}

object CloudRecordingUpdateSettingsRequest

{
  "type": "object",
  "title": "Recording settings",
  "properties": {
    "topic": {
      "type": "string",
      "example": "My Personal Meeting Room",
      "description": "The name of the recording."
    },
    "password": {
      "type": "string",
      "example": "975238724",
      "maxLength": 10,
      "minLength": 8,
      "description": "This field enables passcode protection for the recording by setting a passcode. \n\nThe passcode must have a minimum of **eight** characters with a mix of numbers, letters and special characters.  \n   \n \n**Note:** If the account owner or the admin has set minimum passcode strength requirements for recordings through Account Settings, the passcode value provided here must meet those requirements.   \n   \n If the requirements are enabled, you can view those requirements by calling either the [**Get user settings**](/api-reference/zoom-api/methods#operation/userSettings) API or the [**Get account settings**](/api-reference/zoom-api/ma#operation/accountSettings) API."
    },
    "on_demand": {
      "type": "boolean",
      "example": false,
      "description": "This field determines whether the registration is required to view the recording."
    },
    "approval_type": {
      "enum": [
        0,
        1,
        2
      ],
      "type": "integer",
      "example": 0,
      "extensions": {
        "x-enum-descriptions": [
          "Registrants can watch the recording directly after registration",
          "Registrants will receive emails then watch the recording after you approve the registration",
          "Disabled"
        ]
      },
      "description": "The approval type for the registration.  \n \n`0`- Automatically approve the registration when a user registers.  \n \n`1` - Manually approve or deny the registration of a user.  \n \n`2` - No registration required to view the recording."
    },
    "share_recording": {
      "enum": [
        "publicly",
        "internally",
        "none"
      ],
      "type": "string",
      "example": "publicly",
      "extensions": {
        "x-enum-descriptions": [
          "Publicly",
          "Internally(account members only)",
          "None"
        ]
      },
      "description": "This field determines how the meeting recording is shared."
    },
    "viewer_download": {
      "type": "boolean",
      "example": true,
      "description": "This field determines whether a viewer can download the recording file or not."
    },
    "send_email_to_host": {
      "type": "boolean",
      "example": false,
      "description": "This field sends an email to host when someone registers to view the recording. This setting applies for On-demand recordings only."
    },
    "authentication_option": {
      "type": "string",
      "example": "auth_option",
      "description": "The authentication options."
    },
    "authentication_domains": {
      "type": "string",
      "example": "test.com",
      "description": "The authentication domains."
    },
    "recording_authentication": {
      "type": "boolean",
      "example": true,
      "description": "This field indicates that only authenticated users can view."
    },
    "show_social_share_buttons": {
      "type": "boolean",
      "example": true,
      "description": "This field shows social share buttons on registration page. This setting applies for On-demand recordings only."
    }
  }
}

object DevicesAssignDeviceZpaAssignmentRequest

{
  "type": "object",
  "required": [
    "mac_address",
    "vendor"
  ],
  "properties": {
    "vendor": {
      "type": "string",
      "example": "poly",
      "description": "The device's manufacturer."
    },
    "mac_address": {
      "type": "string",
      "example": "64167ffc0ed7",
      "description": "The device's mac address."
    },
    "extension_number": {
      "type": "string",
      "example": "802",
      "description": "The extension number."
    }
  }
}

object DevicesChangeDeviceAssociationRequest

{
  "type": "object",
  "required": [
    "action"
  ],
  "properties": {
    "room_id": {
      "type": "string",
      "example": "qMOLddnySIGGVycz8aX_JQ",
      "description": "The Zoom Room ID which device is being associated to. The `room_id` is required when `assign` is selected for `action` field."
    },
    "app_type": {
      "enum": [
        "ZR",
        "ZRC",
        "ZRP",
        "ZRW"
      ],
      "type": "string",
      "default": "ZR",
      "example": "ZR",
      "description": "Specify one of the following values for this field:\n\n`ZR`: Zoom Room Computer.  \n \n`ZRC`: Zoom Room Controller.  \n \n`ZRP`: Scheduling Display.  \n \n`ZRW`: Companion Whiteboard."
    }
  }
}

object DevicesCreateNewDeviceRequest

{
  "type": "object",
  "required": [
    "device_name",
    "device_type",
    "mac_address",
    "model",
    "serial_number",
    "vendor"
  ],
  "properties": {
    "tag": {
      "type": "string",
      "example": "personal rooms",
      "description": "The name of the tag."
    },
    "model": {
      "type": "string",
      "example": "StudioX30",
      "description": "The device's model."
    },
    "vendor": {
      "type": "string",
      "example": "Poly",
      "description": "The device's manufacturer."
    },
    "room_id": {
      "type": "string",
      "example": "72afdc13-a289-40c3-b358-50c8b8de",
      "description": "The Zoom Room's ID. Only for Zoom Room devices."
    },
    "user_email": {
      "type": "string",
      "example": "test-user@ya.us",
      "description": "User email for assigning the Zoom Phone device. Only for Zoom Phone devices."
    },
    "device_name": {
      "type": "string",
      "example": "My device",
      "description": "The device's name."
    },
    "device_type": {
      "enum": [
        0,
        1,
        5
      ],
      "type": "integer",
      "example": 0,
      "description": "Device type.  \n `0` - Zoom Rooms computer.  \n `1` - Zoom Rooms controller.  \n `5` - Zoom Phone appliance."
    },
    "mac_address": {
      "type": "string",
      "example": "01-23-45-67-89-AB",
      "description": "The device's mac address."
    },
    "zdm_group_id": {
      "type": "string",
      "example": "ff49588c-92c4-4406-99e6-1942d8a61a7b",
      "description": "The ZDM group ID."
    },
    "serial_number": {
      "type": "string",
      "example": "6NRN2A0",
      "description": "The device's serial number."
    },
    "extension_number": {
      "type": "string",
      "example": "802",
      "description": "The extension number."
    }
  }
}

object DevicesGetDetailResponse

{
  "type": "object",
  "properties": {
    "tag": {
      "type": "string",
      "example": "personal rooms",
      "description": "The tag's name."
    },
    "model": {
      "type": "string",
      "example": "StudioX30",
      "description": "The device's model."
    },
    "vendor": {
      "type": "string",
      "example": "Poly",
      "description": "The device's manufacturer."
    },
    "room_id": {
      "type": "string",
      "example": "72afdc13-a289-40c3-b358-50c8b8de",
      "description": "The Zoom Room's ID."
    },
    "device_id": {
      "type": "string",
      "example": "F1C6E9DF-429E-4FA1-85DA-AC95464F3D18",
      "description": "The device's unique identifier."
    },
    "room_name": {
      "type": "string",
      "example": "My Personal Meeting Room",
      "description": "The Zoom Room's name."
    },
    "user_email": {
      "type": "string",
      "example": "test-user@ya.us",
      "description": "The phone device's owner."
    },
    "app_version": {
      "type": "string",
      "example": "5.13.0.5762",
      "description": "App version of Zoom Rooms."
    },
    "device_name": {
      "type": "string",
      "example": "My device",
      "description": "The name of the device."
    },
    "device_type": {
      "enum": [
        0,
        1,
        2,
        3,
        4,
        5,
        6
      ],
      "type": "integer",
      "example": 0,
      "description": "Filter devices by device type.  \nDevice Type:  \n `-1` - All Zoom Room device(0,1,2,3,4,6).  \n `0` - Zoom Rooms Computer.  \n `1` - Zoom Rooms Controller.  \n `2` - Zoom Rooms Scheduling Display.  \n `3` - Zoom Rooms Control System.  \n `4` - Zoom Rooms Whiteboard.  \n `5` - Zoom Phone Appliance.  \n `6` - Zoom Rooms Computer (with Controller)."
    },
    "last_online": {
      "type": "string",
      "example": "2022-10-27T10:23:15Z",
      "description": "The time when the device was last online."
    },
    "mac_address": {
      "type": "string",
      "example": "01-23-45-67-89-AB",
      "description": "The device's MAC address."
    },
    "platform_os": {
      "type": "string",
      "example": "Epos expandvision5 1.2.22315.04",
      "description": "The device's platform."
    },
    "sdk_version": {
      "type": "string",
      "example": "2.0.11",
      "description": "The SDK version."
    },
    "device_status": {
      "enum": [
        -1,
        0,
        1
      ],
      "type": "integer",
      "example": 0,
      "description": "Filter devices by status.  \n Device Status:  \n `0` - offline.  \n `1` - online.  \n `-1` - unlink"
    },
    "serial_number": {
      "type": "string",
      "example": "6NRN2A0",
      "description": "The device's serial number."
    },
    "enrolled_in_zdm": {
      "type": "boolean",
      "example": true,
      "description": "Whether the device is enrolled in ZDM (Zoom Device Management)."
    },
    "connected_to_zdm": {
      "type": "boolean",
      "example": true,
      "description": "Whether the device is connected to ZDM (Zoom Device Management)."
    }
  },
  "description": "Information about the device."
}

object DevicesGetZpaVersionInfoResponse

{
  "type": "object",
  "properties": {
    "app_versions": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "5.16.5.3920",
        "description": "The app version."
      },
      "description": "List of app versions that can be upgraded."
    },
    "firmware_versions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "model": {
            "type": "string",
            "example": "C470HD",
            "description": "The device's model name."
          },
          "vendor": {
            "type": "string",
            "example": "AudioCodes",
            "description": "The device's manufacturer."
          },
          "version": {
            "type": "string",
            "example": "1.19.552",
            "description": "The package version."
          },
          "warn_info": {
            "type": "string",
            "example": "You are about to perform an Android operating system upgrade. The change is permanent and cannot be reversed.",
            "description": "The prompt information for this version."
          }
        },
        "description": "Details of firmware that the vendor can upgrade."
      },
      "description": "List of firmware that can be upgraded."
    }
  },
  "description": "Information about the version list."
}

object DevicesListResponse

{
  "type": "object",
  "properties": {
    "devices": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "tag": {
            "type": "string",
            "example": "personal rooms",
            "description": "The name of the tag."
          },
          "model": {
            "type": "string",
            "example": "StudioX30",
            "description": "The device's model."
          },
          "vendor": {
            "type": "string",
            "example": "Poly",
            "description": "The device's manufacturer."
          },
          "room_id": {
            "type": "string",
            "example": "72afdc13-a289-40c3-b358-50c8b8de",
            "description": "id of the Zoom Room."
          },
          "device_id": {
            "type": "string",
            "example": "F1C6E9DF-429E-4FA1-85DA-AC95464F3D18",
            "description": "Unique identifier of the device."
          },
          "room_name": {
            "type": "string",
            "example": "My Personal Meeting Room",
            "description": "Name of the Zoom Room."
          },
          "user_email": {
            "type": "string",
            "example": "test-user@ya.us",
            "description": "The owner of the phone device"
          },
          "app_version": {
            "type": "string",
            "example": "5.13.0.5762",
            "description": "App version of Zoom Rooms."
          },
          "device_name": {
            "type": "string",
            "example": "My device",
            "description": "The name of the device."
          },
          "device_type": {
            "enum": [
              0,
              1,
              2,
              3,
              4,
              5,
              6
            ],
            "type": "integer",
            "example": 0,
            "description": "Filter devices by device type.  \n  Device Type:  \n `-1` - All Zoom Room device(0,1,2,3,4,6).  \n `0` - Zoom Rooms Computer.  \n `1` - Zoom Rooms Controller.  \n `2` - Zoom Rooms Scheduling Display.  \n `3` - Zoom Rooms Control System.  \n `4` -  Zoom Rooms Whiteboard.  \n `5` - Zoom Phone Appliance.  \n `6` - Zoom Rooms Computer (with Controller)."
          },
          "last_online": {
            "type": "string",
            "example": "2022-10-27T10:23:15Z",
            "description": "The time when device was online last time."
          },
          "mac_address": {
            "type": "string",
            "example": "01-23-45-67-89-AB",
            "description": "The mac address of the device."
          },
          "platform_os": {
            "type": "string",
            "example": "Epos expandvision5 1.2.22315.04",
            "description": "The device's platform."
          },
          "skd_version": {
            "type": "string",
            "example": "2.0.11",
            "description": "The version of the SDK."
          },
          "device_status": {
            "enum": [
              -1,
              0,
              1
            ],
            "type": "integer",
            "example": 0,
            "description": "Filter devices by status.   \n  Device Status:  \n `0` - offline.  \n `1` - online.  \n `-1` - unlink"
          },
          "serial_number": {
            "type": "string",
            "example": "6NRN2A0",
            "description": "The device's serial number."
          },
          "enrolled_in_zdm": {
            "type": "boolean",
            "example": true,
            "description": "Whether the device enrolled in ZDM (Zoom Device Management)."
          },
          "connected_to_zdm": {
            "type": "boolean",
            "example": true,
            "description": "Whether the device connected to ZDM (Zoom Device Management)."
          }
        },
        "description": "The information about the device."
      }
    },
    "page_size": {
      "type": "integer",
      "example": 20,
      "description": "The number of records returned within a single API call."
    },
    "next_page_token": {
      "type": "string",
      "example": "At6eWnFZ1FB3arCXnRxqHLXKhbDW18yz2i2",
      "description": "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."
    }
  }
}

object DevicesListZdmGroupInfoResponse

{
  "type": "object",
  "properties": {
    "groups": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "HeFei-group",
            "description": "The ZDM group's name."
          },
          "description": {
            "type": "string",
            "example": "Group in Hefei region",
            "description": "The ZDM group's describe."
          },
          "zdm_group_id": {
            "type": "string",
            "example": "ff49588c-92c4-4406-99e6-1942d8a61a7b",
            "description": "The ZDM group's unique ID."
          }
        }
      },
      "description": "All ZDM group information under current account."
    },
    "page_size": {
      "type": "integer",
      "example": 30,
      "description": "The total number of records returned from a single API call."
    },
    "next_page_token": {
      "type": "string",
      "example": "RaO87FrnwXvFQta5aV8sU5C3c9O8s9Nraq2",
      "description": "Use the next page token to paginate through a large set of results. 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."
    }
  }
}

object DevicesUpdateDeviceNameRequest

{
  "type": "object",
  "required": [
    "device_name"
  ],
  "properties": {
    "tag": {
      "type": "string",
      "example": "personal rooms",
      "description": "The name of the tag."
    },
    "room_id": {
      "type": "string",
      "example": "72afdc13-a289-40c3-b358-50c8b8de",
      "description": "id of the Zoom Room."
    },
    "device_name": {
      "type": "string",
      "example": "My device",
      "description": "The name of the device."
    },
    "device_type": {
      "enum": [
        0,
        1,
        3
      ],
      "type": "integer",
      "example": 1,
      "description": "Device Type:  \n `0` - Zoom Rooms Computer.  \n `1` - Zoom Rooms Controller.  \n `2` - Zoom Rooms Scheduling Display."
    }
  }
}

object DevicesUpgradeZpaOsAppRequest

{
  "type": "object",
  "required": [
    "data",
    "zdm_group_id"
  ],
  "properties": {
    "data": {
      "oneOf": [
        {
          "type": "object",
          "title": "",
          "required": [
            "upgrade_type"
          ],
          "properties": {
            "upgrade_type": {
              "enum": [
                "UPGRADE_FIRMWARE"
              ],
              "type": "string",
              "default": "UPGRADE_FIRMWARE",
              "example": "UPGRADE_FIRMWARE",
              "description": "Upgrade firmware."
            },
            "firmware_versions": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "model": {
                    "type": "string",
                    "example": "C470HD",
                    "description": "The device's model name. Maximum of 64 characters."
                  },
                  "vendor": {
                    "type": "string",
                    "example": "AudioCodes",
                    "description": "The device's manufacturer."
                  },
                  "version": {
                    "type": "string",
                    "example": "1.19.552",
                    "description": "The firmware version."
                  }
                }
              }
            }
          }
        },
        {
          "type": "object",
          "title": "",
          "required": [
            "upgrade_type"
          ],
          "properties": {
            "app_version": {
              "type": "string",
              "example": "5.16.5.3920",
              "description": "The app version to be upgraded. If upgrade type is `0`, this field won't work. If upgrade type is `1`, this field will work."
            },
            "upgrade_type": {
              "enum": [
                "UPGRADE_APP"
              ],
              "type": "string",
              "example": "UPGRADE_APP",
              "description": "Upgrade app."
            }
          }
        }
      ]
    },
    "zdm_group_id": {
      "type": "string",
      "example": "ff49588c-92c4-4406-99e6-1942d8a61a7b",
      "description": "The ZDM group ID."
    }
  }
}

object H323DevicesCreateDeviceRequest

{
  "type": "object",
  "title": "The H.323/SIP device object.",
  "required": [
    "encryption",
    "ip",
    "name",
    "protocol"
  ],
  "properties": {
    "ip": {
      "type": "string",
      "example": "127.0.0.1",
      "description": "Device IP."
    },
    "name": {
      "type": "string",
      "example": "api_test_20190508",
      "maxLength": 64,
      "description": "Device name."
    },
    "protocol": {
      "enum": [
        "H.323",
        "SIP"
      ],
      "type": "string",
      "example": "H.323",
      "extensions": {
        "x-enum-descriptions": [
          "H.323",
          "SIP"
        ]
      },
      "description": "Device protocol:  \n `H.323` - H.323.  \n `SIP` - SIP."
    },
    "encryption": {
      "enum": [
        "auto",
        "yes",
        "no"
      ],
      "type": "string",
      "example": "auto",
      "extensions": {
        "x-enum-descriptions": [
          "auto",
          "yes",
          "no"
        ]
      },
      "description": "Device encryption:  \n `auto` - auto.  \n `yes` - yes.  \n `no` - no."
    }
  },
  "description": "The H.323/SIP device object."
}

object H323DevicesCreateDeviceResponse

{
  "type": "object",
  "title": "The H.323/SIP device object.",
  "required": [
    "encryption",
    "ip",
    "name",
    "protocol"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "abceHewahkrehwiK",
      "description": "Device ID."
    },
    "ip": {
      "type": "string",
      "example": "127.0.0.1",
      "description": "Device IP."
    },
    "name": {
      "type": "string",
      "example": "api_test_20190508",
      "maxLength": 64,
      "description": "Device name."
    },
    "protocol": {
      "enum": [
        "H.323",
        "SIP"
      ],
      "type": "string",
      "example": "H.323",
      "extensions": {
        "x-enum-descriptions": [
          "H.323",
          "SIP"
        ]
      },
      "description": "Device protocol:  \n `H.323` - H.323.  \n `SIP` - SIP."
    },
    "encryption": {
      "enum": [
        "auto",
        "yes",
        "no"
      ],
      "type": "string",
      "example": "auto",
      "extensions": {
        "x-enum-descriptions": [
          "auto",
          "yes",
          "no"
        ]
      },
      "description": "Device encryption:  \n `auto` - auto.  \n `yes` - yes.  \n `no` - no."
    }
  },
  "description": "The H.323/SIP device object."
}

object H323DevicesListDevicesResponse

{
  "type": "object",
  "title": "H.323/SIP Device List",
  "properties": {
    "devices": {
      "type": "array",
      "items": {
        "type": "object",
        "title": "The H.323/SIP device object.",
        "required": [
          "encryption",
          "ip",
          "name",
          "protocol"
        ],
        "properties": {
          "id": {
            "type": "string",
            "example": "abceHewahkrehwiK",
            "description": "Device ID."
          },
          "ip": {
            "type": "string",
            "example": "127.0.0.1",
            "description": "Device IP."
          },
          "name": {
            "type": "string",
            "example": "api_test_20190508",
            "maxLength": 64,
            "description": "Device name."
          },
          "protocol": {
            "enum": [
              "H.323",
              "SIP"
            ],
            "type": "string",
            "example": "H.323",
            "extensions": {
              "x-enum-descriptions": [
                "H.323",
                "SIP"
              ]
            },
            "description": "Device protocol:  \n `H.323` - H.323.  \n `SIP` - SIP."
          },
          "encryption": {
            "enum": [
              "auto",
              "yes",
              "no"
            ],
            "type": "string",
            "example": "auto",
            "extensions": {
              "x-enum-descriptions": [
                "auto",
                "yes",
                "no"
              ]
            },
            "description": "Device encryption:  \n `auto` - auto.  \n `yes` - yes.  \n `no` - no."
          }
        },
        "description": "The H.323/SIP device object."
      },
      "description": "List of H.323/SIP Device objects."
    },
    "page_size": {
      "type": "integer",
      "default": 30,
      "example": 30,
      "maximum": 300,
      "description": "The number of records returned with a single API call."
    },
    "page_count": {
      "type": "integer",
      "example": 1,
      "description": "The number of pages returned for the request made."
    },
    "page_number": {
      "type": "integer",
      "default": 1,
      "example": 1,
      "deprecated": true,
      "description": "**Deprecated.** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination."
    },
    "total_records": {
      "type": "integer",
      "example": 20,
      "description": "The total number of all the records available across pages."
    },
    "next_page_token": {
      "type": "string",
      "example": "w7587w4eiyfsudgf",
      "description": "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."
    }
  },
  "description": "List of H.323/SIP Devices."
}

object H323DevicesUpdateDeviceInfoRequest

{
  "type": "object",
  "title": "The H.323/SIP device object.",
  "required": [
    "encryption",
    "ip",
    "name",
    "protocol"
  ],
  "properties": {
    "ip": {
      "type": "string",
      "example": "127.0.0.1",
      "description": "Device IP."
    },
    "name": {
      "type": "string",
      "example": "api_test_20190508",
      "maxLength": 64,
      "description": "Device name."
    },
    "protocol": {
      "enum": [
        "H.323",
        "SIP"
      ],
      "type": "string",
      "example": "H.323",
      "extensions": {
        "x-enum-descriptions": [
          "H.323",
          "SIP"
        ]
      },
      "description": "Device protocol:  \n `H.323` - H.323.  \n `SIP` - SIP."
    },
    "encryption": {
      "enum": [
        "auto",
        "yes",
        "no"
      ],
      "type": "string",
      "example": "auto",
      "extensions": {
        "x-enum-descriptions": [
          "auto",
          "yes",
          "no"
        ]
      },
      "description": "Device encryption:  \n `auto` - auto.  \n `yes` - yes.  \n `no` - no."
    }
  },
  "description": "The H.323/SIP device object."
}

object MeetingsAddRegistrantRequest

{
  "type": "object",
  "required": [
    "email",
    "first_name"
  ],
  "properties": {
    "org": {
      "type": "string",
      "example": "Cooking Org",
      "description": "The registrant's organization."
    },
    "zip": {
      "type": "string",
      "example": "94045",
      "description": "The registrant's ZIP or postal code."
    },
    "city": {
      "type": "string",
      "example": "Mountain View",
      "description": "The registrant's city."
    },
    "email": {
      "type": "string",
      "format": "email",
      "example": "jchill@example.com",
      "maxLength": 128,
      "description": "The registrant's email address."
    },
    "phone": {
      "type": "string",
      "example": "5550100",
      "description": "The registrant's phone number."
    },
    "state": {
      "type": "string",
      "example": "CA",
      "description": "The registrant's state or province."
    },
    "address": {
      "type": "string",
      "example": "1800 Amphibious Blvd.",
      "description": "The registrant's address."
    },
    "country": {
      "type": "string",
      "example": "US",
      "description": "The registrant's two-letter [country code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries)."
    },
    "comments": {
      "type": "string",
      "example": "Looking forward to the discussion.",
      "description": "The registrant's questions and comments."
    },
    "industry": {
      "type": "string",
      "example": "Food",
      "description": "The registrant's industry."
    },
    "language": {
      "enum": [
        "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"
      ],
      "type": "string",
      "example": "en-US",
      "description": "The registrant's language preference for confirmation emails: \n* `en-US` &mdash; English (US) \n* `de-DE` &mdash; German (Germany) \n* `es-ES` &mdash; Spanish (Spain) \n* `fr-FR` &mdash; French (France) \n* `jp-JP` &mdash; Japanese \n* `pt-PT` &mdash; Portuguese (Portugal) \n* `ru-RU` &mdash; Russian \n* `zh-CN` &mdash; Chinese (PRC) \n* `zh-TW` &mdash; Chinese (Taiwan) \n* `ko-KO` &mdash; Korean \n* `it-IT` &mdash; Italian (Italy) \n* `vi-VN` &mdash; Vietnamese \n* `pl-PL` &mdash; Polish \n* `Tr-TR` &mdash; Turkish"
    },
    "job_title": {
      "type": "string",
      "example": "Chef",
      "description": "The registrant's job title."
    },
    "last_name": {
      "type": "string",
      "example": "Chill",
      "maxLength": 64,
      "description": "The registrant's last name."
    },
    "first_name": {
      "type": "string",
      "example": "Jill",
      "maxLength": 64,
      "description": "The registrant's first name."
    },
    "auto_approve": {
      "type": "boolean",
      "example": true,
      "description": "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`. \n\n**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)."
    },
    "no_of_employees": {
      "enum": [
        "",
        "1-20",
        "21-50",
        "51-100",
        "101-500",
        "500-1,000",
        "1,001-5,000",
        "5,001-10,000",
        "More than 10,000"
      ],
      "type": "string",
      "example": "1-20",
      "description": "The registrant's number of employees: \n* `1-20` \n* `21-50` \n* `51-100` \n* `101-500` \n* `500-1,000` \n* `1,001-5,000` \n* `5,001-10,000` \n* `More than 10,000`"
    },
    "custom_questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "example": "What do you hope to learn from this?",
            "description": "The title of the custom question."
          },
          "value": {
            "type": "string",
            "example": "Look forward to learning how you come up with new recipes and what other services you offer.",
            "maxLength": 128,
            "description": "The custom question's response value. This has a limit of 128 characters."
          }
        },
        "description": "Information about custom questions."
      },
      "description": "Information about custom questions."
    },
    "purchasing_time_frame": {
      "enum": [
        "",
        "Within a month",
        "1-3 months",
        "4-6 months",
        "More than 6 months",
        "No timeframe"
      ],
      "type": "string",
      "example": "1-3 months",
      "description": "The registrant's purchasing time frame: \n* `Within a month` \n* `1-3 months` \n* `4-6 months` \n* `More than 6 months` \n* `No timeframe`"
    },
    "role_in_purchase_process": {
      "enum": [
        "",
        "Decision Maker",
        "Evaluator/Recommender",
        "Influencer",
        "Not involved"
      ],
      "type": "string",
      "example": "Influencer",
      "description": "The registrant's role in the purchase process: \n* `Decision Maker` \n* `Evaluator/Recommender` \n* `Influencer` \n* `Not involved`"
    }
  },
  "description": "Information about the meeting registrant."
}

object MeetingsAddRegistrantResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 85746065,
      "description": "The meeting ID."
    },
    "topic": {
      "type": "string",
      "example": "My Meeting",
      "maxLength": 200,
      "description": "The meeting's topic."
    },
    "join_url": {
      "type": "string",
      "example": "https://example.com/j/11111",
      "description": "The URL the registrant can use to join the meeting. \n\nThe API will not return this field if the meeting was [created](https://developers.zoom.us) with the `approval_type` field value of `1` (manual approval)."
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2021-07-13T21:44:51Z",
      "description": "The meeting's start time."
    },
    "occurrences": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "example": "available",
            "description": "Occurrence status."
          },
          "duration": {
            "type": "integer",
            "example": 60,
            "description": "Duration."
          },
          "start_time": {
            "type": "string",
            "format": "date-time",
            "example": "2022-03-25T07:46:00Z",
            "description": "Start time."
          },
          "occurrence_id": {
            "type": "string",
            "example": "1648194360000",
            "description": "Occurrence ID: Unique Identifier that identifies 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."
          }
        },
        "description": "Occurrence object. This object is only returned for Recurring Webinars."
      },
      "description": "Array of occurrence objects."
    },
    "registrant_id": {
      "type": "string",
      "example": "fdgsfh2ey82fuh",
      "description": "The registrant's ID."
    },
    "participant_pin_code": {
      "type": "integer",
      "format": "int64",
      "example": 380303,
      "description": "The participant PIN code is used to authenticate audio participants before they join the meeting."
    }
  }
}

object MeetingsBatchRegistrantsCreateRequest

{
  "type": "object",
  "properties": {
    "registrants": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "email",
          "first_name"
        ],
        "properties": {
          "email": {
            "type": "string",
            "format": "email",
            "example": "jchill@example.com",
            "description": "Email address of the registrant."
          },
          "last_name": {
            "type": "string",
            "example": "Chill",
            "description": "Last name of the registrant."
          },
          "first_name": {
            "type": "string",
            "example": "Jill",
            "description": "First name of the registrant."
          }
        }
      }
    },
    "auto_approve": {
      "type": "boolean",
      "example": true,
      "description": "If a meeting was scheduled with approval_type `1` (manual approval), but you would like to automatically approve the registrants that are added via this API, you can set the value of this field to `true`. \n\nYou **cannot** use this field to change approval setting for a meeting  that was originally scheduled with approval_type `0` (automatic approval)."
    },
    "registrants_confirmation_email": {
      "type": "boolean",
      "example": true,
      "description": "Send confirmation Email to Registrants"
    }
  }
}

object MeetingsBatchRegistrantsCreateResponse

{
  "type": "object",
  "properties": {
    "registrants": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "example": "jchill@example.com",
            "description": "Email address of the registrant."
          },
          "join_url": {
            "type": "string",
            "example": "https://example.com/j/11111",
            "description": "Unique URL using which registrant can join the meeting."
          },
          "registrant_id": {
            "type": "string",
            "example": "9tboDiHUQAeOnbmudzWa5g",
            "description": "Unique identifier of the registrant."
          },
          "participant_pin_code": {
            "type": "integer",
            "format": "int64",
            "example": 380303,
            "description": "The participant PIN code is used to authenticate audio participants before they join the meeting."
          }
        }
      }
    }
  }
}

object MeetingsControlInMeetingFeaturesRequest

{
  "type": "object",
  "properties": {
    "method": {
      "type": "string",
      "example": "recording.start",
      "description": "The in-meeting method to control: \n* `recording.start` &mdash; Start the recording. \n* `recording.stop` &mdash; Stop the recording. \n* `recording.pause` &mdash; Pause the recording. \n* `recording.resume` &mdash; Resume a paused recording. \n* `participant.invite` &mdash; Invite a participant to the meeting. \n* `participant.invite.callout` &mdash; Invite a participant to the meeting through [call out (phone)](https://support.zoom.us/hc/en-us/articles/4404535651085-Inviting-others-by-phone-call-out). \n* `participant.invite.room_system_callout` &mdash; Invite a participant to the meeting through [call out (room system)]."
    },
    "params": {
      "type": "object",
      "properties": {
        "contacts": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "example": "30R7kT7bTIKSNUFEuH_Qlg",
                "description": "The user's ID."
              },
              "email": {
                "type": "string",
                "example": "jchill@example.com",
                "description": "The user's email address. Use this value if you do not have the user's ID. \n\nIf you pass the `id` value, the API ignores this query parameter."
              }
            }
          },
          "maximum": 10,
          "description": "The user's email address or the user ID, up to a maximum of 10 contacts. The account must be a part of the meeting host's account."
        },
        "call_type": {
          "type": "string",
          "example": "h323",
          "description": "The type of call out. Use a value of `h323` or `sip`. Use this field if you pass the `participant.invite.room_system_callout` value for the `method` field."
        },
        "device_ip": {
          "type": "string",
          "example": "10.100.111.237",
          "description": "The user's device IP address or URI. Use this field if you pass the `participant.invite.room_system_callout` value for the `method` field."
        },
        "sip_headers": {
          "type": "object",
          "properties": {
            "from_uri": {
              "type": "string",
              "example": "sip:username@domain.company.org",
              "maxLength": 256,
              "description": "Custom URI that will be used within the SIP Header. The URI must start with 'sip:' or 'sips:' as a valid URI based on parameters defined by the platform."
            },
            "to_display_name": {
              "type": "string",
              "example": "display name",
              "maxLength": 64,
              "description": "Custom remote name that will be used within the meeting."
            },
            "from_display_name": {
              "type": "string",
              "example": "display name",
              "maxLength": 64,
              "description": "Custom name that will be used within the SIP Header."
            },
            "additional_headers": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "key": {
                    "type": "string",
                    "example": "X-Header1",
                    "maxLength": 32,
                    "description": "Additional custom SIP header's key."
                  },
                  "value": {
                    "type": "string",
                    "example": "X-body1",
                    "maxLength": 256,
                    "description": "Additional custom SIP header's value."
                  }
                }
              },
              "maximum": 10,
              "description": "Ability to add 1 to 10 custom headers, each of which has a maximum length of 256 bytes to comply with SIP standards.  Custom headers would leverage header names starting with 'X-' per SIP guidelines."
            }
          },
          "description": "Enable customers to leverage services that require customization of the FROM header to identify the caller. Use this field if you pass the `participant.invite.room_system_callout` value for the `method` field and the `sip` value for the `call_type` field."
        },
        "h323_headers": {
          "type": "object",
          "properties": {
            "to_display_name": {
              "type": "string",
              "example": "display name",
              "maxLength": 64,
              "description": "Custom remote name that will be used within the meeting."
            },
            "from_display_name": {
              "type": "string",
              "example": "display name",
              "maxLength": 64,
              "description": "Custom name that will be used within the h323 Header."
            }
          },
          "description": "Enable customers to leverage services that require customization of the FROM header to identify the caller. Use this field if you pass the `participant.invite.room_system_callout` value for the `method` field and the `h323` value for the `call_type` field."
        },
        "invitee_name": {
          "type": "string",
          "example": "Jill Chill",
          "description": "The user's name to display in the meeting. Use this field if you pass the `participant.invite.callout` value for the `method` field."
        },
        "phone_number": {
          "type": "string",
          "example": "5550100",
          "description": "The user's phone number. Use this field if you pass the `participant.invite.callout` value for the `method` field. As a best practice, ensure this includes a country code and area code."
        },
        "invite_options": {
          "type": "object",
          "properties": {
            "require_greeting": {
              "type": "boolean",
              "default": true,
              "example": true,
              "description": "Whether to require a greeting before being connected. Use this field if you pass the `participant.invite.callout` value for the `method` field."
            },
            "require_pressing_one": {
              "type": "boolean",
              "default": true,
              "example": true,
              "description": "Whether to require pressing 1 before being connected. Use this field if you pass the `participant.invite.callout` value for the `method` field."
            }
          },
          "description": "Information about the `participant.invite.callout` settings."
        }
      },
      "description": "The in-meeting parameters."
    }
  }
}

object MeetingsCreateBatchPollsRequest

{
  "type": "object",
  "properties": {
    "polls": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "example": "Learn something new",
            "maxLength": 64,
            "description": "The poll's title, up to 64 characters."
          },
          "anonymous": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether to allow meeting participants to answer poll questions anonymously: \n* `true` &mdash; Anonymous polls enabled. \n* `false` &mdash; Participants cannot answer poll questions anonymously. \n\nThis value defaults to `false`."
          },
          "poll_type": {
            "enum": [
              1,
              2,
              3
            ],
            "type": "integer",
            "default": 1,
            "example": 2,
            "description": "The type of poll: \n* `1` &mdash; Poll. \n* `2` &mdash; Advanced Poll. This feature must be enabled in your Zoom account. \n* `3` &mdash; Quiz. This feature must be enabled in your Zoom account. \n\n This value defaults to `1`."
          },
          "questions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "example": "How useful was this meeting?",
                  "maxLength": 255,
                  "description": "The poll question's title, up to 255 characters. \n\nFor `fill_in_the_blank` polls, this field is the poll's question. For each value that the user must fill in, ensure that there are the same number of `right_answers` values."
                },
                "type": {
                  "enum": [
                    "single",
                    "multiple",
                    "matching",
                    "rank_order",
                    "short_answer",
                    "long_answer",
                    "fill_in_the_blank",
                    "rating_scale"
                  ],
                  "type": "string",
                  "example": "single",
                  "extensions": {
                    "x-enum-descriptions": [
                      "Single choice",
                      "Multiple choice",
                      "Matching",
                      "Rank order",
                      "Short answer",
                      "Long answer",
                      "Fill in the blank",
                      "Rating scale"
                    ]
                  },
                  "description": "The poll's question and answer type: \n* `single` &mdash; Single choice. \n* `multiple` &mdash; Multiple choice. \n* `matching` &mdash; Matching. \n* `rank_order` &mdash; Rank order. \n* `short_answer` &mdash; Short answer. \n* `long_answer` &mdash; Long answer. \n* `fill_in_the_blank` &mdash; Fill in the blank. \n* `rating_scale` &mdash; Rating scale."
                },
                "answers": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "Extremely useful"
                  },
                  "minItems": 2,
                  "description": "The poll question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` polls, you can only provide a maximum of 10 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers."
                },
                "prompts": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "prompt_question": {
                        "type": "string",
                        "example": "How are you?",
                        "description": "The question prompt's title."
                      },
                      "prompt_right_answers": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "example": "Good"
                        },
                        "description": "The question prompt's correct answers: \n* For `matching` polls, you must provide a minimum of two correct answers, up to a maximum of 10 correct answers. \n* For `rank_order` polls, you can only provide one correct answer."
                      }
                    }
                  },
                  "description": "Information about the prompt questions. This field only applies to `matching` and `rank_order` polls. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts."
                },
                "right_answers": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "Good"
                  },
                  "minItems": 1,
                  "description": "The poll question's correct answer(s). This field is **required** if the poll's `type` value is `3` (Quiz). \n\n For `single` and `matching` polls, this field only accepts one answer."
                },
                "case_sensitive": {
                  "type": "boolean",
                  "default": false,
                  "example": false,
                  "description": "Whether the correct answer is case sensitive. This field only applies to `fill_in_the_blank` polls: \n* `true` &mdash; The answer is case-sensitive. \n* `false` &mdash; The answer is not case-sensitive. \n\nThis value defaults to `false`."
                },
                "answer_required": {
                  "type": "boolean",
                  "default": false,
                  "example": false,
                  "description": "Whether participants must answer the question: \n* `true` &mdash; The participant must answer the question. \n* `false` &mdash; The participant does not need to answer the question. \n\n**Note:** \n* When the poll's `type` value is `1` (Poll), this value defaults to `true`. \n* When the poll's `type` value is the `2` (Advanced Poll) or `3` (Quiz) values, this value defaults to `false`."
                },
                "rating_max_label": {
                  "type": "string",
                  "example": "Extremely Likely",
                  "description": "The high score label used for the `rating_max_value` field. \n\nThis field only applies to the `rating_scale` poll."
                },
                "rating_max_value": {
                  "type": "integer",
                  "example": 4,
                  "maximum": 10,
                  "description": "The rating scale's maximum value, up to a maximum value of 10. \n\nThis field only applies to the `rating_scale` poll."
                },
                "rating_min_label": {
                  "type": "string",
                  "example": "Not likely",
                  "description": "The low score label used for the `rating_min_value` field. \n\nThis field only applies to the `rating_scale` poll."
                },
                "rating_min_value": {
                  "type": "integer",
                  "example": 1,
                  "minimum": 1,
                  "description": "The rating scale's minimum value. This value cannot be less than zero. \n\nThis field only applies to the `rating_scale` poll."
                },
                "show_as_dropdown": {
                  "type": "boolean",
                  "default": false,
                  "example": false,
                  "description": "Whether to display the radio selection as a drop-down box: \n* `true` &mdash; Show as a drop-down box. \n* `false` &mdash; Do not show as a drop-down box. \n\nThis value defaults to `false`."
                },
                "answer_max_character": {
                  "type": "integer",
                  "example": 200,
                  "description": "The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` polls: \n* For `short_answer` polls, a maximum of 500 characters. \n* For `long_answer` polls, a maximum of 2,000 characters."
                },
                "answer_min_character": {
                  "type": "integer",
                  "example": 1,
                  "minimum": 1,
                  "description": "The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` polls. You must provide at least a **one** character minimum value."
                }
              }
            },
            "required": [
              "name",
              "type"
            ],
            "minLength": 1,
            "description": "Information about the poll's questions."
          }
        }
      },
      "maxItems": 25,
      "minItems": 1,
      "description": "Information about the meeting's polls."
    }
  }
}

object MeetingsCreateBatchPollsResponse

{
  "type": "object",
  "properties": {
    "polls": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "QalIoKWLTJehBJ8e1xRrbQ",
            "description": "Meeting Poll ID"
          },
          "title": {
            "type": "string",
            "example": "Learn something new",
            "description": "Title for the Poll"
          },
          "status": {
            "enum": [
              "notstart",
              "started",
              "ended",
              "sharing"
            ],
            "type": "string",
            "example": "notstart",
            "extensions": {
              "x-enum-descriptions": [
                "Poll not start",
                "Poll started",
                "Poll ended",
                "Poll is sharing"
              ]
            },
            "description": "Status of the Meeting Poll:  \n `notstart` - Poll not started  \n `started` - Poll started  \n `ended` - Poll ended  \n `sharing` - Sharing poll results"
          },
          "anonymous": {
            "type": "boolean",
            "example": true,
            "description": "Whether to allow meeting participants to answer poll questions anonymously: \n* `true` &mdash; Anonymous polls enabled. \n* `false` &mdash; Participants cannot answer poll questions anonymously."
          },
          "poll_type": {
            "enum": [
              1,
              2,
              3
            ],
            "type": "integer",
            "example": 2,
            "description": "The type of poll: \n* `1` &mdash; Poll. \n* `2` &mdash; Advanced Poll. This feature must be enabled in your Zoom account. \n* `3` &mdash; Quiz. This feature must be enabled in your Zoom account."
          },
          "questions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "example": "How useful was this meeting?",
                  "description": "The poll question's title. For `fill_in_the_blank` polls, this field is the poll's question."
                },
                "type": {
                  "enum": [
                    "single",
                    "multiple",
                    "matching",
                    "rank_order",
                    "short_answer",
                    "long_answer",
                    "fill_in_the_blank",
                    "rating_scale"
                  ],
                  "type": "string",
                  "example": "single",
                  "extensions": {
                    "x-enum-descriptions": [
                      "Single choice",
                      "Multiple choice",
                      "Matching",
                      "Rank order",
                      "Short answer",
                      "Long answer",
                      "Fill in the blank",
                      "Rating scale"
                    ]
                  },
                  "description": "The poll's question and answer type: \n* `single` &mdash; Single choice. \n* `multiple` &mdash; Multiple choice. \n* `matching` &mdash; Matching. \n* `rank_order` &mdash; Rank order. \n* `short_answer` &mdash; Short answer. \n* `long_answer` &mdash; Long answer. \n* `fill_in_the_blank` &mdash; Fill in the blank. \n* `rating_scale` &mdash; Rating scale."
                },
                "answers": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "Extremely useful"
                  },
                  "description": "The poll question's available answers."
                },
                "prompts": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "prompt_question": {
                        "type": "string",
                        "example": "How are you?",
                        "description": "The question prompt's title."
                      },
                      "prompt_right_answers": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "example": "Good"
                        },
                        "description": "The question prompt's correct answers."
                      }
                    }
                  },
                  "description": "Information about the prompt questions. This object only returns for `matching` and `rank_order` polls."
                },
                "right_answers": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "Good"
                  },
                  "description": "The poll question's correct answer(s)."
                },
                "case_sensitive": {
                  "type": "boolean",
                  "default": false,
                  "example": false,
                  "description": "Whether the correct answer is case sensitive. This field only returns for `fill_in_the_blank` polls: \n* `true` &mdash; The answer is case-sensitive. \n* `false` &mdash; The answer is not case-sensitive."
                },
                "answer_required": {
                  "type": "boolean",
                  "example": false,
                  "description": "Whether participants must answer the question: \n* `true` &mdash; The participant must answer the question. \n* `false` &mdash; The participant does not need to answer the question."
                },
                "rating_max_label": {
                  "type": "string",
                  "example": "Extremely Likely",
                  "description": "The high score label used for the `rating_max_value` field. This field only returns for `rating_scale` polls."
                },
                "rating_max_value": {
                  "type": "integer",
                  "example": 4,
                  "maximum": 10,
                  "description": "The rating scale's maximum value. This field only returns for `rating_scale` polls."
                },
                "rating_min_label": {
                  "type": "string",
                  "example": "Not likely",
                  "description": "The low score label used for the `rating_min_value` field. This field only returns for `rating_scale` polls."
                },
                "rating_min_value": {
                  "type": "integer",
                  "example": 0,
                  "description": "The rating scale's minimum value. This field only returns for `rating_scale` polls."
                },
                "show_as_dropdown": {
                  "type": "boolean",
                  "example": false,
                  "description": "Whether to display the radio selection as a drop-down box: \n* `true` &mdash; Show as a drop-down box. \n* `false` &mdash; Do not show as a drop-down box."
                },
                "answer_max_character": {
                  "type": "integer",
                  "example": 200,
                  "description": "The allowed maximum number of characters. This field only returns for `short_answer` and `long_answer` polls."
                },
                "answer_min_character": {
                  "type": "integer",
                  "example": 1,
                  "description": "The allowed minimum number of characters. This field only returns for `short_answer` and `long_answer` polls."
                }
              }
            },
            "description": "Information about the poll's questions."
          }
        }
      }
    }
  }
}

object MeetingsCreateInviteLinksRequest

{
  "type": "object",
  "title": "Invite Links",
  "properties": {
    "ttl": {
      "type": "integer",
      "format": "int64",
      "default": 7200,
      "example": 1000,
      "maximum": 7776000,
      "minimum": 0,
      "description": "The invite link's expiration time, in seconds. \n\nThis value defaults to `7200`."
    },
    "attendees": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "example": "Jill Chill",
            "maxLength": 64,
            "description": "User display name."
          }
        }
      },
      "maxItems": 500,
      "minItems": 1,
      "description": "The attendees list."
    }
  },
  "description": "Invite Links"
}

object MeetingsCreateInviteLinksResponse

{
  "type": "object",
  "title": "Invite Links",
  "properties": {
    "attendees": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "Jill Chill",
            "description": "The user's display name."
          },
          "join_url": {
            "type": "string",
            "example": "https://example.com/j/11111",
            "description": "The URL to join the meeting."
          }
        }
      },
      "description": "The attendee list."
    }
  },
  "description": "Invite links response."
}

object MeetingsCreateMeetingRequest

{
  "type": "object",
  "properties": {
    "type": {
      "enum": [
        1,
        2,
        3,
        8
      ],
      "type": "integer",
      "default": 2,
      "example": 2,
      "extensions": {
        "x-enum-descriptions": [
          "Instant meeting.",
          "Scheduled meeting.",
          "Recurring meeting with no fixed time.",
          "Recurring meeting with fixed time."
        ]
      },
      "description": "The type of meeting.\n* `1` - An instant meeting. \n* `2` - A scheduled meeting. \n* `3` - A recurring meeting with no fixed time. \n* `8` - A recurring meeting with fixed time."
    },
    "topic": {
      "type": "string",
      "example": "My Meeting",
      "maxLength": 200,
      "description": "The meeting's topic."
    },
    "agenda": {
      "type": "string",
      "example": "My Meeting",
      "maxLength": 2000,
      "description": "The meeting's agenda. This value has a maximum length of 2,000 characters."
    },
    "duration": {
      "type": "integer",
      "example": 60,
      "description": "The meeting's scheduled duration, in minutes. This field is only used for scheduled meetings (`2`)."
    },
    "password": {
      "type": "string",
      "example": "123456",
      "maxLength": 10,
      "description": "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. \n* 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. \n* 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."
    },
    "settings": {
      "type": "object",
      "properties": {
        "audio": {
          "enum": [
            "both",
            "telephony",
            "voip",
            "thirdParty"
          ],
          "type": "string",
          "default": "both",
          "example": "telephony",
          "extensions": {
            "x-enum-descriptions": [
              "Telephony and VoIP.",
              "Telephony only.",
              "VoIP only.",
              "Third party audio conference."
            ]
          },
          "description": "How participants join the audio portion of the meeting.\n* `both` - Both telephony and VoIP. \n* `telephony` - Telephony only. \n* `voip` - VoIP only. \n* `thirdParty` - Third party audio conference."
        },
        "use_pmi": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "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`."
        },
        "jbh_time": {
          "enum": [
            0,
            5,
            10
          ],
          "type": "integer",
          "example": 0,
          "description": "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.\n\n* `0` - Allow the participant to join the meeting at anytime.\n* `5` - Allow the participant to join 5 minutes before the meeting's start time.\n* `10` - Allow the participant to join 10 minutes before the meeting's start time."
        },
        "resources": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "resource_id": {
                "type": "string",
                "example": "X4Hy02w3QUOdskKofgb9Jg",
                "description": "The resource ID."
              },
              "resource_type": {
                "enum": [
                  "whiteboard"
                ],
                "type": "string",
                "example": "whiteboard",
                "description": "The resource type."
              },
              "permission_level": {
                "enum": [
                  "editor",
                  "commenter",
                  "viewer"
                ],
                "type": "string",
                "default": "editor",
                "example": "editor",
                "description": "The permission levels for users to access the whiteboard. \n* `editor` - Users with link access can edit the board. \n* `commenter` - Users with link access can comment on the board. \n* `viewer` - Users with link access can view the board."
              }
            }
          },
          "description": "The meeting's resources."
        },
        "watermark": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to add a watermark when viewing a shared screen."
        },
        "cn_meeting": {
          "type": "boolean",
          "default": false,
          "example": false,
          "deprecated": true,
          "description": "Whether to host the meeting in China (CN). This value defaults to `false`."
        },
        "focus_mode": {
          "type": "boolean",
          "example": true,
          "description": "Whether to enable the [**Focus Mode** feature](https://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) when the meeting starts."
        },
        "host_video": {
          "type": "boolean",
          "example": true,
          "description": "Whether to start meetings with the host video on."
        },
        "in_meeting": {
          "type": "boolean",
          "default": false,
          "example": false,
          "deprecated": true,
          "description": "Whether to host the meeting in India (IN). This value defaults to `false`."
        },
        "contact_name": {
          "type": "string",
          "example": "Jill Chill",
          "description": "The contact name for meeting registration."
        },
        "waiting_room": {
          "type": "boolean",
          "example": false,
          "description": "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."
        },
        "approval_type": {
          "enum": [
            0,
            1,
            2
          ],
          "type": "integer",
          "default": 2,
          "example": 2,
          "extensions": {
            "x-enum-descriptions": [
              "Automatically approve registration.",
              "Manually approve registration.",
              "No registration required."
            ]
          },
          "description": "Enable meeting registration approval.\n* `0` - Automatically approve registration.\n* `1` - Manually approve registration.\n* `2` - No registration required.\n\nThis value defaults to `2`."
        },
        "breakout_room": {
          "type": "object",
          "properties": {
            "rooms": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "example": "room1",
                    "description": "The breakout room's name."
                  },
                  "participants": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "example": "jchill@example.com"
                    },
                    "description": "The email addresses of the participants to assign to the breakout room."
                  }
                }
              },
              "description": "Information about the breakout rooms."
            },
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "Whether to enable the [**Breakout Room pre-assign**](https://support.zoom.us/hc/en-us/articles/360032752671-Pre-assigning-participants-to-breakout-rooms) option."
            }
          },
          "description": "The [pre-assigned breakout rooms](https://support.zoom.us/hc/en-us/articles/360032752671-Pre-assigning-participants-to-breakout-rooms) settings."
        },
        "calendar_type": {
          "enum": [
            1,
            2
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Outlook",
              "Google Calendar"
            ]
          },
          "description": "Indicates the type of calendar integration used to schedule the meeting.\n* `1` - [Zoom Outlook add-in](https://support.zoom.us/hc/en-us/articles/360031592971-Getting-started-with-Outlook-plugin-and-add-in) \n* `2` - [Zoom for Google Workspace add-on](https://support.zoom.us/hc/en-us/articles/360020187492-Using-the-Zoom-for-Google-Workspace-add-on)\n\nWorks with the `private_meeting` field to determine whether to share details of meetings or not."
        },
        "contact_email": {
          "type": "string",
          "example": "jchill@example.com",
          "description": "The contact email address for meeting registration."
        },
        "auto_recording": {
          "enum": [
            "local",
            "cloud",
            "none"
          ],
          "type": "string",
          "default": "none",
          "example": "cloud",
          "extensions": {
            "x-enum-descriptions": [
              "Record the meeting locally.",
              "Record the meeting to the cloud.",
              "Auto-recording disabled."
            ]
          },
          "description": "The automatic recording settings. \n* `local` - Record the meeting locally. \n* `cloud` - Record the meeting to the cloud. \n* `none` - Auto-recording disabled.\n\nThis value defaults to `none`."
        },
        "encryption_type": {
          "enum": [
            "enhanced_encryption",
            "e2ee"
          ],
          "type": "string",
          "example": "enhanced_encryption",
          "description": "The type of [end-to-end (E2EE) encryption](https://support.zoom.us/hc/en-us/articles/360048660871) to use for the meeting. \n* `enhanced_encryption` - Enhanced encryption. Encryption is stored in the cloud when you enable this option. \n* `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**."
        },
        "mute_upon_entry": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to mute participants upon entry."
        },
        "private_meeting": {
          "type": "boolean",
          "example": false,
          "description": "Whether to set the meeting as private."
        },
        "internal_meeting": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to set the meeting as an internal meeting."
        },
        "join_before_host": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "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`.\n\nIf the [**Waiting Room** feature](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) is enabled, this setting is **disabled**."
        },
        "meeting_invitees": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "email": {
                "type": "string",
                "format": "email",
                "example": "jchill@example.com",
                "description": "The invitee's email address."
              }
            }
          },
          "description": "A list of the meeting's invitees."
        },
        "alternative_hosts": {
          "type": "string",
          "example": "jchill@example.com;thill@example.com",
          "description": "A semicolon-separated list of the meeting's alternative hosts' email addresses or IDs."
        },
        "participant_video": {
          "type": "boolean",
          "example": false,
          "description": "Whether to start meetings with the participant video on."
        },
        "registration_type": {
          "enum": [
            1,
            2,
            3
          ],
          "type": "integer",
          "default": 1,
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Attendees register once and can attend any meeting occurrence.",
              "Attendees must register for each meeting occurrence.",
              "Attendees register once and can select one or more meeting occurrences to attend."
            ]
          },
          "description": "The meeting's registration type. \n* `1` - Attendees register once and can attend any meeting occurrence. \n* `2` - Attendees must register for each meeting occurrence. \n* `3` - Attendees register once and can select one or more meeting occurrences to attend.\n\nThis field is only for recurring meetings with fixed times (`8`). This value defaults to `1`."
        },
        "show_share_button": {
          "type": "boolean",
          "example": true,
          "description": "Whether to include social media sharing buttons on the meeting's registration page. This setting is only applied to meetings with registration enabled."
        },
        "close_registration": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to close registration after the event date. This value defaults to `false`."
        },
        "email_notification": {
          "type": "boolean",
          "default": true,
          "example": true,
          "description": "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`."
        },
        "audio_conference_info": {
          "type": "string",
          "example": "test",
          "maxLength": 2048,
          "description": "Third party audio conference info."
        },
        "authentication_option": {
          "type": "string",
          "example": "signIn_D8cJuqWVQ623CI4Q8yQK0Q",
          "description": "If the `meeting_authentication` value is `true`, the type of authentication required for users to join a meeting.\n\nTo 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."
        },
        "host_save_video_order": {
          "type": "boolean",
          "example": true,
          "description": "Whether the **Allow host to save video order** feature is enabled."
        },
        "allow_multiple_devices": {
          "type": "boolean",
          "example": true,
          "description": "Whether to allow attendees to join a meeting from multiple devices. This setting is only applied to meetings with registration enabled."
        },
        "authentication_domains": {
          "type": "string",
          "example": "example.com",
          "description": "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."
        },
        "meeting_authentication": {
          "type": "boolean",
          "example": true,
          "description": "If true, only [authenticated](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) users can join the meeting."
        },
        "continuous_meeting_chat": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "Whether to enable the **Enable continuous meeting chat** setting."
            },
            "auto_add_invited_external_users": {
              "type": "boolean",
              "example": true,
              "description": "Whether to enable the **Automatically add invited external users** setting."
            }
          },
          "description": "Information about the **Enable continuous meeting chat** feature."
        },
        "language_interpretation": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "Whether to enable [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars) for the meeting."
            },
            "interpreters": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "format": "email",
                    "example": "interpreter@example.com",
                    "description": "The interpreter's email address."
                  },
                  "languages": {
                    "type": "string",
                    "example": "US,FR",
                    "description": "A comma-separated list of the interpreter's languages. The string must contain two [country IDs](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries). \n\nFor example, if the interpreter will translate from English to Chinese, then this value will be `US,CN`."
                  }
                }
              },
              "description": "Information about the meeting's language interpreters."
            }
          },
          "description": "The meeting's [language interpretation settings](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** This feature is only available for certain Meeting add-on, Education, and Business and higher plans. If this feature is not enabled on the host's account, this setting will **not** be applied to the meeting."
        },
        "push_change_to_calendar": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to push meeting changes to the calendar. \n\n 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.\n* `true` - Push meeting changes to the calendar.\n* `false` - Do not push meeting changes to the calendar."
        },
        "authentication_exception": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "example": "Jill Chill",
                "description": "The participant's name."
              },
              "email": {
                "type": "string",
                "format": "email",
                "example": "jchill@example.com",
                "description": "The participant's email address."
              }
            }
          },
          "description": "A list of participants that can bypass meeting authentication. These participants will receive a unique meeting invite."
        },
        "global_dial_in_countries": {
          "type": "array",
          "items": {
            "type": "string",
            "example": "US"
          },
          "description": "A list of available global dial-in countries."
        },
        "auto_start_meeting_summary": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to automatically start a meeting summary."
        },
        "participant_focused_meeting": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to set the meeting as a participant focused meeting."
        },
        "sign_language_interpretation": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "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."
            },
            "interpreters": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "format": "email",
                    "example": "interpreter@example.com",
                    "description": "The interpreter's email address."
                  },
                  "sign_language": {
                    "type": "string",
                    "example": "American",
                    "description": "The interpreter's sign language. \n\n To get this value, use the `sign_language_interpretation` object's `languages` and `custom_languages` values in the [**Get user settings**](/api-reference/zoom-api/methods#operation/userSettings) API response."
                  }
                }
              },
              "maximum": 20,
              "description": "Information about the meeting's sign language interpreters."
            }
          },
          "description": "The meeting's [sign language interpretation settings](https://support.zoom.us/hc/en-us/articles/9644962487309-Using-sign-language-interpretation-in-a-meeting-or-webinar). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** If this feature is not enabled on the host's account, this setting will **not** be applied to the meeting."
        },
        "alternative_host_update_polls": {
          "type": "boolean",
          "example": true,
          "description": "Whether the **Allow alternative hosts to add or edit polls** feature is enabled. This requires Zoom version 5.8.0 or higher."
        },
        "additional_data_center_regions": {
          "type": "array",
          "items": {
            "type": "string",
            "example": "TY"
          },
          "description": "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).\n\nFor 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.\n\nTo include `India` and `Japan` as additional data centers, use the `[IN, TY]` value for this field."
        },
        "registrants_confirmation_email": {
          "type": "boolean",
          "example": true,
          "description": "Whether to send registrants an email confirmation. \n* `true` - Send a confirmation email. \n* `false` - Do not send a confirmation email."
        },
        "registrants_email_notification": {
          "type": "boolean",
          "example": true,
          "description": "Whether to send registrants email notifications about their registration approval, cancellation, or rejection.\n\n* `true` - Send an email notification.\n* `false` - Do not send an email notification.\n\n Set this value to `true` to also use the `registrants_confirmation_email` parameter."
        },
        "auto_start_ai_companion_questions": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to automatically start AI Companion questions."
        },
        "alternative_hosts_email_notification": {
          "type": "boolean",
          "default": true,
          "example": true,
          "description": "Whether to send email notifications to alternative hosts. This value defaults to `true`."
        },
        "approved_or_denied_countries_or_regions": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "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."
            },
            "method": {
              "enum": [
                "approve",
                "deny"
              ],
              "type": "string",
              "example": "approve",
              "description": "Whether to allow or block users from specific countries or regions.\n* `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. \n* `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."
            },
            "denied_list": {
              "type": "array",
              "items": {
                "type": "string",
                "example": "CA"
              },
              "description": "The list of blocked countries or regions."
            },
            "approved_list": {
              "type": "array",
              "items": {
                "type": "string",
                "example": "CX"
              },
              "description": "The list of approved countries or regions."
            }
          },
          "description": "The list of approved or blocked users from specific countries or regions who can join the meeting."
        }
      },
      "description": "Information about the meeting's settings."
    },
    "timezone": {
      "type": "string",
      "example": "America/Los_Angeles",
      "description": "The timezone to assign to the `start_time` value. This field is only used for scheduled or recurring meetings with a fixed time.\n\nFor a list of supported timezones and their formats, see our [timezone list](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones)."
    },
    "recurrence": {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "enum": [
            1,
            2,
            3
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Daily",
              "Weekly",
              "Monthly"
            ]
          },
          "description": "Recurrence meeting types.\n `1` - Daily.  \n `2` - Weekly.  \n `3` - Monthly."
        },
        "end_times": {
          "type": "integer",
          "default": 1,
          "example": 7,
          "maximum": 60,
          "description": "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`."
        },
        "monthly_day": {
          "type": "integer",
          "default": 1,
          "example": 1,
          "description": "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.\n\nFor 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`."
        },
        "weekly_days": {
          "enum": [
            "1",
            "2",
            "3",
            "4",
            "5",
            "6",
            "7"
          ],
          "type": "string",
          "default": "1",
          "example": "1",
          "description": "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. \n  \n  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.  \n   \n  **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.\n\n   \n `1` - Sunday.   \n `2` - Monday.  \n `3` - Tuesday.  \n `4` -  Wednesday.  \n `5` -  Thursday.  \n `6` - Friday.  \n `7` - Saturday."
        },
        "monthly_week": {
          "enum": [
            -1,
            1,
            2,
            3,
            4
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Last week",
              "First week",
              "Second week",
              "Third week",
              "Fourth week"
            ]
          },
          "description": "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.   \n `-1` - Last week of the month.  \n `1` - First week of the month.  \n `2` - Second week of the month.  \n `3` - Third week of the month.  \n `4` - Fourth week of the month."
        },
        "end_date_time": {
          "type": "string",
          "format": "date-time",
          "example": "2022-04-02T15:59:00Z",
          "description": "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`."
        },
        "repeat_interval": {
          "type": "integer",
          "example": 1,
          "description": "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`. \n\nFor 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.\n\n"
        },
        "monthly_week_day": {
          "enum": [
            1,
            2,
            3,
            4,
            5,
            6,
            7
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Sunday",
              "Monday",
              "Tuesday",
              "Wednesday",
              "Thursday",
              "Friday",
              "Saturday"
            ]
          },
          "description": "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. \n\n  \n `1` - Sunday.  \n `2` - Monday.  \n `3` - Tuesday.  \n `4` -  Wednesday.  \n `5` - Thursday.  \n `6` - Friday.  \n `7` - Saturday."
        }
      },
      "description": "Recurrence object. Use this object only for a meeting with type `8`, a recurring meeting with a fixed time. "
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-25T07:32:55Z",
      "description": "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. \n* 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`. \n* 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.\n**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": {
      "type": "string",
      "example": "Dv4YdINdTk+Z5RToadh5ug==",
      "description": "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. \n* At this time, this field **only** accepts account admin meeting template IDs. \n* To enable the account admin meeting templates feature, [contact Zoom support](https://support.zoom.us/hc/en-us)."
    },
    "pre_schedule": {
      "type": "boolean",
      "default": false,
      "example": false,
      "description": "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). \n* `true` - Create a prescheduled meeting. \n* `false` - Create a regular meeting."
    },
    "schedule_for": {
      "type": "string",
      "example": "jchill@example.com",
      "description": "The email address or user ID of the user to schedule a meeting for."
    },
    "tracking_fields": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "field"
        ],
        "properties": {
          "field": {
            "type": "string",
            "example": "field1",
            "description": "The tracking field's label."
          },
          "value": {
            "type": "string",
            "example": "value1",
            "description": "The tracking field's value."
          }
        }
      },
      "description": "Information about the meeting's tracking fields."
    },
    "default_password": {
      "type": "boolean",
      "default": false,
      "example": false,
      "description": "Whether to generate a default passcode using the user's settings. This value defaults to `false`. \n\nIf 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."
    }
  },
  "description": "The base meeting object."
}

object MeetingsCreateMeetingResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 92674392836,
      "description": "The [meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-): Unique identifier of the meeting in **long** format(represented as int64 data type in JSON), also known as the meeting number."
    },
    "pmi": {
      "type": "string",
      "example": "97891943927",
      "description": "[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."
    },
    "type": {
      "enum": [
        1,
        2,
        3,
        8
      ],
      "type": "integer",
      "default": 2,
      "example": 2,
      "extensions": {
        "x-enum-descriptions": [
          "Instant Meeting",
          "Scheduled Meeting",
          "Recurring Meeting with no fixed time",
          "Recurring Meeting with fixed time"
        ]
      },
      "description": "Meeting type."
    },
    "topic": {
      "type": "string",
      "example": "My Meeting",
      "maxLength": 200,
      "description": "Meeting topic."
    },
    "agenda": {
      "type": "string",
      "example": "My Meeting",
      "description": "Agenda"
    },
    "duration": {
      "type": "integer",
      "example": 60,
      "description": "The meeting duration."
    },
    "join_url": {
      "type": "string",
      "example": "https://example.com/j/11111",
      "description": "URL for participants to join the meeting. This URL should only be shared with users that you would like to invite for the meeting."
    },
    "password": {
      "type": "string",
      "example": "123456",
      "description": "The meeting passcode. This passcode may only contain these characters: `[a-z A-Z 0-9 @ - _ * !]`\n\nIf **Require a passcode when scheduling new meetings** setting has been enabled and [locked](https://support.zoom.us/hc/en-us/articles/115005269866-Using-Tiered-Settings#locked) for the user, the passcode field will be autogenerated in the response even if it is not provided in the API request. \n\n\n"
    },
    "settings": {
      "type": "object",
      "properties": {
        "audio": {
          "enum": [
            "both",
            "telephony",
            "voip",
            "thirdParty"
          ],
          "type": "string",
          "default": "both",
          "example": "telephony",
          "extensions": {
            "x-enum-descriptions": [
              "Both Telephony and VoIP",
              "Telephony only",
              "VoIP only",
              "Third party audio conference"
            ]
          },
          "description": "Determine how participants can join the audio portion of the meeting.  \n `both` - Both Telephony and VoIP.  \n `telephony` - Telephony only.  \n `voip` - VoIP only.  \n `thirdParty` - Third party audio conference."
        },
        "use_pmi": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "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."
        },
        "jbh_time": {
          "enum": [
            0,
            5,
            10
          ],
          "type": "integer",
          "example": 0,
          "description": "If the value of `join_before_host` field is set to `true`, use this field to indicate time limits when a participant may join a meeting before a host.\n\n*  `0` - Allow participant to join anytime.\n*  `5`- Allow participant to join 5 minutes before meeting start time.\n * `10` - Allow participant to join 10 minutes before meeting start time."
        },
        "resources": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "resource_id": {
                "type": "string",
                "example": "X4Hy02w3QUOdskKofgb9Jg",
                "description": "The resource ID."
              },
              "resource_type": {
                "enum": [
                  "whiteboard"
                ],
                "type": "string",
                "example": "whiteboard",
                "description": "The resource type."
              },
              "permission_level": {
                "enum": [
                  "editor",
                  "commenter",
                  "viewer"
                ],
                "type": "string",
                "default": "editor",
                "example": "editor",
                "description": "The permission levels for users to access the whiteboard. \n* `editor` - Users with link access can edit the board. \n* `commenter` - Users with link access can comment on the board. \n* `viewer` - Users with link access can view the board."
              }
            }
          },
          "description": "The meeting's resources."
        },
        "watermark": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Add a watermark when viewing a shared screen."
        },
        "cn_meeting": {
          "type": "boolean",
          "default": false,
          "example": false,
          "deprecated": true,
          "description": "Host meeting in China."
        },
        "focus_mode": {
          "type": "boolean",
          "example": true,
          "description": "Whether the [**Focus Mode** feature](https://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) is enabled when the meeting starts."
        },
        "host_video": {
          "type": "boolean",
          "example": true,
          "description": "Start video when the host joins the meeting."
        },
        "in_meeting": {
          "type": "boolean",
          "default": false,
          "example": false,
          "deprecated": true,
          "description": "Host meeting in India."
        },
        "custom_keys": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string",
                "example": "key1",
                "maxLength": 64,
                "description": "Custom key associated with the user."
              },
              "value": {
                "type": "string",
                "example": "value1",
                "maxLength": 256,
                "description": "Value of the custom key associated with the user."
              }
            }
          },
          "maxItems": 10,
          "description": "Custom keys and values assigned to the meeting."
        },
        "contact_name": {
          "type": "string",
          "example": "Jill Chill",
          "description": "Contact name for registration"
        },
        "waiting_room": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Enable the waiting room."
        },
        "approval_type": {
          "enum": [
            0,
            1,
            2
          ],
          "type": "integer",
          "default": 2,
          "example": 0,
          "extensions": {
            "x-enum-descriptions": [
              "Automatically Approve",
              "Manually Approve",
              "No Registration Required"
            ]
          },
          "description": "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.**   \n   \n \n\n`0` - Automatically approve.  \n `1` - Manually approve.  \n `2` - No registration required."
        },
        "breakout_room": {
          "type": "object",
          "properties": {
            "rooms": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "example": "room1",
                    "description": "The breakout room's name."
                  },
                  "participants": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "example": "jchill@example.com"
                    },
                    "description": "Email addresses of the participants who are to be assigned to the breakout room."
                  }
                }
              },
              "description": "Create a room or rooms."
            },
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "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."
            }
          },
          "description": "Setting to [pre-assign breakout rooms](https://support.zoom.us/hc/en-us/articles/360032752671-Pre-assigning-participants-to-breakout-rooms#h_36f71353-4190-48a2-b999-ca129861c1f4)."
        },
        "calendar_type": {
          "enum": [
            1,
            2
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Outlook",
              "Google Calendar"
            ]
          },
          "description": "The type of calendar integration used to schedule the meeting. \n* `1` - [Zoom Outlook add-in](https://support.zoom.us/hc/en-us/articles/360031592971-Getting-started-with-Outlook-plugin-and-add-in) \n* `2` - [Zoom for Google Workspace add-on](https://support.zoom.us/hc/en-us/articles/360020187492-Using-the-Zoom-for-Google-Workspace-add-on)\n\nWorks with the `private_meeting` field to determine whether to share details of meetings or not."
        },
        "contact_email": {
          "type": "string",
          "example": "jchill@example.com",
          "description": "Contact email for registration"
        },
        "enforce_login": {
          "type": "boolean",
          "example": true,
          "deprecated": true,
          "description": "Only signed in users can join this meeting.\n\n**This field is deprecated and will not be supported in the future.**    \n   \n 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."
        },
        "auto_recording": {
          "enum": [
            "local",
            "cloud",
            "none"
          ],
          "type": "string",
          "default": "none",
          "example": "cloud",
          "extensions": {
            "x-enum-descriptions": [
              "Record to local device",
              "Record to cloud",
              "No Recording"
            ]
          },
          "description": "Automatic recording.\n `local` - Record on local.  \n `cloud` -  Record on cloud.  \n `none` - Disabled."
        },
        "encryption_type": {
          "enum": [
            "enhanced_encryption",
            "e2ee"
          ],
          "type": "string",
          "example": "enhanced_encryption",
          "description": "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 (e.g. cloud recording, phone/SIP/H.323 dial-in) will be **automatically disabled**.\n \n`enhanced_encryption` - Enhanced encryption. Encryption is stored in the cloud if you enable this option.   \n \n\n`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 join before host, cloud recording, streaming, live transcription, breakout rooms, polling, 1:1 private chat, and meeting reactions features."
        },
        "mute_upon_entry": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Mute participants upon entry."
        },
        "private_meeting": {
          "type": "boolean",
          "example": false,
          "description": "Whether the meeting is set as private."
        },
        "internal_meeting": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to set the meeting as an internal meeting."
        },
        "join_before_host": {
          "type": "boolean",
          "default": false,
          "example": true,
          "description": "Allow participants to join the meeting before the host starts the meeting. Only used for scheduled or recurring meetings."
        },
        "alternative_hosts": {
          "type": "string",
          "example": "jchill@example.com;thill@example.com",
          "description": "A semicolon-separated list of the meeting's alternative hosts' email addresses or IDs."
        },
        "participant_video": {
          "type": "boolean",
          "example": false,
          "description": "Start video when participants join the meeting."
        },
        "registration_type": {
          "enum": [
            1,
            2,
            3
          ],
          "type": "integer",
          "default": 1,
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Attendees register once and can attend any of the occurrences",
              "Attendees need to register for each occurrence to attend",
              "Attendees register once and can choose one or more occurrences to attend"
            ]
          },
          "description": "Registration type. Used for recurring meeting with fixed time only. \n `1` - Attendees register once and can attend any of the occurrences.  \n `2` - Attendees need to register for each occurrence to attend.  \n `3` - Attendees register once and can choose one or more occurrences to attend."
        },
        "show_share_button": {
          "type": "boolean",
          "example": true,
          "description": "Show social share buttons on the meeting registration page.\nThis setting only works for meetings that require [registration](https://support.zoom.us/hc/en-us/articles/211579443-Setting-up-registration-for-a-meeting)."
        },
        "close_registration": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Close registration after event date."
        },
        "email_notification": {
          "type": "boolean",
          "default": true,
          "example": true,
          "description": "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`."
        },
        "authentication_name": {
          "type": "string",
          "example": "Sign in to Zoom",
          "description": "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)."
        },
        "audio_conference_info": {
          "type": "string",
          "example": "test",
          "maxLength": 2048,
          "description": "Third party audio conference info."
        },
        "authentication_option": {
          "type": "string",
          "example": "signIn_D8cJuqWVQ623CI4Q8yQK0Q",
          "description": "Meeting authentication option ID."
        },
        "enforce_login_domains": {
          "type": "string",
          "example": "example.com",
          "deprecated": true,
          "description": "Only signed in users with specified domains can join meetings.\n\n**This field is deprecated and will not be supported in the future.**    \n   \n 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."
        },
        "host_save_video_order": {
          "type": "boolean",
          "example": true,
          "description": "Whether the **Allow host to save video order** feature is enabled."
        },
        "allow_multiple_devices": {
          "type": "boolean",
          "example": true,
          "description": "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)."
        },
        "authentication_domains": {
          "type": "string",
          "example": "example.com",
          "description": "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."
        },
        "global_dial_in_numbers": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "city": {
                "type": "string",
                "example": "New York",
                "description": "City of the number, such as Chicago."
              },
              "type": {
                "enum": [
                  "toll",
                  "tollfree"
                ],
                "type": "string",
                "example": "toll",
                "description": "Type of number."
              },
              "number": {
                "type": "string",
                "example": "+1 1000200200",
                "description": "A phone number, such as +1 2332357613."
              },
              "country": {
                "type": "string",
                "example": "US",
                "description": "The country code, such as BR."
              },
              "country_name": {
                "type": "string",
                "example": "US",
                "description": "Full name of country, such as Brazil."
              }
            }
          },
          "description": "Global dial-in countries or regions."
        },
        "meeting_authentication": {
          "type": "boolean",
          "example": true,
          "description": "`true` - Only authenticated users can join meetings."
        },
        "continuous_meeting_chat": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "Whether to enable the **Enable continuous meeting chat** setting."
            },
            "channel_id": {
              "type": "string",
              "example": "cabc1234567defghijkl01234",
              "description": "The channel's ID."
            },
            "auto_add_invited_external_users": {
              "type": "boolean",
              "example": true,
              "description": "Whether to enable the **Automatically add invited external users** setting."
            }
          },
          "description": "Information about the **Enable continuous meeting chat** feature."
        },
        "language_interpretation": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "Whether to enable [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars) for the meeting."
            },
            "interpreters": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "format": "email",
                    "example": "interpreter@example.com",
                    "description": "The interpreter's email address."
                  },
                  "languages": {
                    "type": "string",
                    "example": "US,FR",
                    "description": "A comma-separated list of the interpreter's languages. The string must contain two [country IDs](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries). \n\nFor example, if the interpreter will translate from English to Chinese, then this value will be `US,CN`."
                  }
                }
              },
              "description": "Information about the meeting's language interpreters."
            }
          },
          "description": "The meeting's [language interpretation settings](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** This feature is only available for certain Meeting add-on, Education, and Business and higher plans. If this feature is not enabled on the host's account, this setting will **not** be applied to the meeting."
        },
        "push_change_to_calendar": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to push meeting changes to the calendar. \n\n 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.\n* `true` - Push meeting changes to the calendar.\n* `false` - Do not push meeting changes to the calendar."
        },
        "authentication_exception": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "example": "Jill Chill",
                "description": "The participant's name."
              },
              "email": {
                "type": "string",
                "format": "email",
                "example": "jchill@example.com",
                "description": "The participant's email address."
              },
              "join_url": {
                "type": "string",
                "example": "https://example.com/s/11111",
                "description": "URL for participants to join the meeting."
              }
            }
          },
          "description": "The participants added here will receive unique meeting invite links and bypass authentication."
        },
        "global_dial_in_countries": {
          "type": "array",
          "items": {
            "type": "string",
            "example": "US"
          },
          "description": "List of global dial-in countries."
        },
        "auto_start_meeting_summary": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to automatically start a meeting summary."
        },
        "participant_focused_meeting": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to set the meeting as a participant focused meeting."
        },
        "sign_language_interpretation": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "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."
            },
            "interpreters": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "format": "email",
                    "example": "interpreter@example.com",
                    "description": "The interpreter's email address."
                  },
                  "sign_language": {
                    "type": "string",
                    "example": "American",
                    "description": "The interpreter's sign language. \n\n To get this value, use the `sign_language_interpretation` object's `languages` and `custom_languages` values in the [**Get user settings**](/api-reference/zoom-api/methods#operation/userSettings) API response."
                  }
                }
              },
              "maximum": 20,
              "description": "Information about the meeting's sign language interpreters."
            }
          },
          "description": "The meeting's [sign language interpretation settings](https://support.zoom.us/hc/en-us/articles/9644962487309-Using-sign-language-interpretation-in-a-meeting-or-webinar). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** If this feature is not enabled on the host's account, this setting will **not** be applied to the meeting."
        },
        "alternative_host_update_polls": {
          "type": "boolean",
          "example": true,
          "description": "Whether the **Allow alternative hosts to add or edit polls** feature is enabled. This requires Zoom version 5.8.0 or higher."
        },
        "registrants_confirmation_email": {
          "type": "boolean",
          "example": true,
          "description": "Whether to send registrants an email confirmation.\n* `true` - Send a confirmation email.\n* `false` - Do not send a confirmation email."
        },
        "registrants_email_notification": {
          "type": "boolean",
          "example": true,
          "description": "Whether to send registrants email notifications about their registration approval, cancellation, or rejection.\n\n* `true` - Send an email notification.\n* `false` - Do not send an email notification.\n\n Set this value to `true` to also use the `registrants_confirmation_email` parameter."
        },
        "auto_start_ai_companion_questions": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to automatically start AI Companion questions."
        },
        "alternative_hosts_email_notification": {
          "type": "boolean",
          "default": true,
          "example": true,
          "description": "Flag to determine whether to send email notifications to alternative hosts, default value is true."
        },
        "approved_or_denied_countries_or_regions": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "`true` - Setting enabled to either allow users or block users from specific regions to join your meetings.   \n \n\n`false` - Setting disabled."
            },
            "method": {
              "enum": [
                "approve",
                "deny"
              ],
              "type": "string",
              "example": "approve",
              "description": "Specify whether to allow users from specific regions to join this meeting; or block users from specific regions from joining this meeting.   \n   \n \n`approve`: Allow users from specific regions/countries to join this meeting. If this setting is selected, the approved regions/countries must be included in the `approved_list`.  \n   \n \n`deny`: Block users from specific regions/countries from joining this meeting. If this setting is selected, the approved regions/countries must be included in the `denied_list`"
            },
            "denied_list": {
              "type": "array",
              "items": {
                "type": "string",
                "example": "CA"
              },
              "description": "List of countries or regions from where participants can not join this meeting. "
            },
            "approved_list": {
              "type": "array",
              "items": {
                "type": "string",
                "example": "CX"
              },
              "description": "List of countries or regions from where participants can join this meeting. "
            }
          },
          "description": "Approve or block users from specific regions or countries from joining this meeting. \n"
        }
      },
      "description": "Meeting settings."
    },
    "timezone": {
      "type": "string",
      "example": "America/Los_Angeles",
      "description": "Timezone to format `start_time`."
    },
    "start_url": {
      "type": "string",
      "example": "https://example.com/s/11111",
      "description": "URL to start the meeting. This URL should only be used by the host of the meeting and **should not be shared with anyone other than the host** of the meeting, since anyone with this URL will be able to log in to the Zoom Client as the host of the meeting."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-25T07:29:29Z",
      "description": "The date and time when this meeting was created."
    },
    "host_email": {
      "type": "string",
      "format": "email",
      "example": "jchill@example.com",
      "description": "The meeting host's email address."
    },
    "recurrence": {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "enum": [
            1,
            2,
            3
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Daily",
              "Weekly",
              "Monthly"
            ]
          },
          "description": "Recurrence meeting types.\n `1` - Daily.  \n `2` - Weekly.  \n `3` - Monthly."
        },
        "end_times": {
          "type": "integer",
          "default": 1,
          "example": 7,
          "maximum": 60,
          "description": "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`."
        },
        "monthly_day": {
          "type": "integer",
          "default": 1,
          "example": 1,
          "description": "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.\n\nFor instance, if you would like 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, to have the meeting recur every three months on 23rd of the month, change the value of the `repeat_interval` field to `3`."
        },
        "weekly_days": {
          "enum": [
            "1",
            "2",
            "3",
            "4",
            "5",
            "6",
            "7"
          ],
          "type": "string",
          "default": "1",
          "example": "1",
          "description": "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.\n \n  This 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.  \n   \n  **Note:** If you would like 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.\n\n   \n `1`  - Sunday.   \n `2` - Monday.  \n `3` - Tuesday.  \n `4` -  Wednesday.  \n `5` -  Thursday.  \n `6` - Friday.  \n `7` - Saturday."
        },
        "monthly_week": {
          "enum": [
            -1,
            1,
            2,
            3,
            4
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Last week",
              "First week",
              "Second week",
              "Third week",
              "Fourth week"
            ]
          },
          "description": "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.   \n `-1` - Last week of the month.  \n `1` - First week of the month.  \n `2` - Second week of the month.  \n `3` - Third week of the month.  \n `4` - Fourth week of the month."
        },
        "end_date_time": {
          "type": "string",
          "format": "date-time",
          "example": "2022-04-02T15:59:00Z",
          "description": "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`."
        },
        "repeat_interval": {
          "type": "integer",
          "example": 1,
          "description": "Define the interval for the meeting to recur. For instance, to schedule a meeting that recurs every two months, set this field's value to `2` and the value of the `type` parameter as `3`. \n\nFor 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.\n\n"
        },
        "monthly_week_day": {
          "enum": [
            1,
            2,
            3,
            4,
            5,
            6,
            7
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Sunday",
              "Monday",
              "Tuesday",
              "Wednesday",
              "Thursday",
              "Friday",
              "Saturday"
            ]
          },
          "description": "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. \n\n  \n `1` - Sunday.  \n `2` - Monday.  \n `3` - Tuesday.  \n `4` -  Wednesday.  \n `5` - Thursday.  \n `6` - Friday.  \n `7` - Saturday."
        }
      },
      "description": "Recurrence object. Use this object only for a meeting with type `8`, a recurring meeting with fixed time. "
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-25T07:29:29Z",
      "description": "Meeting start date-time in UTC/GMT, such as `2020-03-31T12:02:00Z`."
    },
    "occurrences": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "status": {
            "enum": [
              "available",
              "deleted"
            ],
            "type": "string",
            "example": "available",
            "description": "Occurrence status. \n `available` - Available occurrence.  \n `deleted` -  Deleted occurrence."
          },
          "duration": {
            "type": "integer",
            "example": 60,
            "description": "Duration."
          },
          "start_time": {
            "type": "string",
            "format": "date-time",
            "example": "2022-03-25T07:46:00Z",
            "description": "Start time."
          },
          "occurrence_id": {
            "type": "string",
            "example": "1648194360000",
            "description": "Occurrence ID: Unique Identifier that identifies 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."
          }
        },
        "description": "Occurrence object. This object is only returned for recurring webinars."
      },
      "description": "Array of occurrence objects."
    },
    "assistant_id": {
      "type": "string",
      "example": "kFFvsJc-Q1OSxaJQLvaa_A",
      "description": "The ID of the user who scheduled this meeting on behalf of the host."
    },
    "pre_schedule": {
      "type": "boolean",
      "default": false,
      "example": false,
      "description": "Whether the prescheduled meeting was created 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). \n* `true` - A GSuite prescheduled meeting. \n* `false` - A regular meeting."
    },
    "chat_join_url": {
      "type": "string",
      "example": "https://example.com/launch/jc/11111",
      "description": "The URL to join the chat."
    },
    "h323_password": {
      "type": "string",
      "example": "123456",
      "description": "H.323/SIP room system passcode"
    },
    "tracking_fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "example": "field1",
            "description": "The tracking field's label."
          },
          "value": {
            "type": "string",
            "example": "value1",
            "description": "The tracking field's value."
          },
          "visible": {
            "type": "boolean",
            "example": true,
            "description": "Indicates whether the [tracking field](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) is visible in the meeting scheduling options in the Zoom Web Portal or not.\n\n`true`: Tracking field is visible.   \n \n\n`false`: Tracking field is not visible to the users in the meeting options in the Zoom Web Portal but the field was used while scheduling this meeting via API. An invisible tracking field can be used by users while scheduling meetings via API only. "
          }
        }
      },
      "description": "Tracking fields."
    },
    "registration_url": {
      "type": "string",
      "example": "https://example.com/meeting/register/7ksAkRCoEpt1Jm0wa-E6lICLur9e7Lde5oW6",
      "description": "The URL that registrants can use to register for a meeting. This field is only returned for meetings that have enabled registration."
    }
  },
  "description": "Meeting object."
}

object MeetingsCreatePollRequest

{
  "type": "object",
  "title": "Meeting and Webinar Polling Object",
  "properties": {
    "title": {
      "type": "string",
      "example": "Learn something new",
      "maxLength": 64,
      "description": "The poll's title, up to 64 characters."
    },
    "anonymous": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Allow meeting participants to answer poll questions anonymously. \n\nThis value defaults to `false`."
    },
    "poll_type": {
      "enum": [
        1,
        2,
        3
      ],
      "type": "integer",
      "example": 2,
      "description": "The type of poll: \n* `1` &mdash; Poll. \n* `2` &mdash; Advanced Poll. This feature must be enabled in your Zoom account. \n* `3` &mdash; Quiz. This feature must be enabled in your Zoom account. \n\n This value defaults to `1`."
    },
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "How useful was this meeting?",
            "maxLength": 255,
            "description": "The poll question, up to 255 characters. \n\nFor `fill_in_the_blank` polls, this field is the poll's question. For each value that the user must fill in, ensure that there are the same number of `right_answers` values."
          },
          "type": {
            "enum": [
              "single",
              "multiple",
              "matching",
              "rank_order",
              "short_answer",
              "long_answer",
              "fill_in_the_blank",
              "rating_scale"
            ],
            "type": "string",
            "example": "single",
            "extensions": {
              "x-enum-descriptions": [
                "Single choice",
                "Multiple choice",
                "Matching",
                "Rank order",
                "Short answer",
                "Long answer",
                "Fill in the blank",
                "Rating scale"
              ]
            },
            "description": "The poll's question and answer type: \n* `single` &mdash; Single choice. \n* `multiple` &mdash; Multiple choice. \n* `matching` &mdash; Matching. \n* `rank_order` &mdash; Rank order. \n* `short_answer` &mdash; Short answer. \n* `long_answer` &mdash; Long answer. \n* `fill_in_the_blank` &mdash; Fill in the blank. \n* `rating_scale` &mdash; Rating scale."
          },
          "answers": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "Extremely useful"
            },
            "minItems": 2,
            "description": "The poll question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` polls, you can only provide a maximum of 10 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers."
          },
          "prompts": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "prompt_question": {
                  "type": "string",
                  "example": "How are you?",
                  "description": "The question prompt's title."
                },
                "prompt_right_answers": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "Good"
                  },
                  "description": "The question prompt's correct answers: \n* For `matching` polls, you must provide a minimum of two correct answers, up to a maximum of 10 correct answers. \n* For `rank_order` polls, you can only provide one correct answer."
                }
              }
            },
            "description": "Information about the prompt questions. This field only applies to `matching` and `rank_order` polls. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts."
          },
          "right_answers": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "Good"
            },
            "minItems": 1,
            "description": "The poll question's correct answer(s). This field is **required** if the poll's `type` value is `3` (Quiz). \n\n For `single` and `matching` polls, this field only accepts one answer."
          },
          "case_sensitive": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether the correct answer is case sensitive. This field only applies to `fill_in_the_blank` polls: \n* `true` &mdash; The answer is case-sensitive. \n* `false` &mdash; The answer is not case-sensitive. \n\nThis value defaults to `false`."
          },
          "answer_required": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether participants must answer the question: \n* `true` &mdash; The participant must answer the question. \n* `false` &mdash; The participant does not need to answer the question. \n\n**Note:** \n* When the poll's `type` value is `1` (Poll), this value defaults to `true`. \n* When the poll's `type` value is the `2` (Advanced Poll) or `3` (Quiz) values, this value defaults to `false`."
          },
          "rating_max_label": {
            "type": "string",
            "example": "Extremely Likely",
            "description": "The high score label used for the `rating_max_value` field. \n\nThis field only applies to the `rating_scale` poll."
          },
          "rating_max_value": {
            "type": "integer",
            "example": 4,
            "maximum": 10,
            "description": "The rating scale's maximum value, up to a maximum value of 10. \n\nThis field only applies to the `rating_scale` poll."
          },
          "rating_min_label": {
            "type": "string",
            "example": "Not likely",
            "description": "The low score label used for the `rating_min_value` field. \n\nThis field only applies to the `rating_scale` poll."
          },
          "rating_min_value": {
            "type": "integer",
            "example": 0,
            "minimum": 0,
            "description": "The rating scale's minimum value. This value cannot be less than zero. \n\nThis field only applies to the `rating_scale` poll."
          },
          "show_as_dropdown": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether to display the radio selection as a drop-down box: \n* `true` &mdash; Show as a drop-down box. \n* `false` &mdash; Do not show as a drop-down box. \n\nThis value defaults to `false`."
          },
          "answer_max_character": {
            "type": "integer",
            "example": 200,
            "description": "The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` polls: \n* For `short_answer` polls, a maximum of 500 characters. \n* For `long_answer` polls, a maximum of 2,000 characters."
          },
          "answer_min_character": {
            "type": "integer",
            "example": 1,
            "minimum": 1,
            "description": "The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` polls. You must provide at least a **one** character minimum value."
          }
        }
      },
      "description": "Information about the poll's questions."
    }
  },
  "description": "Information about meeting and webinar polling."
}

object MeetingsCreatePollResponse

{
  "type": "object",
  "title": "Meeting and Webinar Polling Object",
  "properties": {
    "id": {
      "type": "string",
      "example": "QalIoKWLTJehBJ8e1xRrbQ",
      "description": "Meeting Poll ID"
    },
    "title": {
      "type": "string",
      "example": "Learn something new",
      "maxLength": 64,
      "description": "The poll's title, up to 64 characters."
    },
    "status": {
      "enum": [
        "notstart",
        "started",
        "ended",
        "sharing"
      ],
      "type": "string",
      "example": "notstart",
      "extensions": {
        "x-enum-descriptions": [
          "Poll not start",
          "Poll started",
          "Poll ended",
          "Poll is sharing"
        ]
      },
      "description": "Status of the Meeting Poll:  \n `notstart` - Poll not started  \n `started` - Poll started  \n `ended` - Poll ended  \n `sharing` - Sharing poll results"
    },
    "anonymous": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Allow meeting participants to answer poll questions anonymously. \n\nThis value defaults to `false`."
    },
    "poll_type": {
      "enum": [
        1,
        2,
        3
      ],
      "type": "integer",
      "example": 2,
      "description": "The type of poll: \n* `1` &mdash; Poll. \n* `2` &mdash; Advanced Poll. This feature must be enabled in your Zoom account. \n* `3` &mdash; Quiz. This feature must be enabled in your Zoom account. \n\n This value defaults to `1`."
    },
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "How useful was this meeting?",
            "maxLength": 255,
            "description": "The poll question, up to 255 characters. \n\nFor `fill_in_the_blank` polls, this field is the poll's question. For each value that the user must fill in, ensure that there are the same number of `right_answers` values."
          },
          "type": {
            "enum": [
              "single",
              "multiple",
              "matching",
              "rank_order",
              "short_answer",
              "long_answer",
              "fill_in_the_blank",
              "rating_scale"
            ],
            "type": "string",
            "example": "single",
            "extensions": {
              "x-enum-descriptions": [
                "Single choice",
                "Multiple choice",
                "Matching",
                "Rank order",
                "Short answer",
                "Long answer",
                "Fill in the blank",
                "Rating scale"
              ]
            },
            "description": "The poll's question and answer type: \n* `single` &mdash; Single choice. \n* `multiple` &mdash; Multiple choice. \n* `matching` &mdash; Matching. \n* `rank_order` &mdash; Rank order. \n* `short_answer` &mdash; Short answer. \n* `long_answer` &mdash; Long answer. \n* `fill_in_the_blank` &mdash; Fill in the blank. \n* `rating_scale` &mdash; Rating scale."
          },
          "answers": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "Extremely useful"
            },
            "minItems": 2,
            "description": "The poll question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` polls, you can only provide a maximum of 10 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers."
          },
          "prompts": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "prompt_question": {
                  "type": "string",
                  "example": "How are you?",
                  "description": "The question prompt's title."
                },
                "prompt_right_answers": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "Good"
                  },
                  "description": "The question prompt's correct answers: \n* For `matching` polls, you must provide a minimum of two correct answers, up to a maximum of 10 correct answers. \n* For `rank_order` polls, you can only provide one correct answer."
                }
              }
            },
            "description": "Information about the prompt questions. This field only applies to `matching` and `rank_order` polls. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts."
          },
          "right_answers": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "Good"
            },
            "minItems": 1,
            "description": "The poll question's correct answer(s). This field is **required** if the poll's `type` value is `3` (Quiz). \n\n For `single` and `matching` polls, this field only accepts one answer."
          },
          "case_sensitive": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether the correct answer is case sensitive. This field only applies to `fill_in_the_blank` polls: \n* `true` &mdash; The answer is case-sensitive. \n* `false` &mdash; The answer is not case-sensitive. \n\nThis value defaults to `false`."
          },
          "answer_required": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether participants must answer the question: \n* `true` &mdash; The participant must answer the question. \n* `false` &mdash; The participant does not need to answer the question. \n\n**Note:** \n* When the poll's `type` value is `1` (Poll), this value defaults to `true`. \n* When the poll's `type` value is the `2` (Advanced Poll) or `3` (Quiz) values, this value defaults to `false`."
          },
          "rating_max_label": {
            "type": "string",
            "example": "Extremely Likely",
            "description": "The high score label used for the `rating_max_value` field. \n\nThis field only applies to the `rating_scale` poll."
          },
          "rating_max_value": {
            "type": "integer",
            "example": 4,
            "maximum": 10,
            "description": "The rating scale's maximum value, up to a maximum value of 10. \n\nThis field only applies to the `rating_scale` poll."
          },
          "rating_min_label": {
            "type": "string",
            "example": "Not likely",
            "description": "The low score label used for the `rating_min_value` field. \n\nThis field only applies to the `rating_scale` poll."
          },
          "rating_min_value": {
            "type": "integer",
            "example": 0,
            "minimum": 0,
            "description": "The rating scale's minimum value. This value cannot be less than zero. \n\nThis field only applies to the `rating_scale` poll."
          },
          "show_as_dropdown": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether to display the radio selection as a drop-down box: \n* `true` &mdash; Show as a drop-down box. \n* `false` &mdash; Do not show as a drop-down box. \n\nThis value defaults to `false`."
          },
          "answer_max_character": {
            "type": "integer",
            "example": 200,
            "description": "The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` polls: \n* For `short_answer` polls, a maximum of 500 characters. \n* For `long_answer` polls, a maximum of 2,000 characters."
          },
          "answer_min_character": {
            "type": "integer",
            "example": 1,
            "minimum": 1,
            "description": "The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` polls. You must provide at least a **one** character minimum value."
          }
        }
      },
      "description": "Information about the poll's questions."
    }
  },
  "description": "Information about meeting and webinar polling."
}

object MeetingsCreateTemplateFromMeetingRequest

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "example": "My Meeting Template",
      "description": "The template name."
    },
    "overwrite": {
      "type": "boolean",
      "default": false,
      "example": false,
      "description": "Overwrite an existing meeting template if the template is created from same existing meeting."
    },
    "meeting_id": {
      "type": "integer",
      "format": "int64",
      "example": 96172769962,
      "description": "The meeting ID aka the meeting number in long (int64) format."
    },
    "save_recurrence": {
      "type": "boolean",
      "default": false,
      "example": false,
      "description": "If the field is set to true, the recurrence meeting template will be saved as the scheduled meeting."
    }
  }
}

object MeetingsCreateTemplateFromMeetingResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "AdxbhxCzKgSiWAw",
      "description": "The template ID."
    },
    "name": {
      "type": "string",
      "example": "My Meeting Template",
      "description": "The template name."
    }
  }
}

object MeetingsGetDetails200Response

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 5638296721,
      "description": "The [meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID)."
    },
    "dept": {
      "type": "string",
      "example": "Developers",
      "description": "The meeting host's department."
    },
    "type": {
      "enum": [
        0,
        1,
        2,
        3,
        4,
        7,
        8
      ],
      "type": "integer",
      "example": 1,
      "description": "The meeting type: \n* `0` &mdash; A prescheduled meeting. \n* `1` &mdash; An instant meeting. \n* `2` &mdash; A scheduled meeting. \n* `3` &mdash; A recurring meeting with no fixed time. \n* `4` &mdash; A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` &mdash; A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` &mdash; A recurring meeting with a fixed time."
    },
    "uuid": {
      "type": "string",
      "example": "4444AAAiAAAAAiAiAiiAii==",
      "description": "The meeting's UUID. You **must** [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) this value if the meeting UUID begins with a `/` character or contains the `//` character."
    },
    "topic": {
      "type": "string",
      "example": "My Meeting",
      "description": "The meeting's topic."
    },
    "source": {
      "type": "string",
      "example": "Zoom",
      "description": "Whether the meeting was created directly through Zoom or via an API request: \n* If the meeting was created via an OAuth app, this field returns the OAuth app's name. \n* If the meeting was created via JWT or the Zoom Web Portal, this returns the `Zoom` value."
    },
    "host_id": {
      "type": "string",
      "example": "x1yCzABCDEfg23HiJKl4mN",
      "description": "The host's ID."
    },
    "duration": {
      "type": "integer",
      "example": 60,
      "description": "The meeting's duration, in minutes."
    },
    "end_time": {
      "type": "string",
      "format": "date-time",
      "example": "2021-07-13T23:00:51Z",
      "description": "The meeting's end date and time."
    },
    "user_name": {
      "type": "string",
      "example": "Jill Chill",
      "description": "The user's display name."
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2021-07-13T21:44:51Z",
      "description": "The meeting's start date and time."
    },
    "user_email": {
      "type": "string",
      "format": "email",
      "example": "jchill@example.com",
      "description": "The user's email address."
    },
    "total_minutes": {
      "type": "integer",
      "example": 55,
      "description": "The total number of minutes attended by the meeting's host and participants."
    },
    "participants_count": {
      "type": "integer",
      "example": 2,
      "description": "The number of meeting participants."
    }
  }
}

object MeetingsGetDetailsResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 97763643886,
      "description": "[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-): Unique identifier of the meeting in **long** format, represented as int64 data type in JSON, also known as the meeting number."
    },
    "pmi": {
      "type": "string",
      "example": "97891943927",
      "description": "[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."
    },
    "type": {
      "enum": [
        1,
        2,
        3,
        8
      ],
      "type": "integer",
      "default": 2,
      "example": 2,
      "extensions": {
        "x-enum-descriptions": [
          "Instant Meeting",
          "Scheduled Meeting",
          "Recurring Meeting with no fixed time",
          "Recurring Meeting with fixed time"
        ]
      },
      "description": "Meeting types. \n `1` - Instant meeting.  \n `2` - Scheduled meeting.  \n `3` - Recurring meeting with no fixed time.  \n `4` - PMI Meeting  \n \n`8` - Recurring meeting with a fixed time."
    },
    "uuid": {
      "type": "string",
      "example": "aDYlohsHRtCd4ii1uC2+hA==",
      "description": "Unique meeting ID. Each meeting instance generates its own meeting UUID - after a meeting ends, a new UUID is generated for the next instance of the meeting. Retrieve a list of UUIDs from past meeting instances using the [**List past meeting instances**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods#operation/pastMeetings) API. [Double encode](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#meeting-id-and-uuid) your UUID when using it for API calls if the UUID begins with a `/` or contains `//` in it.\n"
    },
    "topic": {
      "type": "string",
      "example": "My Meeting",
      "description": "Meeting topic."
    },
    "agenda": {
      "type": "string",
      "example": "My Meeting",
      "maxLength": 2000,
      "description": "The meeting description."
    },
    "status": {
      "enum": [
        "waiting",
        "started"
      ],
      "type": "string",
      "example": "waiting",
      "description": "Meeting status"
    },
    "host_id": {
      "type": "string",
      "example": "30R7kT7bTIKSNUFEuH_Qlg",
      "description": "The ID of the user who is set as the meeting host."
    },
    "duration": {
      "type": "integer",
      "example": 60,
      "description": "The meeting duration."
    },
    "join_url": {
      "type": "string",
      "example": "https://example.com/j/11111",
      "description": "The URL for participants to join the meeting. This URL should only be shared with users invited to the meeting."
    },
    "password": {
      "type": "string",
      "example": "123456",
      "minimum": 8,
      "description": "Meeting passcode."
    },
    "settings": {
      "type": "object",
      "properties": {
        "audio": {
          "enum": [
            "both",
            "telephony",
            "voip",
            "thirdParty"
          ],
          "type": "string",
          "default": "both",
          "example": "telephony",
          "extensions": {
            "x-enum-descriptions": [
              "Both Telephony and VoIP",
              "Telephony only",
              "VoIP only",
              "Third party audio conference"
            ]
          },
          "description": "Determine how participants can join the audio portion of the meeting.  \n `both` - Both Telephony and VoIP.  \n `telephony` - Telephony only.  \n `voip` - VoIP only.  \n `thirdParty` - Third party audio conference."
        },
        "use_pmi": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "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."
        },
        "jbh_time": {
          "enum": [
            0,
            5,
            10
          ],
          "type": "integer",
          "example": 0,
          "description": "If the value of `join_before_host` field is set to true, this field can be used to indicate time limits when a participant may join a meeting before a host.\n\n*  `0` - Allow participant to join anytime.\n*  `5` - Allow participant to join 5 minutes before meeting start time.\n * `10` - Allow participant to join 10 minutes before meeting start time."
        },
        "resources": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "resource_id": {
                "type": "string",
                "example": "X4Hy02w3QUOdskKofgb9Jg",
                "description": "The resource ID."
              },
              "resource_type": {
                "enum": [
                  "whiteboard"
                ],
                "type": "string",
                "example": "whiteboard",
                "description": "The resource type."
              },
              "permission_level": {
                "enum": [
                  "editor",
                  "commenter",
                  "viewer"
                ],
                "type": "string",
                "default": "editor",
                "example": "editor",
                "description": "The permission levels for users to access the whiteboard. \n* `editor` - Users with link access can edit the board. \n* `commenter` - Users with link access can comment on the board. \n* `viewer` - Users with link access can view the board."
              }
            }
          },
          "description": "The meeting's resources."
        },
        "watermark": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Add watermark when viewing a shared screen."
        },
        "cn_meeting": {
          "type": "boolean",
          "default": false,
          "example": false,
          "deprecated": true,
          "description": "Host meeting in China."
        },
        "focus_mode": {
          "type": "boolean",
          "example": true,
          "description": "Whether the [**Focus Mode** feature](https://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) is enabled when the meeting starts."
        },
        "host_video": {
          "type": "boolean",
          "example": true,
          "description": "Start video when the host joins the meeting."
        },
        "in_meeting": {
          "type": "boolean",
          "default": false,
          "example": false,
          "deprecated": true,
          "description": "Host meeting in India."
        },
        "custom_keys": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string",
                "example": "key1",
                "maxLength": 64,
                "description": "Custom key associated with the user."
              },
              "value": {
                "type": "string",
                "example": "value1",
                "maxLength": 256,
                "description": "Value of the custom key associated with the user."
              }
            }
          },
          "maxItems": 10,
          "description": "Custom keys and values assigned to the meeting."
        },
        "contact_name": {
          "type": "string",
          "example": "Jill Chill",
          "description": "Contact name for registration"
        },
        "waiting_room": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Enable waiting room"
        },
        "approval_type": {
          "enum": [
            0,
            1,
            2
          ],
          "type": "integer",
          "default": 2,
          "example": 0,
          "extensions": {
            "x-enum-descriptions": [
              "Automatically Approve",
              "Manually Approve",
              "No Registration Required"
            ]
          },
          "description": "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.**   \n   \n \n\n`0` - Automatically approve.  \n `1` - Manually approve.  \n `2` - No registration required."
        },
        "breakout_room": {
          "type": "object",
          "properties": {
            "rooms": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "example": "room1",
                    "description": "The breakout room's name."
                  },
                  "participants": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "example": "jchill@example.com"
                    },
                    "description": "Email addresses of the participants who are to be assigned to the breakout room."
                  }
                }
              },
              "description": "Create room(s)."
            },
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "Set this field's value to `true` if you would like 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."
            }
          },
          "description": "Setting to [pre-assign breakout rooms](https://support.zoom.us/hc/en-us/articles/360032752671-Pre-assigning-participants-to-breakout-rooms#h_36f71353-4190-48a2-b999-ca129861c1f4)."
        },
        "calendar_type": {
          "enum": [
            1,
            2
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Outlook",
              "Google Calendar"
            ]
          },
          "description": "Indicates the type of calendar integration used to schedule the meeting. \n* `1` - [Zoom Outlook add-in](https://support.zoom.us/hc/en-us/articles/360031592971-Getting-started-with-Outlook-plugin-and-add-in) \n* `2` - [Zoom for Google Workspace add-on](https://support.zoom.us/hc/en-us/articles/360020187492-Using-the-Zoom-for-Google-Workspace-add-on)\n\nWorks with the `private_meeting` field to determine whether to share details of meetings or not."
        },
        "contact_email": {
          "type": "string",
          "example": "jchill@example.com",
          "description": "Contact email for registration"
        },
        "enforce_login": {
          "type": "boolean",
          "example": true,
          "deprecated": true,
          "description": "Only signed in users can join this meeting.\n\n**This field is deprecated and will not be supported in the future.**    \n   \n 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."
        },
        "auto_recording": {
          "enum": [
            "local",
            "cloud",
            "none"
          ],
          "type": "string",
          "default": "none",
          "example": "cloud",
          "extensions": {
            "x-enum-descriptions": [
              "Record to local device",
              "Record to cloud",
              "No Recording"
            ]
          },
          "description": "Automatic recording:  \n `local` - Record on local.  \n `cloud` -  Record on cloud.  \n `none` - Disabled."
        },
        "encryption_type": {
          "enum": [
            "enhanced_encryption",
            "e2ee"
          ],
          "type": "string",
          "example": "enhanced_encryption",
          "description": "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 (e.g. cloud recording, phone/SIP/H.323 dial-in) will be **automatically disabled**. \n \n`enhanced_encryption` - Enhanced encryption. Encryption is stored in the cloud if you enable this option.   \n \n\n`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 join before host, cloud recording, streaming, live transcription, breakout rooms, polling, 1:1 private chat, and meeting reactions features."
        },
        "mute_upon_entry": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Mute participants upon entry."
        },
        "private_meeting": {
          "type": "boolean",
          "example": false,
          "description": "Whether the meeting is set as private."
        },
        "internal_meeting": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to set the meeting as an internal meeting."
        },
        "join_before_host": {
          "type": "boolean",
          "default": false,
          "example": true,
          "description": "Allow participants to join the meeting before the host starts the meeting. Only used for scheduled or recurring meetings."
        },
        "alternative_hosts": {
          "type": "string",
          "example": "jchill@example.com;thill@example.com",
          "description": "A semicolon-separated list of the meeting's alternative hosts' email addresses or IDs."
        },
        "participant_video": {
          "type": "boolean",
          "example": false,
          "description": "Start video when participants join the meeting."
        },
        "registration_type": {
          "enum": [
            1,
            2,
            3
          ],
          "type": "integer",
          "default": 1,
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Attendees register once and can attend any of the occurrences",
              "Attendees need to register for each occurrence to attend",
              "Attendees register once and can choose one or more occurrences to attend"
            ]
          },
          "description": "Registration type. Used for recurring meeting with fixed time only. \n `1` Attendees register once and can attend any of the occurrences.  \n `2` Attendees need to register for each occurrence to attend.  \n `3` Attendees register once and can choose one or more occurrences to attend."
        },
        "show_share_button": {
          "type": "boolean",
          "example": true,
          "description": "Show social share buttons on the meeting registration page.\nThis setting only works for meetings that require [registration](https://support.zoom.us/hc/en-us/articles/211579443-Setting-up-registration-for-a-meeting)."
        },
        "close_registration": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Close registration after event date"
        },
        "email_notification": {
          "type": "boolean",
          "default": true,
          "example": true,
          "description": "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`."
        },
        "authentication_name": {
          "type": "string",
          "example": "Sign in to Zoom",
          "description": "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)."
        },
        "audio_conference_info": {
          "type": "string",
          "example": "test",
          "maxLength": 2048,
          "description": "Third party audio conference info."
        },
        "authentication_option": {
          "type": "string",
          "example": "signIn_D8cJuqWVQ623CI4Q8yQK0Q",
          "description": "Meeting authentication option id."
        },
        "enforce_login_domains": {
          "type": "string",
          "example": "example.com",
          "deprecated": true,
          "description": "Only signed in users with specified domains can join meetings.\n\n**This field is deprecated and will not be supported in the future.**    \n   \n 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."
        },
        "host_save_video_order": {
          "type": "boolean",
          "example": true,
          "description": "Whether the **Allow host to save video order** feature is enabled."
        },
        "allow_multiple_devices": {
          "type": "boolean",
          "example": true,
          "description": "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)."
        },
        "authentication_domains": {
          "type": "string",
          "example": "example.com",
          "description": "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."
        },
        "global_dial_in_numbers": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "city": {
                "type": "string",
                "example": "New York",
                "description": "City of the number, if any. For example, Chicago."
              },
              "type": {
                "enum": [
                  "toll",
                  "tollfree"
                ],
                "type": "string",
                "example": "toll",
                "description": "Type of number. "
              },
              "number": {
                "type": "string",
                "example": "+1 1000200200",
                "description": "Phone number. For example, +1 2332357613."
              },
              "country": {
                "type": "string",
                "example": "US",
                "description": "Country code. For example, BR."
              },
              "country_name": {
                "type": "string",
                "example": "US",
                "description": "Full name of country. For example, Brazil."
              }
            }
          },
          "description": "Global Dial-in Countries/Regions"
        },
        "meeting_authentication": {
          "type": "boolean",
          "example": true,
          "description": "`true` - Only authenticated users can join meetings."
        },
        "continuous_meeting_chat": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "Whether to enable the **Enable continuous meeting chat** setting."
            },
            "channel_id": {
              "type": "string",
              "example": "cabc1234567defghijkl01234",
              "description": "The channel's ID."
            },
            "auto_add_invited_external_users": {
              "type": "boolean",
              "example": true,
              "description": "Whether to enable the **Automatically add invited external users** setting."
            }
          },
          "description": "Information about the **Enable continuous meeting chat** feature."
        },
        "language_interpretation": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "Whether to enable [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars) for the meeting."
            },
            "interpreters": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "format": "email",
                    "example": "interpreter@example.com",
                    "description": "The interpreter's email address."
                  },
                  "languages": {
                    "type": "string",
                    "example": "US,FR",
                    "description": "A comma-separated list of the interpreter's languages. The string must contain two [country IDs](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries). \n\nFor example, if the interpreter will translate from English to Chinese, then this value will be `US,CN`."
                  }
                }
              },
              "description": "Information about the meeting's language interpreters."
            }
          },
          "description": "The meeting's [language interpretation settings](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** This feature is only available for certain Meeting add-on, Education, and Business and higher plans. If this feature is not enabled on the host's account, this setting will **not** be applied to the meeting."
        },
        "push_change_to_calendar": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to push meeting changes to the calendar. \n\n 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.\n* `true` - Push meeting changes to the calendar.\n* `false` - Do not push meeting changes to the calendar."
        },
        "authentication_exception": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "example": "Jill Chill",
                "description": "Name of the participant."
              },
              "email": {
                "type": "string",
                "format": "email",
                "example": "jchill@example.com",
                "description": "Email address of the participant."
              },
              "join_url": {
                "type": "string",
                "example": "https://example.com/s/11111",
                "description": "URL for participants to join the meeting"
              }
            }
          },
          "description": "The participants added here will receive unique meeting invite links and bypass authentication."
        },
        "global_dial_in_countries": {
          "type": "array",
          "items": {
            "type": "string",
            "example": "US"
          },
          "description": "List of global dial-in countries"
        },
        "auto_start_meeting_summary": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to automatically start a meeting summary."
        },
        "participant_focused_meeting": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to set the meeting as a participant focused meeting."
        },
        "sign_language_interpretation": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "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."
            },
            "interpreters": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "format": "email",
                    "example": "interpreter@example.com",
                    "description": "The interpreter's email address."
                  },
                  "sign_language": {
                    "type": "string",
                    "example": "American",
                    "description": "The interpreter's sign language. \n\n To get this value, use the `sign_language_interpretation` object's `languages` and `custom_languages` values in the [**Get user settings**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods#operation/userSettings) API response."
                  }
                }
              },
              "maximum": 20,
              "description": "Information about the meeting's sign language interpreters."
            }
          },
          "description": "The meeting's [sign language interpretation settings](https://support.zoom.us/hc/en-us/articles/9644962487309-Using-sign-language-interpretation-in-a-meeting-or-webinar). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** If this feature is not enabled on the host's account, this setting will **not** be applied to the meeting."
        },
        "alternative_host_update_polls": {
          "type": "boolean",
          "example": true,
          "description": "Whether the **Allow alternative hosts to add or edit polls** feature is enabled. This requires Zoom version 5.8.0 or higher."
        },
        "registrants_confirmation_email": {
          "type": "boolean",
          "example": true,
          "description": "Whether to send registrants an email confirmation.\n* `true` - Send a confirmation email.\n* `false` - Do not send a confirmation email."
        },
        "registrants_email_notification": {
          "type": "boolean",
          "example": true,
          "description": "Whether to send registrants email notifications about their registration approval, cancellation, or rejection.\n\n* `true` - Send an email notification.\n* `false` - Do not send an email notification.\n\n Set this value to `true` to also use the `registrants_confirmation_email` parameter."
        },
        "auto_start_ai_companion_questions": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to automatically start AI Companion questions."
        },
        "alternative_hosts_email_notification": {
          "type": "boolean",
          "default": true,
          "example": true,
          "description": "Flag to determine whether to send email notifications to alternative hosts, default value is true."
        },
        "approved_or_denied_countries_or_regions": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "`true`: Setting enabled to either allow users or block users from specific regions to join your meetings.   \n \n\n`false`: Setting disabled."
            },
            "method": {
              "enum": [
                "approve",
                "deny"
              ],
              "type": "string",
              "example": "approve",
              "description": "Specify whether to allow users from specific regions to join this meeting; or block users from specific regions from joining this meeting.   \n   \n \n`approve`: Allow users from specific regions/countries to join this meeting. If this setting is selected, the approved regions/countries must be included in the `approved_list`.  \n   \n \n`deny`: Block users from specific regions/countries from joining this meeting. If this setting is selected, the approved regions/countries must be included in the `denied_list`"
            },
            "denied_list": {
              "type": "array",
              "items": {
                "type": "string",
                "example": "CA"
              },
              "description": "List of countries/regions from where participants can not join this meeting. "
            },
            "approved_list": {
              "type": "array",
              "items": {
                "type": "string",
                "example": "CX"
              },
              "description": "List of countries/regions from where participants can join this meeting. "
            }
          },
          "description": "Approve or block users from specific regions/countries from joining this meeting. \n"
        }
      },
      "description": "Meeting settings."
    },
    "timezone": {
      "type": "string",
      "example": "America/Los_Angeles",
      "description": "The timezone to format the meeting start time."
    },
    "start_url": {
      "type": "string",
      "example": "https://example.com/s/11111",
      "description": "The `start_url` of a meeting is a URL that a host or an alternative host can start the meeting. \n\nThe expiration time for the `start_url` field listed in the response of the [**Create a meeting**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods#operation/meetingCreate) API is two hours for all regular users. \n\t\nFor users created using the `custCreate` option via the [**Create users**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods#operation/userCreate) API, the expiration time of the `start_url` field is 90 days.\n\t\nFor security reasons, to retrieve the updated value for the `start_url` field programmatically after the expiry time, you must call the [**Get a meeting](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods#operation/meeting) API and refer to the value of the `start_url` field in the response.  \n This URL should only be used by the host of the meeting and **should not be shared with anyone other than the host** of the meeting as anyone with this URL will be able to login to the Zoom Client as the host of the meeting."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-25T07:29:29Z",
      "description": "The creation time. "
    },
    "host_email": {
      "type": "string",
      "format": "email",
      "example": "jchill@example.com",
      "description": "The meeting host's email address."
    },
    "recurrence": {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "enum": [
            1,
            2,
            3
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Daily",
              "Weekly",
              "Monthly"
            ]
          },
          "description": "Recurrence meeting types:  \n `1` - Daily.  \n `2` - Weekly.  \n `3` - Monthly."
        },
        "end_times": {
          "type": "integer",
          "default": 1,
          "example": 7,
          "maximum": 60,
          "description": "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`."
        },
        "monthly_day": {
          "type": "integer",
          "default": 1,
          "example": 1,
          "description": "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.\n\nFor example, for a 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, to have the meeting to recur every three months on 23rd of the month, change the `repeat_interval` field's value to `3`."
        },
        "weekly_days": {
          "enum": [
            "1",
            "2",
            "3",
            "4",
            "5",
            "6",
            "7"
          ],
          "type": "string",
          "default": "1",
          "example": "1",
          "description": "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.   \n    \n  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.  \n   \n  **Note** To have the meeting 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.\n\n\n `1`  - Sunday.   \n `2` - Monday.  \n `3` - Tuesday.  \n `4` -  Wednesday.  \n `5` -  Thursday.  \n `6` - Friday.  \n `7` - Saturday."
        },
        "monthly_week": {
          "enum": [
            -1,
            1,
            2,
            3,
            4
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Last week",
              "First week",
              "Second week",
              "Third week",
              "Fourth week"
            ]
          },
          "description": "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.**   \n `-1` - Last week of the month.  \n `1` - First week of the month.  \n `2` - Second week of the month.  \n `3` - Third week of the month.  \n `4` - Fourth week of the month."
        },
        "end_date_time": {
          "type": "string",
          "format": "date-time",
          "example": "2022-04-02T15:59:00Z",
          "description": "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`.)"
        },
        "repeat_interval": {
          "type": "integer",
          "example": 1,
          "description": "Define the interval when the meeting should recur. For instance, to schedule a meeting that recurs every two months, you must set this field's value as `2` and the `type` parameter's value as `3`. \n\nFor 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.\n\n"
        },
        "monthly_week_day": {
          "enum": [
            1,
            2,
            3,
            4,
            5,
            6,
            7
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Sunday",
              "Monday",
              "Tuesday",
              "Wednesday",
              "Thursday",
              "Friday",
              "Saturday"
            ]
          },
          "description": "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. \n\n  \n `1` - Sunday.  \n `2` - Monday.  \n `3` - Tuesday.  \n `4` -  Wednesday.  \n `5` - Thursday.  \n `6` - Friday.  \n `7` - Saturday."
        }
      },
      "description": "Recurrence object. Use this object only for a meeting with type `8`, a recurring meeting with a fixed time. "
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-25T07:29:29Z",
      "description": "Meeting start time in GMT or UTC. Start time will not be returned if the meeting is an **instant** meeting. \n"
    },
    "occurrences": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "status": {
            "enum": [
              "available",
              "deleted"
            ],
            "type": "string",
            "example": "available",
            "description": "Occurrence status: \n `available` - Available occurrence.  \n `deleted` -  Deleted occurrence."
          },
          "duration": {
            "type": "integer",
            "example": 60,
            "description": "Duration."
          },
          "start_time": {
            "type": "string",
            "format": "date-time",
            "example": "2022-03-25T07:46:00Z",
            "description": "Start time."
          },
          "occurrence_id": {
            "type": "string",
            "example": "1648194360000",
            "description": "Occurrence ID: Unique Identifier that identifies an occurrence of a recurring meeting. [Recurring meetings](https://support.zoom.us/hc/en-us/articles/214973206-Scheduling-Recurring-Meetings) can have a maximum of 50 occurrences."
          }
        },
        "description": "Occurrence object. This object is only returned for recurring meetings."
      },
      "description": "Array of occurrence objects."
    },
    "assistant_id": {
      "type": "string",
      "example": "kFFvsJc-Q1OSxaJQLvaa_A",
      "description": "The ID of the user who scheduled this meeting on behalf of the host."
    },
    "pre_schedule": {
      "type": "boolean",
      "default": false,
      "example": false,
      "description": "Whether the prescheduled meeting was created 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): \n* `true` - A GSuite prescheduled meeting. \n* `false` - A regular meeting."
    },
    "chat_join_url": {
      "type": "string",
      "example": "https://example.com/launch/jc/11111",
      "description": "The URL to join the chat."
    },
    "h323_password": {
      "type": "string",
      "example": "123456",
      "description": "H.323/SIP room system passcode."
    },
    "tracking_fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "example": "field1",
            "description": "The tracking field's label."
          },
          "value": {
            "type": "string",
            "example": "value1",
            "description": "The tracking field's value."
          },
          "visible": {
            "type": "boolean",
            "example": true,
            "description": "Indicates whether the [tracking field](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) is visible in the meeting scheduling options in the Zoom Web Portal or not.\n\n`true`: Tracking field is visible.   \n \n\n`false`: Tracking field is not visible to the users when they look at the meeting details in the Zoom Web Portal but the field was used while scheduling this meeting via API. An invisible tracking field can be used by users while scheduling meetings via API only. "
          }
        }
      },
      "description": "Tracking fields."
    },
    "encrypted_password": {
      "type": "string",
      "example": "8pEkRweVXPV3Ob2KJYgFTRlDtl1gSn.1",
      "description": "Encrypted passcode for third party endpoints (H323/SIP)."
    }
  },
  "description": "Meeting object."
}

object MeetingsGetInvitationNoteResponse

{
  "type": "object",
  "title": "Meeting Invitation",
  "properties": {
    "sip_links": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "5550100@zoomcrc.com"
      },
      "description": "A list of SIP phone addresses."
    },
    "invitation": {
      "type": "string",
      "example": "Jill Chill is inviting you to a scheduled Zoom meeting.\r\n\r\nTopic: My Meeting\r\nTime: Mar 25, 2022 03:32 PM America, Los_Angeles\r\n\r\nJoin Zoom Meeting\r\nhttps://zoom.us/j/55544443210?pwd=8pEkRweVXPV3Ob2KJYgFTRlDtl1gSn.1\r\n\r\nMeeting ID: 555 4444 3210\r\nPasscode: 123456\r\nOne tap mobile\r\n+5678901234,,55544443210#,,,,*123456# US (gg)\r\n\r\nDial by your location\r\n+1 15550100 US (gg)\r\nMeeting ID: 555 4444 3210\r\nPasscode: 123456\r\nFind your local number: https://zoom.us/u/ab12cdef34jh\r\n\r\nJoin by SIP\r\n5550100@zoomcrc.com\r\n\r\nJoin by H.323\r\n192.0.2.1 (US West)\r\nMeeting ID: 555 4444 3210\r\nPasscode: 123456\r\n\r\n",
      "description": "Meeting invitation."
    }
  },
  "description": "Meeting invitation details."
}

object MeetingsGetJoinTokenLocalRecordingResponse

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "example": "2njt50mj",
      "description": "The join token."
    },
    "expire_in": {
      "enum": [
        120
      ],
      "type": "integer",
      "format": "int64",
      "example": 120,
      "description": "The number of seconds the join token is valid for before it expires. This value always returns `120`."
    }
  },
  "description": "Information about the meeting's local recorder join token."
}

object MeetingsGetJoinTokenResponse

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "example": "2njt50mj",
      "description": "The join token."
    },
    "expire_in": {
      "enum": [
        120
      ],
      "type": "integer",
      "format": "int64",
      "example": 120,
      "description": "The number of seconds the join token is valid for before it expires. This value always returns `120`."
    }
  },
  "description": "Information about the meeting's join token."
}

object MeetingsGetLivestreamDetailsResponse

{
  "type": "object",
  "properties": {
    "page_url": {
      "type": "string",
      "example": "https://example.com/livestream/123",
      "description": "Live streaming page URL. This is the URL using which anyone can view the livestream of the meeting."
    },
    "resolution": {
      "type": "string",
      "example": "720p",
      "description": "The number of pixels in each dimension that the video camera can display."
    },
    "stream_key": {
      "type": "string",
      "example": "contact-ic@example.com",
      "description": "Stream Key."
    },
    "stream_url": {
      "type": "string",
      "example": "https://example.com/livestream",
      "description": "Stream URL."
    }
  }
}

object MeetingsGetMeetingArchiveTokenForLocalArchivingResponse

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "example": "2njt50mj",
      "description": "The archive token."
    },
    "expire_in": {
      "enum": [
        120
      ],
      "type": "integer",
      "format": "int64",
      "example": 120,
      "description": "The number of seconds the archive token is valid for before it expires. This value always returns `120`."
    }
  },
  "description": "Information about the meeting's local archive token."
}

object MeetingsGetMeetingSummaryResponse

{
  "type": "object",
  "properties": {
    "meeting_id": {
      "type": "integer",
      "format": "int64",
      "example": 97763643886,
      "description": "[The meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-) \nThe meeting's unique identifier in **long** format, represented as int64 data type in JSON. Also known as the meeting number."
    },
    "next_steps": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "step1",
        "description": "The next step."
      },
      "description": "The next steps."
    },
    "meeting_uuid": {
      "type": "string",
      "example": "aDYlohsHRtCd4ii1uC2+hA==",
      "description": "The unique meeting ID. \n\nEach meeting instance generates its own meeting UUID. After a meeting ends, a new UUID is generated for the next instance of the meeting.\n\n Use the [**List past meeting instances**](https://developers.zoom.us) API to retrieve a list of UUIDs from past meeting instances. [Double encode](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#meeting-id-and-uuid) your UUID when using it for API calls if the UUID begins with a `/` or contains `//` in it.\n"
    },
    "meeting_topic": {
      "type": "string",
      "example": "My Meeting",
      "description": "The meeting topic."
    },
    "summary_title": {
      "type": "string",
      "example": "Meeting summary for my meeting",
      "description": "The summary title."
    },
    "edited_summary": {
      "type": "object",
      "properties": {
        "next_steps": {
          "type": "array",
          "items": {
            "type": "string",
            "example": "step1",
            "description": "The user edited next step."
          },
          "description": "The user edited next steps."
        },
        "summary_details": {
          "type": "string",
          "example": "Meeting overview",
          "description": "The user edited summary details."
        }
      }
    },
    "meeting_host_id": {
      "type": "string",
      "example": "30R7kT7bTIKSNUFEuH_Qlg",
      "description": "The ID of the user who is set as the meeting host."
    },
    "summary_details": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string",
            "example": "Meeting overview",
            "description": "The summary label."
          },
          "summary": {
            "type": "string",
            "example": "Meeting overview",
            "description": "The summary content."
          }
        },
        "description": "The summary detail object."
      },
      "description": "The summary content details."
    },
    "meeting_end_time": {
      "type": "string",
      "format": "date-time",
      "example": "2020-07-15T23:30:19Z",
      "description": "The meeting's end date and time."
    },
    "summary_end_time": {
      "type": "string",
      "format": "date-time",
      "example": "2020-07-15T23:30:19Z",
      "description": "The summary's end date and time."
    },
    "summary_overview": {
      "type": "string",
      "example": "Meeting overview",
      "description": "The summary overview."
    },
    "meeting_host_email": {
      "type": "string",
      "format": "email",
      "example": "jchill@example.com",
      "description": "The meeting host's email address."
    },
    "meeting_start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2019-07-15T23:24:52Z",
      "description": "The meeting's start date and time."
    },
    "summary_start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2019-07-15T23:24:52Z",
      "description": "The summary's start date and time."
    },
    "summary_created_time": {
      "type": "string",
      "format": "date-time",
      "example": "2019-07-15T23:24:52Z",
      "description": "The date and time when the meeting summary was created."
    },
    "summary_last_modified_time": {
      "type": "string",
      "format": "date-time",
      "example": "2020-07-15T23:30:19Z",
      "description": "The date and time when the meeting summary was last modified."
    }
  }
}

object MeetingsGetMeetingSurveyResponse

{
  "type": "object",
  "title": "Meeting Survey Object",
  "properties": {
    "custom_survey": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "example": "Learn something new",
          "maxLength": 64,
          "description": "The survey's title, up to 64 characters."
        },
        "feedback": {
          "type": "string",
          "example": "Thank you so much for taking the time to complete the survey. Your feedback really makes a difference.",
          "maxLength": 320,
          "description": "The survey's feedback, up to 320 characters. \n\n This value defaults to `Thank you so much for taking the time to complete the survey. Your feedback really makes a difference.`."
        },
        "anonymous": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Allow participants to anonymously answer survey questions. \n\n This value defaults to `true`."
        },
        "questions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "example": "How useful was this meeting?",
                "description": "The survey question, up to 420 characters."
              },
              "type": {
                "enum": [
                  "single",
                  "multiple",
                  "matching",
                  "rank_order",
                  "short_answer",
                  "long_answer",
                  "fill_in_the_blank",
                  "rating_scale"
                ],
                "type": "string",
                "example": "single",
                "extensions": {
                  "x-enum-descriptions": [
                    "Single choice",
                    "Multiple choice",
                    "Matching",
                    "Rank order",
                    "Short answer",
                    "Long answer",
                    "Fill in the blank",
                    "Rating scale"
                  ]
                },
                "description": "The survey's question and answer type. \n* `single` - Single choice. \n* `multiple` - Multiple choice. \n* `matching` - Matching. \n* `rank_order` - Rank order \n* `short_answer` - Short answer \n* `long_answer` - Long answer. \n* `fill_in_the_blank` - Fill in the blank \n* `rating_scale` - Rating scale."
              },
              "answers": {
                "type": "array",
                "items": {
                  "type": "string",
                  "example": "Extremely useful",
                  "maxLength": 200
                },
                "minItems": 2,
                "description": "The survey question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` questions, you can only provide a maximum of 50 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers."
              },
              "prompts": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "prompt_question": {
                      "type": "string",
                      "example": "How are you?",
                      "maxLength": 200,
                      "description": "The question prompt's title."
                    }
                  }
                },
                "maxItems": 10,
                "minItems": 2,
                "description": "Information about the prompt questions. This field only applies to `matching` and `rank_order` questions. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts."
              },
              "answer_required": {
                "type": "boolean",
                "default": false,
                "example": false,
                "description": "Whether participants must answer the question. \n* `true` - The participant must answer the question. \n* `false` - The participant does not need to answer the question. \n\n This value defaults to `false`."
              },
              "rating_max_label": {
                "type": "string",
                "example": "Extremely Likely",
                "maxLength": 50,
                "description": "The high score label used for the `rating_max_value` field, up to 50 characters. \n\n This field only applies to the `rating_scale` survey."
              },
              "rating_max_value": {
                "type": "integer",
                "example": 4,
                "maximum": 10,
                "description": "The rating scale's maximum value, up to a maximum value of 10. \n\n This field only applies to the `rating_scale` survey."
              },
              "rating_min_label": {
                "type": "string",
                "example": "Not likely",
                "maxLength": 50,
                "description": "The low score label used for the `rating_min_value` field, up to 50 characters. \n\n This field only applies to the `rating_scale` survey."
              },
              "rating_min_value": {
                "type": "integer",
                "example": 1,
                "minimum": 0,
                "description": "The rating scale's minimum value. This value cannot be less than zero. \n\n This field only applies to the `rating_scale` survey."
              },
              "show_as_dropdown": {
                "type": "boolean",
                "default": false,
                "example": false,
                "description": "Whether to display the radio selection as a drop-down box. \n* `true` - Show as a drop-down box. \n* `false` - Do not show as a drop-down box. \n\n This value defaults to `false`."
              },
              "answer_max_character": {
                "type": "integer",
                "example": 200,
                "description": "The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` questions. \n* For `short_answer` question, a maximum of 500 characters. \n* For `long_answer` question, a maximum of 2,000 characters."
              },
              "answer_min_character": {
                "type": "integer",
                "example": 1,
                "minimum": 1,
                "description": "The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` questions. You must provide at least a **one** character minimum value."
              }
            }
          },
          "maxItems": 100,
          "minItems": 1,
          "description": "Information about the meeting survey's questions."
        },
        "numbered_questions": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to display the number in the question name. \n\n This value defaults to `true`."
        },
        "show_question_type": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to display the question type in the question name. \n\n This value defaults to `false`."
        }
      },
      "description": "Information about the customized meeting survey."
    },
    "third_party_survey": {
      "type": "string",
      "example": "https://example.com",
      "maxLength": 64,
      "description": "The link to the third party meeting survey."
    },
    "show_in_the_browser": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Whether the **Show in the browser when the meeting ends** option is enabled. \n* `true` - Enabled. \n* `false` - Disabled. \n\n This value defaults to `true`."
    }
  },
  "description": "Information about the meeting survey."
}

object MeetingsGetMeetingTokenResponse

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "example": "https://example.com/closedcaption?id=200610693&ns=GZHkEA==&expire=86400&spparams=id%2Cns%2Cexpire&signature=nYtXJqRKCW",
      "description": "The generated meeting token."
    }
  },
  "description": "Information about the meeting token."
}

object MeetingsGetPastMeetingParticipantsResponse

{
  "type": "object",
  "properties": {
    "page_size": {
      "type": "integer",
      "default": 30,
      "example": 30,
      "maximum": 300,
      "description": "The number of records returned within a single API call."
    },
    "page_count": {
      "type": "integer",
      "example": 1,
      "description": "The number of pages returned for the request made."
    },
    "participants": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "30R7kT7bTIKSNUFEuH_Qlg",
            "description": "Universally unique identifier of the Participant. It is the same as the User ID of the participant if the participant joins the meeting by logging into Zoom. If the participant joins the meeting without logging in, the value of this field will be blank."
          },
          "name": {
            "type": "string",
            "example": "Jill Chill",
            "description": "Participant display name."
          },
          "status": {
            "enum": [
              "in_meeting",
              "in_waiting_room"
            ],
            "type": "string",
            "example": "in_meeting",
            "description": "The participant's status. \n* `in_meeting` - In a meeting. \n* `in_waiting_room` - In a waiting room."
          },
          "user_id": {
            "type": "string",
            "example": "27423744",
            "description": "Participant ID. This is a unique ID assigned to the participant joining a meeting and is valid for that meeting only."
          },
          "duration": {
            "type": "integer",
            "example": 259,
            "description": "Participant duration, in seconds, calculated by subtracting the `leave_time` from the `join_time` for the `user_id`. If the participant leaves and rejoins the same meeting, they will be assigned a different `user_id` and Zoom displays their new duration in a separate object. Note that because of this, the duration may not reflect the total time the user was in the meeting."
          },
          "failover": {
            "type": "boolean",
            "example": false,
            "description": "Indicates if failover happened during the meeting."
          },
          "join_time": {
            "type": "string",
            "format": "date-time",
            "example": "2022-03-23T06:58:09Z",
            "description": "Participant join time."
          },
          "leave_time": {
            "type": "string",
            "format": "date-time",
            "example": "2022-03-23T07:02:28Z",
            "description": "Participant leave time."
          },
          "user_email": {
            "type": "string",
            "example": "jchill@example.com",
            "description": "Email address of the user. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details."
          },
          "registrant_id": {
            "type": "string",
            "example": "_f08HhPJS82MIVLuuFaJPg",
            "description": "The participant's unique registrant ID. This field only returns if you pass the `registrant_id` value for the `include_fields` query parameter. \n\nThis field does not return if the `type` query parameter is the `live` value."
          }
        }
      },
      "description": "Array of meeting participant objects."
    },
    "total_records": {
      "type": "integer",
      "example": 1,
      "description": "The number of all records available across pages."
    },
    "next_page_token": {
      "type": "string",
      "example": "Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3",
      "description": "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."
    }
  },
  "description": "Pagination object."
}

object MeetingsGetPollResponse

{
  "type": "object",
  "title": "Meeting and Webinar Polling Object",
  "properties": {
    "id": {
      "type": "string",
      "example": "QalIoKWLTJehBJ8e1xRrbQ",
      "description": "Meeting Poll ID"
    },
    "title": {
      "type": "string",
      "example": "Learn something new",
      "maxLength": 64,
      "description": "The poll's title, up to 64 characters."
    },
    "status": {
      "enum": [
        "notstart",
        "started",
        "ended",
        "sharing"
      ],
      "type": "string",
      "example": "notstart",
      "extensions": {
        "x-enum-descriptions": [
          "Poll not start",
          "Poll started",
          "Poll ended",
          "Poll is sharing"
        ]
      },
      "description": "Status of the Meeting Poll:  \n `notstart` - Poll not started  \n `started` - Poll started  \n `ended` - Poll ended  \n `sharing` - Sharing poll results"
    },
    "anonymous": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Allow meeting participants to answer poll questions anonymously. \n\nThis value defaults to `false`."
    },
    "poll_type": {
      "enum": [
        1,
        2,
        3
      ],
      "type": "integer",
      "example": 2,
      "description": "The type of poll: \n* `1` &mdash; Poll. \n* `2` &mdash; Advanced Poll. This feature must be enabled in your Zoom account. \n* `3` &mdash; Quiz. This feature must be enabled in your Zoom account. \n\n This value defaults to `1`."
    },
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "How useful was this meeting?",
            "maxLength": 255,
            "description": "The poll question, up to 255 characters. \n\nFor `fill_in_the_blank` polls, this field is the poll's question. For each value that the user must fill in, ensure that there are the same number of `right_answers` values."
          },
          "type": {
            "enum": [
              "single",
              "multiple",
              "matching",
              "rank_order",
              "short_answer",
              "long_answer",
              "fill_in_the_blank",
              "rating_scale"
            ],
            "type": "string",
            "example": "single",
            "extensions": {
              "x-enum-descriptions": [
                "Single choice",
                "Multiple choice",
                "Matching",
                "Rank order",
                "Short answer",
                "Long answer",
                "Fill in the blank",
                "Rating scale"
              ]
            },
            "description": "The poll's question and answer type: \n* `single` &mdash; Single choice. \n* `multiple` &mdash; Multiple choice. \n* `matching` &mdash; Matching. \n* `rank_order` &mdash; Rank order. \n* `short_answer` &mdash; Short answer. \n* `long_answer` &mdash; Long answer. \n* `fill_in_the_blank` &mdash; Fill in the blank. \n* `rating_scale` &mdash; Rating scale."
          },
          "answers": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "Extremely useful"
            },
            "minItems": 2,
            "description": "The poll question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` polls, you can only provide a maximum of 10 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers."
          },
          "prompts": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "prompt_question": {
                  "type": "string",
                  "example": "How are you?",
                  "description": "The question prompt's title."
                },
                "prompt_right_answers": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "Good"
                  },
                  "description": "The question prompt's correct answers: \n* For `matching` polls, you must provide a minimum of two correct answers, up to a maximum of 10 correct answers. \n* For `rank_order` polls, you can only provide one correct answer."
                }
              }
            },
            "description": "Information about the prompt questions. This field only applies to `matching` and `rank_order` polls. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts."
          },
          "right_answers": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "Good"
            },
            "minItems": 1,
            "description": "The poll question's correct answer(s). This field is **required** if the poll's `type` value is `3` (Quiz). \n\n For `single` and `matching` polls, this field only accepts one answer."
          },
          "case_sensitive": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether the correct answer is case sensitive. This field only applies to `fill_in_the_blank` polls: \n* `true` &mdash; The answer is case-sensitive. \n* `false` &mdash; The answer is not case-sensitive. \n\nThis value defaults to `false`."
          },
          "answer_required": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether participants must answer the question: \n* `true` &mdash; The participant must answer the question. \n* `false` &mdash; The participant does not need to answer the question. \n\n**Note:** \n* When the poll's `type` value is `1` (Poll), this value defaults to `true`. \n* When the poll's `type` value is the `2` (Advanced Poll) or `3` (Quiz) values, this value defaults to `false`."
          },
          "rating_max_label": {
            "type": "string",
            "example": "Extremely Likely",
            "description": "The high score label used for the `rating_max_value` field. \n\nThis field only applies to the `rating_scale` poll."
          },
          "rating_max_value": {
            "type": "integer",
            "example": 4,
            "maximum": 10,
            "description": "The rating scale's maximum value, up to a maximum value of 10. \n\nThis field only applies to the `rating_scale` poll."
          },
          "rating_min_label": {
            "type": "string",
            "example": "Not likely",
            "description": "The low score label used for the `rating_min_value` field. \n\nThis field only applies to the `rating_scale` poll."
          },
          "rating_min_value": {
            "type": "integer",
            "example": 0,
            "minimum": 0,
            "description": "The rating scale's minimum value. This value cannot be less than zero. \n\nThis field only applies to the `rating_scale` poll."
          },
          "show_as_dropdown": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether to display the radio selection as a drop-down box: \n* `true` &mdash; Show as a drop-down box. \n* `false` &mdash; Do not show as a drop-down box. \n\nThis value defaults to `false`."
          },
          "answer_max_character": {
            "type": "integer",
            "example": 200,
            "description": "The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` polls: \n* For `short_answer` polls, a maximum of 500 characters. \n* For `long_answer` polls, a maximum of 2,000 characters."
          },
          "answer_min_character": {
            "type": "integer",
            "example": 1,
            "minimum": 1,
            "description": "The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` polls. You must provide at least a **one** character minimum value."
          }
        }
      },
      "description": "Information about the poll's questions."
    }
  },
  "description": "Information about meeting and webinar polling."
}

object MeetingsGetRegistrantDetailsResponse

{
  "type": "object",
  "title": "Meeting Registrant",
  "required": [
    "email",
    "first_name"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "9tboDiHUQAeOnbmudzWa5g"
    },
    "org": {
      "type": "string",
      "example": "Cooking Org",
      "description": "The registrant's organization."
    },
    "zip": {
      "type": "string",
      "example": "94045",
      "description": "The registrant's ZIP or postal code."
    },
    "city": {
      "type": "string",
      "example": "Mountain View",
      "description": "The registrant's city."
    },
    "email": {
      "type": "string",
      "format": "email",
      "example": "jchill@example.com",
      "maxLength": 128,
      "description": "The registrant's email address. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for return value details."
    },
    "phone": {
      "type": "string",
      "example": "5550100",
      "description": "The registrant's phone number."
    },
    "state": {
      "type": "string",
      "example": "CA",
      "description": "The registrant's state or province."
    },
    "status": {
      "enum": [
        "approved",
        "denied",
        "pending"
      ],
      "type": "string",
      "example": "approved",
      "description": "The registrant's registration status.\n* `approved` - The registrant is approved to join the meeting. \n* `pending` - The registrant's registration is pending.\n* `denied` - The registrant was declined to join the meeting."
    },
    "address": {
      "type": "string",
      "example": "1800 Amphibious Blvd.",
      "description": "The registrant's address."
    },
    "country": {
      "type": "string",
      "example": "US",
      "description": "The registrant's two-letter [country code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries)."
    },
    "comments": {
      "type": "string",
      "example": "Looking forward to the discussion.",
      "description": "The registrant's questions and comments."
    },
    "industry": {
      "type": "string",
      "example": "Food",
      "description": "The registrant's industry."
    },
    "join_url": {
      "type": "string",
      "format": "url",
      "example": "https://example.com/j/11111",
      "description": "The URL with which the approved registrant can join the meeting."
    },
    "job_title": {
      "type": "string",
      "example": "Chef",
      "description": "The registrant's job title."
    },
    "last_name": {
      "type": "string",
      "example": "Chill",
      "maxLength": 64,
      "description": "The registrant's last name."
    },
    "first_name": {
      "type": "string",
      "example": "Jill",
      "maxLength": 64,
      "description": "The registrant's first name."
    },
    "create_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-22T05:58:44Z",
      "description": "The registrant's registration date and time."
    },
    "no_of_employees": {
      "enum": [
        "",
        "1-20",
        "21-50",
        "51-100",
        "101-250",
        "251-500",
        "501-1,000",
        "1,001-5,000",
        "5,001-10,000",
        "More than 10,000"
      ],
      "type": "string",
      "example": "1-20",
      "description": "The registrant's number of employees. \n* `1-20` \n* `21-50` \n* `51-100` \n* `101-250` \n* `251-500` \n* `501-1,000` \n* `1,001-5,000` \n* `5,001-10,000` \n* `More than 10,000`"
    },
    "custom_questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "example": "What do you hope to learn from this?",
            "description": "The title of the custom question."
          },
          "value": {
            "type": "string",
            "example": "Look forward to learning how you come up with new recipes and what other services you offer.",
            "maxLength": 128,
            "description": "The custom question's response value. This has a limit of 128 characters."
          }
        },
        "description": "Information about custom questions."
      },
      "description": "Information about custom questions."
    },
    "participant_pin_code": {
      "type": "integer",
      "format": "int64",
      "example": 380303,
      "description": "The participant PIN code is used to authenticate audio participants before they join the meeting."
    },
    "purchasing_time_frame": {
      "enum": [
        "",
        "Within a month",
        "1-3 months",
        "4-6 months",
        "More than 6 months",
        "No timeframe"
      ],
      "type": "string",
      "example": "1-3 months",
      "description": "The registrant's purchasing time frame. \n* `Within a month` \n* `1-3 months` \n* `4-6 months` \n* `More than 6 months` \n* `No timeframe`"
    },
    "role_in_purchase_process": {
      "enum": [
        "",
        "Decision Maker",
        "Evaluator/Recommender",
        "Influencer",
        "Not involved"
      ],
      "type": "string",
      "example": "Influencer",
      "description": "The registrant's role in the purchase process. \n* `Decision Maker` \n* `Evaluator/Recommender` \n* `Influencer` \n* `Not involved`"
    }
  },
  "description": " Registrant."
}

object MeetingsGetSipUriWithPasscodeRequest

{
  "type": "object",
  "properties": {
    "passcode": {
      "type": "string",
      "example": "xxxx",
      "description": "If customers desire that a passcode be embedded in the SIP URI dial string, they must supply the passcode. Zoom will not validate the passcode."
    }
  }
}

object MeetingsGetSipUriWithPasscodeResponse

{
  "type": "object",
  "properties": {
    "expire_in": {
      "type": "integer",
      "format": "int64",
      "example": 7200,
      "description": "The number of seconds the encoded SIP URI is valid before it expires."
    },
    "sip_dialing": {
      "type": "string",
      "example": "9678722567.xxxx....30qonrvgy@zoomcrc.com",
      "description": "The meeting's encoded SIP URI."
    },
    "paid_crc_plan_participant": {
      "type": "boolean",
      "example": true,
      "description": "Whether the API caller has a CRC (Conference Room Connector) plan."
    },
    "participant_identifier_code": {
      "type": "string",
      "example": "30qonrvgy",
      "description": "This value identifies the meeting participant. It is automatically embedded in the SIP URI if the API caller has a CRC (Conference Room Connector) plan."
    }
  },
  "description": "Information about the meeting's encoded SIP URI."
}

object MeetingsListHostScheduledResponse

{
  "type": "object",
  "properties": {
    "meetings": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64",
            "example": 97763643886,
            "description": "Meeting ID - also known as the meeting number in long (int64) format."
          },
          "pmi": {
            "type": "string",
            "example": "97891943927",
            "description": "[Personal meeting ID](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#understanding-personal-meeting-id-pmi). This field is only returned if PMI was used to schedule the meeting."
          },
          "type": {
            "enum": [
              1,
              2,
              3,
              8
            ],
            "type": "integer",
            "example": 2,
            "extensions": {
              "x-enum-descriptions": [
                "Instant Meeting",
                "Scheduled Meeting",
                "Recurring Meeting with no fixed time",
                "Recurring Meeting with fixed time"
              ]
            },
            "description": "Meeting types.  \n `1` - Instant meeting.  \n `2` - Scheduled meeting.  \n `3` - Recurring meeting with no fixed time.  \n `8` - Recurring meeting with fixed time."
          },
          "uuid": {
            "type": "string",
            "example": "aDYlohsHRtCd4ii1uC2+hA==",
            "description": "Unique Meeting ID. Each meeting instance will generate its own Meeting UUID."
          },
          "topic": {
            "type": "string",
            "example": "My Meeting",
            "description": "Meeting topic."
          },
          "agenda": {
            "type": "string",
            "example": "My Meeting",
            "description": "Meeting description. The length of agenda gets truncated to 250 characters when you list all of a user's meetings. To view a meeting's complete agenda, or to retrieve details for a single meeting, use the [**Get a meeting**](https://developers.zoom.us) API."
          },
          "host_id": {
            "type": "string",
            "example": "30R7kT7bTIKSNUFEuH_Qlg",
            "description": "ID of the user who is set as the meeting's host."
          },
          "duration": {
            "type": "integer",
            "example": 60,
            "description": "Meeting duration."
          },
          "join_url": {
            "type": "string",
            "example": "https://example.com/j/11111",
            "description": "URL using which participants can join a meeting."
          },
          "timezone": {
            "type": "string",
            "example": "America/Los_Angeles",
            "description": "Timezone to format the meeting start time. "
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "example": "2022-03-23T05:31:16Z",
            "description": "Time of creation."
          },
          "start_time": {
            "type": "string",
            "format": "date-time",
            "example": "2022-03-23T06:00:00Z",
            "description": "Meeting start time."
          }
        }
      },
      "description": "List of meeting objects."
    },
    "page_size": {
      "type": "integer",
      "default": 30,
      "example": 30,
      "maximum": 300,
      "description": "The number of records returned with a single API call."
    },
    "page_count": {
      "type": "integer",
      "example": 1,
      "description": "The number of pages returned for the request made."
    },
    "page_number": {
      "type": "integer",
      "default": 1,
      "example": 1,
      "description": "The page number of the current results."
    },
    "total_records": {
      "type": "integer",
      "example": 1,
      "description": "The total number of all the records available across pages."
    },
    "next_page_token": {
      "type": "string",
      "example": "Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3",
      "description": "Use the next page token to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes."
    }
  },
  "description": "Pagination object."
}

object MeetingsListMeetingPollsResponse

{
  "type": "object",
  "title": "Poll List",
  "properties": {
    "polls": {
      "type": "array",
      "items": {
        "type": "object",
        "title": "Meeting and Webinar Polling Object",
        "properties": {
          "id": {
            "type": "string",
            "example": "QalIoKWLTJehBJ8e1xRrbQ",
            "description": "ID of Poll"
          },
          "title": {
            "type": "string",
            "example": "Learn something new",
            "maxLength": 64,
            "description": "The poll's title, up to 64 characters."
          },
          "status": {
            "enum": [
              "notstart",
              "started",
              "ended",
              "sharing"
            ],
            "type": "string",
            "example": "notstart",
            "extensions": {
              "x-enum-descriptions": [
                "Poll not start",
                "Poll started",
                "Poll ended",
                "Poll is sharing"
              ]
            },
            "description": "Status of Poll:  \n `notstart` - Poll not started  \n `started` - Poll started  \n `ended` - Poll ended  \n `sharing` - Sharing poll results"
          },
          "anonymous": {
            "type": "boolean",
            "default": false,
            "example": true,
            "description": "Allow meeting participants to answer poll questions anonymously. \n\nThis value defaults to `false`."
          },
          "poll_type": {
            "enum": [
              1,
              2,
              3
            ],
            "type": "integer",
            "example": 2,
            "description": "The type of poll: \n* `1` &mdash; Poll. \n* `2` &mdash; Advanced Poll. This feature must be enabled in your Zoom account. \n* `3` &mdash; Quiz. This feature must be enabled in your Zoom account. \n\n This value defaults to `1`."
          },
          "questions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "example": "How useful was this meeting?",
                  "maxLength": 255,
                  "description": "The poll question, up to 255 characters. \n\nFor `fill_in_the_blank` polls, this field is the poll's question. For each value that the user must fill in, ensure that there are the same number of `right_answers` values."
                },
                "type": {
                  "enum": [
                    "single",
                    "multiple",
                    "matching",
                    "rank_order",
                    "short_answer",
                    "long_answer",
                    "fill_in_the_blank",
                    "rating_scale"
                  ],
                  "type": "string",
                  "example": "single",
                  "extensions": {
                    "x-enum-descriptions": [
                      "Single choice",
                      "Multiple choice",
                      "Matching",
                      "Rank order",
                      "Short answer",
                      "Long answer",
                      "Fill in the blank",
                      "Rating scale"
                    ]
                  },
                  "description": "The poll's question and answer type: \n* `single` &mdash; Single choice. \n* `multiple` &mdash; Multiple choice. \n* `matching` &mdash; Matching. \n* `rank_order` &mdash; Rank order. \n* `short_answer` &mdash; Short answer. \n* `long_answer` &mdash; Long answer. \n* `fill_in_the_blank` &mdash; Fill in the blank. \n* `rating_scale` &mdash; Rating scale."
                },
                "answers": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "Extremely useful"
                  },
                  "minItems": 2,
                  "description": "The poll question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` polls, you can only provide a maximum of 10 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers."
                },
                "prompts": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "prompt_question": {
                        "type": "string",
                        "example": "How are you?",
                        "description": "The question prompt's title."
                      },
                      "prompt_right_answers": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "example": "Good"
                        },
                        "description": "The question prompt's correct answers: \n* For `matching` polls, you must provide a minimum of two correct answers, up to a maximum of 10 correct answers. \n* For `rank_order` polls, you can only provide one correct answer."
                      }
                    }
                  },
                  "description": "Information about the prompt questions. This field only applies to `matching` and `rank_order` polls. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts."
                },
                "right_answers": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "Good"
                  },
                  "minItems": 1,
                  "description": "The poll question's correct answer(s). This field is **required** if the poll's `type` value is `3` (Quiz). \n\n For `single` and `matching` polls, this field only accepts one answer."
                },
                "case_sensitive": {
                  "type": "boolean",
                  "default": false,
                  "example": false,
                  "description": "Whether the correct answer is case sensitive. This field only applies to `fill_in_the_blank` polls: \n* `true` &mdash; The answer is case-sensitive. \n* `false` &mdash; The answer is not case-sensitive. \n\nThis value defaults to `false`."
                },
                "answer_required": {
                  "type": "boolean",
                  "default": false,
                  "example": false,
                  "description": "Whether participants must answer the question: \n* `true` &mdash; The participant must answer the question. \n* `false` &mdash; The participant does not need to answer the question. \n\n**Note:** \n* When the poll's `type` value is `1` (Poll), this value defaults to `true`. \n* When the poll's `type` value is the `2` (Advanced Poll) or `3` (Quiz) values, this value defaults to `false`."
                },
                "rating_max_label": {
                  "type": "string",
                  "example": "Extremely Likely",
                  "description": "The high score label used for the `rating_max_value` field. \n\nThis field only applies to the `rating_scale` poll."
                },
                "rating_max_value": {
                  "type": "integer",
                  "example": 4,
                  "maximum": 10,
                  "description": "The rating scale's maximum value, up to a maximum value of 10. \n\nThis field only applies to the `rating_scale` poll."
                },
                "rating_min_label": {
                  "type": "string",
                  "example": "Not likely",
                  "description": "The low score label used for the `rating_min_value` field. \n\nThis field only applies to the `rating_scale` poll."
                },
                "rating_min_value": {
                  "type": "integer",
                  "example": 0,
                  "minimum": 0,
                  "description": "The rating scale's minimum value. This value cannot be less than zero. \n\nThis field only applies to the `rating_scale` poll."
                },
                "show_as_dropdown": {
                  "type": "boolean",
                  "default": false,
                  "example": false,
                  "description": "Whether to display the radio selection as a drop-down box: \n* `true` &mdash; Show as a drop-down box. \n* `false` &mdash; Do not show as a drop-down box. \n\nThis value defaults to `false`."
                },
                "answer_max_character": {
                  "type": "integer",
                  "example": 200,
                  "description": "The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` polls: \n* For `short_answer` polls, a maximum of 500 characters. \n* For `long_answer` polls, a maximum of 2,000 characters."
                },
                "answer_min_character": {
                  "type": "integer",
                  "example": 1,
                  "minimum": 1,
                  "description": "The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` polls. You must provide at least a **one** character minimum value."
                }
              }
            },
            "description": "Information about the poll's questions."
          }
        },
        "description": "Information about meeting and webinar polling."
      },
      "description": "Array of Polls"
    },
    "total_records": {
      "type": "integer",
      "example": 1,
      "description": "The number of all records available across pages"
    }
  },
  "description": "Poll List"
}

object MeetingsListMeetingSummariesResponse

{
  "type": "object",
  "properties": {
    "to": {
      "type": "string",
      "format": "date-time",
      "example": "2023-10-20T07:00:00Z",
      "description": "The end date in `yyyy-MM-dd'T'HH:mm:ss'Z'` UTC format used to retrieve the creation date range of the meeting summaries."
    },
    "from": {
      "type": "string",
      "format": "date-time",
      "example": "2023-10-19T07:00:00Z",
      "description": "The start date in `yyyy-MM-dd'T'HH:mm:ss'Z'` UTC format used to retrieve the creation date range of the meeting summaries."
    },
    "page_size": {
      "type": "integer",
      "default": 30,
      "example": 30,
      "maximum": 300,
      "description": "The number of records returned with a single API call."
    },
    "summaries": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "meeting_id": {
            "type": "integer",
            "format": "int64",
            "example": 97763643886,
            "description": "[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-) - the meeting's unique identifier in **long** format, represented as int64 data type in JSON, also known as the meeting number."
          },
          "meeting_uuid": {
            "type": "string",
            "example": "aDYlohsHRtCd4ii1uC2+hA==",
            "description": "Unique meeting ID. Each meeting instance generates its own meeting UUID - after a meeting ends, a new UUID is generated for the next instance of the meeting. Retrieve a list of UUIDs from past meeting instances using the [**List past meeting instances**](https://developers.zoom.us) API. [Double encode](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#meeting-id-and-uuid) your UUID when using it for API calls if the UUID begins with a `/` or contains `//` in it.\n"
          },
          "meeting_topic": {
            "type": "string",
            "example": "My Meeting",
            "description": "Meeting topic."
          },
          "meeting_host_id": {
            "type": "string",
            "example": "30R7kT7bTIKSNUFEuH_Qlg",
            "description": "The ID of the user who is set as the meeting host."
          },
          "meeting_end_time": {
            "type": "string",
            "format": "date-time",
            "example": "2020-07-15T23:30:19Z",
            "description": "The meeting's end date and time."
          },
          "summary_end_time": {
            "type": "string",
            "format": "date-time",
            "example": "2020-07-15T23:30:19Z",
            "description": "The summary's end date and time."
          },
          "meeting_host_email": {
            "type": "string",
            "format": "email",
            "example": "jchill@example.com",
            "description": "The meeting host's email address."
          },
          "meeting_start_time": {
            "type": "string",
            "format": "date-time",
            "example": "2019-07-15T23:24:52Z",
            "description": "The meeting's start date and time."
          },
          "summary_start_time": {
            "type": "string",
            "format": "date-time",
            "example": "2019-07-15T23:24:52Z",
            "description": "The summary's start date and time."
          },
          "summary_created_time": {
            "type": "string",
            "format": "date-time",
            "example": "2019-07-15T23:24:52Z",
            "description": "The date and time at which the meeting summary was created."
          },
          "summary_last_modified_time": {
            "type": "string",
            "format": "date-time",
            "example": "2020-07-15T23:30:19Z",
            "description": "The date and time at which the meeting summary was last modified."
          }
        },
        "description": "The meeting summary object."
      },
      "description": "List of meeting summary objects."
    },
    "next_page_token": {
      "type": "string",
      "example": "Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3",
      "description": "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."
    }
  }
}

object MeetingsListMeetingTemplatesResponse

{
  "type": "object",
  "properties": {
    "templates": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "AdxbhxCzKgSiWAw",
            "description": "The template ID."
          },
          "name": {
            "type": "string",
            "example": "My meeting template",
            "description": "The template name."
          },
          "type": {
            "type": "integer",
            "example": 1,
            "description": "The template type:   \n \n`1`: Meeting template   \n \n`2`: Admin meeting template"
          }
        }
      }
    },
    "total_records": {
      "type": "integer",
      "example": 1,
      "description": "Total records found for this request."
    }
  }
}

object MeetingsListPastMeetingInstancesResponse

{
  "type": "object",
  "title": "Meeting instances",
  "properties": {
    "meetings": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string",
            "example": "Vg8IdgluR5WDeWIkpJlElQ==",
            "description": "Meeting UUID. Unique meeting ID. Each meeting instance will generate its own Meeting UUID (i.e., after a meeting ends, a new UUID will be generated for the next instance of the meeting). [Double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) your UUID when using it for API calls if the UUID begins with a '/'or contains '//' in it.\n\n"
          },
          "start_time": {
            "type": "string",
            "format": "date-time",
            "example": "2022-03-26T05:37:59Z",
            "description": "Start time"
          }
        }
      },
      "description": "List of ended meeting instances."
    }
  },
  "description": "List of Meetings"
}

object MeetingsListPastMeetingPollsResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 93398114182,
      "description": "[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-): Unique identifier of the meeting in **long** format(represented as int64 data type in JSON), also known as the meeting number."
    },
    "uuid": {
      "type": "string",
      "example": "Vg8IdgluR5WDeWIkpJlElQ==",
      "description": "Meeting UUID."
    },
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "Jill Chill",
            "description": "Name of the user who submitted answers to the poll. If `anonymous` option is enabled for a poll, the participant's polling information will be kept anonymous and the value of `name` field will be `Anonymous Attendee`."
          },
          "email": {
            "type": "string",
            "example": "jchill@example.com",
            "description": "Email address of the user who submitted answers to the poll. If the user is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details."
          },
          "question_details": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "answer": {
                  "type": "string",
                  "example": "Good",
                  "description": "Answer submitted by the user."
                },
                "question": {
                  "type": "string",
                  "example": "How are you?",
                  "description": "Question asked during the poll."
                },
                "date_time": {
                  "type": "string",
                  "format": "date-time",
                  "example": "2022-03-26T05:37:59Z",
                  "description": "Date and time at which the answer to the poll was submitted."
                },
                "polling_id": {
                  "type": "string",
                  "example": "QalIoKWLTJehBJ8e1xRrbQ",
                  "description": "Unique identifier of the poll."
                }
              }
            }
          }
        }
      }
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-26T05:37:59Z",
      "description": "The start time of the meeting."
    }
  }
}

object MeetingsListPastMeetingQaResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 95204914252,
      "description": "[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-): Unique identifier of the meeting in **long** format, represented as int64 data type in JSON, also known as the meeting number."
    },
    "uuid": {
      "type": "string",
      "example": "Bznyg8KZTdCVbQxvS/oZ7w==",
      "description": "Meeting UUID."
    },
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "Jill Chill",
            "description": "The user's name. If `anonymous` option is enabled for the Q&amp;A, the participant's information is be kept anonymous and the value of `name` field is `Anonymous Attendee`."
          },
          "email": {
            "type": "string",
            "example": "jchill@example.com",
            "description": "The user's email address. If the user is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details."
          },
          "question_details": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "answer": {
                  "type": "string",
                  "example": "Good",
                  "description": "An answer submitted for the question. The value is 'live answered' if this is a live answer."
                },
                "question": {
                  "type": "string",
                  "example": "How are you?",
                  "description": "A question asked during the Q&amp;A."
                }
              }
            }
          }
        }
      }
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-26T06:44:14Z",
      "description": "The meeting's start time."
    }
  }
}

object MeetingsListRegistrantsResponse

{
  "type": "object",
  "title": "Registration List",
  "properties": {
    "page_size": {
      "type": "integer",
      "default": 30,
      "example": 30,
      "maximum": 300,
      "description": "The number of records returned with a single API call."
    },
    "page_count": {
      "type": "integer",
      "example": 1,
      "description": "The number of pages returned for the request made."
    },
    "page_number": {
      "type": "integer",
      "default": 1,
      "example": 1,
      "deprecated": true,
      "description": "**Deprecated.** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination."
    },
    "registrants": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "email",
          "first_name"
        ],
        "properties": {
          "id": {
            "type": "string",
            "example": "9tboDiHUQAeOnbmudzWa5g",
            "description": "Registrant ID."
          },
          "org": {
            "type": "string",
            "example": "Cooking Org",
            "description": "The registrant's organization."
          },
          "zip": {
            "type": "string",
            "example": "94045",
            "description": "The registrant's ZIP or postal code."
          },
          "city": {
            "type": "string",
            "example": "Mountain View",
            "description": "The registrant's city."
          },
          "email": {
            "type": "string",
            "format": "email",
            "example": "jchill@example.com",
            "maxLength": 128,
            "description": "The registrant's email address. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for return value details."
          },
          "phone": {
            "type": "string",
            "example": "5550100",
            "description": "The registrant's phone number."
          },
          "state": {
            "type": "string",
            "example": "CA",
            "description": "The registrant's state or province."
          },
          "status": {
            "enum": [
              "approved",
              "denied",
              "pending"
            ],
            "type": "string",
            "example": "approved",
            "description": "The status of the registrant's registration.   \n  `approved`: User has been successfully approved for the webinar.  \n  `pending`:  The registration is still pending.  \n  `denied`: User has been denied from joining the webinar."
          },
          "address": {
            "type": "string",
            "example": "1800 Amphibious Blvd.",
            "description": "The registrant's address."
          },
          "country": {
            "type": "string",
            "example": "US",
            "description": "The registrant's two-letter [country code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries)."
          },
          "comments": {
            "type": "string",
            "example": "Looking forward to the discussion.",
            "description": "The registrant's questions and comments."
          },
          "industry": {
            "type": "string",
            "example": "Food",
            "description": "The registrant's industry."
          },
          "join_url": {
            "type": "string",
            "format": "string",
            "example": "https://example.com/j/11111",
            "description": "The URL using which an approved registrant can join the meeting or webinar."
          },
          "job_title": {
            "type": "string",
            "example": "Chef",
            "description": "The registrant's job title."
          },
          "last_name": {
            "type": "string",
            "example": "Chill",
            "maxLength": 64,
            "description": "The registrant's last name."
          },
          "first_name": {
            "type": "string",
            "example": "Jill",
            "maxLength": 64,
            "description": "The registrant's first name."
          },
          "create_time": {
            "type": "string",
            "format": "date-time",
            "example": "2022-03-22T05:59:09Z",
            "description": "The time at which the registrant registered."
          },
          "no_of_employees": {
            "enum": [
              "",
              "1-20",
              "21-50",
              "51-100",
              "101-250",
              "251-500",
              "501-1,000",
              "1,001-5,000",
              "5,001-10,000",
              "More than 10,000"
            ],
            "type": "string",
            "example": "1-20",
            "description": "The registrant's number of employees. \n* `1-20` \n* `21-50` \n* `51-100` \n* `101-250` \n* `251-500` \n* `501-1,000` \n* `1,001-5,000` \n* `5,001-10,000` \n* `More than 10,000`"
          },
          "custom_questions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "title": {
                  "type": "string",
                  "example": "What do you hope to learn from this?",
                  "description": "The title of the custom question."
                },
                "value": {
                  "type": "string",
                  "example": "Look forward to learning how you come up with new recipes and what other services you offer.",
                  "maxLength": 128,
                  "description": "The custom question's response value. This has a limit of 128 characters."
                }
              },
              "description": "Information about custom questions."
            },
            "description": "Information about custom questions."
          },
          "participant_pin_code": {
            "type": "integer",
            "format": "int64",
            "example": 380303,
            "description": "The participant PIN code is used to authenticate audio participants before they join the meeting."
          },
          "purchasing_time_frame": {
            "enum": [
              "",
              "Within a month",
              "1-3 months",
              "4-6 months",
              "More than 6 months",
              "No timeframe"
            ],
            "type": "string",
            "example": "1-3 months",
            "description": "The registrant's purchasing time frame. \n* `Within a month` \n* `1-3 months` \n* `4-6 months` \n* `More than 6 months` \n* `No timeframe`"
          },
          "role_in_purchase_process": {
            "enum": [
              "",
              "Decision Maker",
              "Evaluator/Recommender",
              "Influencer",
              "Not involved"
            ],
            "type": "string",
            "example": "Influencer",
            "description": "The registrant's role in the purchase process. \n* `Decision Maker` \n* `Evaluator/Recommender` \n* `Influencer` \n* `Not involved`"
          }
        },
        "description": " Registrant."
      },
      "description": "List of registrant objects."
    },
    "total_records": {
      "type": "integer",
      "example": 20,
      "description": "The total number of all the records available across pages."
    },
    "next_page_token": {
      "type": "string",
      "example": "w7587w4eiyfsudgf",
      "description": "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."
    }
  },
  "description": "List of users."
}

object MeetingsListRegistrationQuestionsResponse

{
  "type": "object",
  "title": "Meeting Registrant Questions",
  "properties": {
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "required": {
            "type": "boolean",
            "example": true,
            "description": "Indicates whether or not the displayed fields are required to be filled out by registrants."
          },
          "field_name": {
            "enum": [
              "last_name",
              "address",
              "city",
              "country",
              "zip",
              "state",
              "phone",
              "industry",
              "org",
              "job_title",
              "purchasing_time_frame",
              "role_in_purchase_process",
              "no_of_employees",
              "comments"
            ],
            "type": "string",
            "example": "last_name",
            "description": "Field name of the question."
          }
        }
      },
      "description": "Array of Registrant Questions"
    },
    "custom_questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "enum": [
              "short",
              "single"
            ],
            "type": "string",
            "example": "short",
            "extensions": {
              "x-enum-descriptions": [
                "Short Answer",
                "Single Answer"
              ]
            },
            "description": "Type of the question being asked."
          },
          "title": {
            "type": "string",
            "example": "How are you?",
            "description": "Title of the custom question."
          },
          "answers": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "Good"
            },
            "description": "Answer choices for the question. Can not be used for `short` question type as this type of question requires registrants to type out the answer."
          },
          "required": {
            "type": "boolean",
            "example": true,
            "description": "Indicates whether or not the custom question is required to be answered by participants or not."
          }
        }
      },
      "description": "Array of Registrant Custom Questions"
    }
  },
  "description": "Meeting Registrant Questions"
}

object MeetingsListUpcomingMeetingsResponse

{
  "type": "object",
  "properties": {
    "meetings": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64",
            "example": 97763643886,
            "description": "The [meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-) - a unique identifier of the meeting in **long** format, represented as int64 data type in JSON. Also known as the meeting number."
          },
          "type": {
            "enum": [
              1,
              2,
              3,
              8
            ],
            "type": "integer",
            "example": 2,
            "extensions": {
              "x-enum-descriptions": [
                "Instant Meeting",
                "Scheduled Meeting",
                "Recurring Meeting with no fixed time",
                "Recurring Meeting with fixed time"
              ]
            },
            "description": "Meeting types.\n`1` - Instant meeting.\n`2` - Scheduled meeting.\n`3` - Recurring meeting with no fixed time.\n`8` - Recurring meeting with fixed time."
          },
          "topic": {
            "type": "string",
            "example": "My Meeting",
            "description": "The meeting topic."
          },
          "duration": {
            "type": "integer",
            "example": 60,
            "description": "Meeting duration."
          },
          "join_url": {
            "type": "string",
            "example": "https://example.com/j/11111",
            "description": "The URL that participants can use to join a meeting."
          },
          "timezone": {
            "type": "string",
            "example": "America/Los_Angeles",
            "description": "The timezone to format the meeting start time."
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "example": "2022-03-23T05:31:16Z",
            "description": "The meeting creation time."
          },
          "start_time": {
            "type": "string",
            "format": "date-time",
            "example": "2022-03-23T06:00:00Z",
            "description": "The meeting's start time."
          }
        }
      },
      "description": "List of upcoming meeting objects."
    },
    "total_records": {
      "type": "integer",
      "example": 1,
      "description": "The total number of all records available across all pages."
    }
  }
}

object MeetingsLivestreamStatusUpdateRequest

{
  "type": "object",
  "properties": {
    "action": {
      "enum": [
        "start",
        "stop",
        "mode"
      ],
      "type": "string",
      "example": "start",
      "description": "The meeting's livestream status.\n* `start` - Start a livestream.\n* `stop` - Stop an ongoing livestream.\n* `mode` - Control a livestream view at runtime."
    },
    "settings": {
      "type": "object",
      "properties": {
        "layout": {
          "enum": [
            "follow_host",
            "gallery_view",
            "speaker_view"
          ],
          "type": "string",
          "default": "follow_host",
          "example": "follow_host",
          "description": "The layout of the meeting's livestream. Use this field if you pass the `start` or `mode` value for the `action` field.\r\n* `follow_host` - Follow host view.\r\n* `gallery_view` - Gallery view.\r\n* `speaker_view` - Speaker view."
        },
        "display_name": {
          "type": "string",
          "example": "Jill Chill",
          "maxLength": 50,
          "minLength": 1,
          "description": "The display name of the meeting's livestream. Use this field if you pass the `start` value for the `action` field."
        },
        "close_caption": {
          "enum": [
            "burnt-in",
            "embedded",
            "off"
          ],
          "type": "string",
          "default": "burnt-in",
          "example": "burnt-in",
          "description": "The livestream's closed caption type for this session. Use this field if you pass the `start` or `mode` value for the `action` field.\r\n* `burnt-in` - Burnt in captions.\r\n* `embedded` - Embedded captions.\r\n* `off` - Turn off captions."
        },
        "active_speaker_name": {
          "type": "boolean",
          "example": true,
          "description": "Whether to display the name of the active speaker during a meeting's livestream. Use this field if you pass the `start` value for the `action` field."
        }
      },
      "description": "The meeting's livestreaming settings."
    }
  },
  "description": "The meeting's livestream status."
}

object MeetingsUpdateDetailsRequest

{
  "type": "object",
  "properties": {
    "type": {
      "enum": [
        1,
        2,
        3,
        8
      ],
      "type": "integer",
      "default": 2,
      "example": 2,
      "extensions": {
        "x-enum-descriptions": [
          "Instant Meeting",
          "Scheduled Meeting",
          "Recurring Meeting with no fixed time",
          "Recurring Meeting with fixed time"
        ]
      },
      "description": "Meeting types.\n `1` - Instant meeting.  \n `2` - Scheduled meeting.  \n `3` - Recurring meeting with no fixed time.  \n `8` - Recurring meeting with a fixed time."
    },
    "topic": {
      "type": "string",
      "example": "My Meeting",
      "maxLength": 200,
      "description": "Meeting topic."
    },
    "agenda": {
      "type": "string",
      "example": "My Meeting",
      "maxLength": 2000,
      "description": "Meeting description."
    },
    "duration": {
      "type": "integer",
      "example": 60,
      "description": "Meeting duration in minutes. Used for scheduled meetings only."
    },
    "password": {
      "type": "string",
      "example": "123456",
      "maxLength": 10,
      "description": "Meeting passcode. Passcodes may only contain these characters [a-z A-Z 0-9 @ - _ *] and can have a maximum of 10 characters.\n\n**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.   \n   \n 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."
    },
    "settings": {
      "type": "object",
      "properties": {
        "audio": {
          "enum": [
            "both",
            "telephony",
            "voip",
            "thirdParty"
          ],
          "type": "string",
          "default": "both",
          "example": "telephony",
          "extensions": {
            "x-enum-descriptions": [
              "Both Telephony and VoIP",
              "Telephony only",
              "VoIP only",
              "Third party audio conference"
            ]
          },
          "description": "Determine how participants can join the audio portion of the meeting.  \n `both` - Both Telephony and VoIP.  \n `telephony` - Telephony only.  \n `voip` - VoIP only.  \n `thirdParty` - Third party audio conference."
        },
        "use_pmi": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "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."
        },
        "jbh_time": {
          "enum": [
            0,
            5,
            10
          ],
          "type": "integer",
          "example": 0,
          "description": "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.\n\n*  `0` - Allow participant to join anytime.\n*  `5` - Allow participant to join 5 minutes before meeting start time.\n * `10` - Allow participant to join 10 minutes before meeting start time."
        },
        "resources": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "resource_id": {
                "type": "string",
                "example": "X4Hy02w3QUOdskKofgb9Jg",
                "description": "The resource ID."
              },
              "resource_type": {
                "enum": [
                  "whiteboard"
                ],
                "type": "string",
                "example": "whiteboard",
                "description": "The resource type."
              },
              "permission_level": {
                "enum": [
                  "editor",
                  "commenter",
                  "viewer"
                ],
                "type": "string",
                "default": "editor",
                "example": "editor",
                "description": "The permission levels for users to access the whiteboard. \n* `editor` - Users with link access can edit the board. \n* `commenter` - Users with link access can comment on the board. \n* `viewer` - Users with link access can view the board."
              }
            }
          },
          "description": "The meeting's resources."
        },
        "watermark": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Add a watermark when viewing a shared screen."
        },
        "cn_meeting": {
          "type": "boolean",
          "default": false,
          "example": false,
          "deprecated": true,
          "description": "Host the meeting in China."
        },
        "focus_mode": {
          "type": "boolean",
          "example": true,
          "description": "Whether the [**Focus Mode** feature](https://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) is enabled when the meeting starts."
        },
        "host_video": {
          "type": "boolean",
          "example": true,
          "description": "Start video when the host joins the meeting."
        },
        "in_meeting": {
          "type": "boolean",
          "default": false,
          "example": false,
          "deprecated": true,
          "description": "Host meeting in India."
        },
        "custom_keys": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string",
                "example": "key1",
                "maxLength": 64,
                "description": "Custom key associated with the user."
              },
              "value": {
                "type": "string",
                "example": "value1",
                "maxLength": 256,
                "description": "Value of the custom key associated with the user."
              }
            }
          },
          "maxItems": 10,
          "description": "Custom keys and values assigned to the meeting."
        },
        "contact_name": {
          "type": "string",
          "example": "Jill Chill",
          "description": "Contact name for registration."
        },
        "waiting_room": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Enable waiting room."
        },
        "approval_type": {
          "enum": [
            0,
            1,
            2
          ],
          "type": "integer",
          "default": 2,
          "example": 0,
          "extensions": {
            "x-enum-descriptions": [
              "Automatically Approve",
              "Manually Approve",
              "No Registration Required"
            ]
          },
          "description": "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.**   \n   \n \n\n`0` - Automatically approve.  \n `1` - Manually approve.  \n `2` - No registration required."
        },
        "breakout_room": {
          "type": "object",
          "properties": {
            "rooms": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "example": "room1",
                    "description": "The breakout room's name."
                  },
                  "participants": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "example": "jchill@example.com"
                    },
                    "description": "Email addresses of the participants who are to be assigned to the breakout room."
                  }
                }
              },
              "description": "Create room(s)."
            },
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "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."
            }
          },
          "description": "Setting to [pre-assign breakout rooms](https://support.zoom.us/hc/en-us/articles/360032752671-Pre-assigning-participants-to-breakout-rooms#h_36f71353-4190-48a2-b999-ca129861c1f4)."
        },
        "calendar_type": {
          "enum": [
            1,
            2
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Outlook",
              "Google Calendar"
            ]
          },
          "description": "The type of calendar integration used to schedule the meeting. \n* `1` - [Zoom Outlook add-in](https://support.zoom.us/hc/en-us/articles/360031592971-Getting-started-with-Outlook-plugin-and-add-in) \n* `2` - [Zoom for Google Workspace add-on](https://support.zoom.us/hc/en-us/articles/360020187492-Using-the-Zoom-for-Google-Workspace-add-on)\n\nWorks with the `private_meeting` field to determine whether to share details of meetings."
        },
        "contact_email": {
          "type": "string",
          "example": "jchill@example.com",
          "description": "Contact email for registration."
        },
        "enforce_login": {
          "type": "boolean",
          "example": true,
          "deprecated": true,
          "description": "Only signed in users can join this meeting.\n\n**This field is deprecated and will not be supported in the future.**    \n   \n 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."
        },
        "auto_recording": {
          "enum": [
            "local",
            "cloud",
            "none"
          ],
          "type": "string",
          "default": "none",
          "example": "cloud",
          "extensions": {
            "x-enum-descriptions": [
              "Record to local device",
              "Record to cloud",
              "No Recording"
            ]
          },
          "description": "Automatic recording. \n `local` - Record on local.  \n `cloud` -  Record on cloud.  \n `none` - Disabled."
        },
        "encryption_type": {
          "enum": [
            "enhanced_encryption",
            "e2ee"
          ],
          "type": "string",
          "example": "enhanced_encryption",
          "description": "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**.   \n\n`enhanced_encryption` - Enhanced encryption. Encryption is stored in the cloud if you enable this option.   \n \n\n`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."
        },
        "mute_upon_entry": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Mute participants upon entry."
        },
        "private_meeting": {
          "type": "boolean",
          "example": false,
          "description": "Whether the meeting is set as private."
        },
        "internal_meeting": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to set the meeting as an internal meeting."
        },
        "join_before_host": {
          "type": "boolean",
          "default": false,
          "example": true,
          "description": "Allow participants to join the meeting before the host starts the meeting. Only used for scheduled or recurring meetings."
        },
        "meeting_invitees": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "email": {
                "type": "string",
                "format": "email",
                "example": "jchil@example.com",
                "description": "The invitee's email address."
              }
            }
          },
          "description": "A list of the meeting's invitees."
        },
        "alternative_hosts": {
          "type": "string",
          "example": "jchill@example.com;thill@example.com",
          "description": "A semicolon-separated list of the meeting's alternative hosts' email addresses or IDs."
        },
        "participant_video": {
          "type": "boolean",
          "example": false,
          "description": "Start video when participants join the meeting."
        },
        "registration_type": {
          "enum": [
            1,
            2,
            3
          ],
          "type": "integer",
          "default": 1,
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Attendees register once and can attend any of the occurrences",
              "Attendees need to register for each occurrence to attend",
              "Attendees register once and can choose one or more occurrences to attend"
            ]
          },
          "description": "Registration type. Used for recurring meeting with fixed time only.\n `1` - Attendees register once and can attend any of the occurrences.  \n `2` - Attendees need to register for each occurrence to attend.  \n `3` - Attendees register once and can choose one or more occurrences to attend."
        },
        "show_share_button": {
          "type": "boolean",
          "example": true,
          "description": "Show social share buttons on the meeting registration page.\nThis setting only works for meetings that require [registration](https://support.zoom.us/hc/en-us/articles/211579443-Setting-up-registration-for-a-meeting)."
        },
        "close_registration": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Close registration after the event date."
        },
        "email_notification": {
          "type": "boolean",
          "default": true,
          "example": true,
          "description": "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`."
        },
        "authentication_name": {
          "type": "string",
          "example": "Sign in to Zoom",
          "description": "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)."
        },
        "audio_conference_info": {
          "type": "string",
          "example": "test",
          "maxLength": 2048,
          "description": "Third party audio conference info."
        },
        "authentication_option": {
          "type": "string",
          "example": "signIn_D8cJuqWVQ623CI4Q8yQK0Q",
          "description": "Meeting authentication option ID."
        },
        "enforce_login_domains": {
          "type": "string",
          "example": "example.com",
          "deprecated": true,
          "description": "Only signed in users with specified domains can join meetings.\n\n**This field is deprecated and will not be supported in the future.**    \n   \n 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."
        },
        "host_save_video_order": {
          "type": "boolean",
          "example": true,
          "description": "Whether the **Allow host to save video order** feature is enabled."
        },
        "allow_multiple_devices": {
          "type": "boolean",
          "example": true,
          "description": "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)."
        },
        "authentication_domains": {
          "type": "string",
          "example": "example.com",
          "description": "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."
        },
        "global_dial_in_numbers": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "city": {
                "type": "string",
                "example": "New York",
                "description": "City of the number, if any, such as Chicago."
              },
              "type": {
                "enum": [
                  "toll",
                  "tollfree"
                ],
                "type": "string",
                "example": "toll",
                "description": "Type of number. "
              },
              "number": {
                "type": "string",
                "example": "+1 1000200200",
                "description": "Phone number, such as +1 2332357613."
              },
              "country": {
                "type": "string",
                "example": "US",
                "description": "Country code, such as BR."
              },
              "country_name": {
                "type": "string",
                "example": "US",
                "description": "Full name of country, such as Brazil."
              }
            }
          },
          "description": "Global dial-in countries or regions"
        },
        "meeting_authentication": {
          "type": "boolean",
          "example": true,
          "description": "`true`- Only authenticated users can join meetings."
        },
        "continuous_meeting_chat": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "Whether to enable the **Enable continuous meeting chat** setting."
            },
            "auto_add_invited_external_users": {
              "type": "boolean",
              "example": true,
              "description": "Whether to enable the **Automatically add invited external users** setting."
            }
          },
          "description": "Information about the **Enable continuous meeting chat** feature."
        },
        "language_interpretation": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "Whether to enable [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars) for the meeting."
            },
            "interpreters": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "format": "email",
                    "example": "interpreter@example.com",
                    "description": "The interpreter's email address."
                  },
                  "languages": {
                    "type": "string",
                    "example": "US,FR",
                    "description": "A comma-separated list of the interpreter's languages. The string must contain two [country IDs](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries). \n\nFor example, if the interpreter will translate from English to Chinese, then this value will be `US,CN`."
                  }
                }
              },
              "description": "Information about the meeting's language interpreters."
            }
          },
          "description": "The meeting's [language interpretation settings](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** This feature is only available for certain Meeting add-on, Education, and Business and higher plans. If this feature is not enabled on the host's account, this setting will **not** be applied to the meeting."
        },
        "authentication_exception": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "example": "Jill Chill",
                "description": "The participant's name."
              },
              "email": {
                "type": "string",
                "format": "email",
                "example": "jchill@example.com",
                "description": "The participant's email address."
              },
              "join_url": {
                "type": "string",
                "example": "https://example.com/s/11111",
                "description": "URL for participants to join the meeting"
              }
            }
          },
          "description": "The participants added here will receive unique meeting invite links and bypass authentication."
        },
        "global_dial_in_countries": {
          "type": "array",
          "items": {
            "type": "string",
            "example": "US"
          },
          "description": "List of global dial-in countries"
        },
        "auto_start_meeting_summary": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to automatically start meeting summary."
        },
        "participant_focused_meeting": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to set the meeting as a participant focused meeting."
        },
        "sign_language_interpretation": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "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."
            },
            "interpreters": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "format": "email",
                    "example": "interpreter@example.com",
                    "description": "The interpreter's email address."
                  },
                  "sign_language": {
                    "type": "string",
                    "example": "American",
                    "description": "The interpreter's sign language. \n\n To get this value, use the `sign_language_interpretation` object's `languages` and `custom_languages` values in the [**Get user settings**](/api-reference/zoom-api/methods#operation/userSettings) API response."
                  }
                }
              },
              "maximum": 20,
              "description": "Information about the meeting's sign language interpreters."
            }
          },
          "description": "The meeting's [sign language interpretation settings](https://support.zoom.us/hc/en-us/articles/9644962487309-Using-sign-language-interpretation-in-a-meeting-or-webinar). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** If this feature is not enabled on the host's account, this setting will **not** be applied to the meeting."
        },
        "alternative_host_update_polls": {
          "type": "boolean",
          "example": true,
          "description": "Whether the **Allow alternative hosts to add or edit polls** feature is enabled. This requires Zoom version 5.8.0 or higher."
        },
        "registrants_confirmation_email": {
          "type": "boolean",
          "example": true,
          "description": "Whether to send registrants an email confirmation.\n* `true` - Send a confirmation email.\n* `false` - Do not send a confirmation email."
        },
        "registrants_email_notification": {
          "type": "boolean",
          "example": true,
          "description": "Whether to send registrants email notifications about their registration approval, cancellation, or rejection.\n\n* `true` - Send an email notification.\n* `false` - Do not send an email notification.\n\n Set this value to `true` to also use the `registrants_confirmation_email` parameter."
        },
        "auto_start_ai_companion_questions": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to automatically start AI Companion questions."
        },
        "alternative_hosts_email_notification": {
          "type": "boolean",
          "default": true,
          "example": true,
          "description": "Flag to determine whether to send email notifications to alternative hosts, default value is true."
        },
        "approved_or_denied_countries_or_regions": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "`true` - Setting enabled to either allow users or block users from specific regions to join your meetings.\n \n\n`false` - Setting disabled."
            },
            "method": {
              "enum": [
                "approve",
                "deny"
              ],
              "type": "string",
              "example": "approve",
              "description": "Specify whether to allow users from specific regions to join this meeting, or block users from specific regions from joining this meeting.\n\n \n`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`.  \n\n\n`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`"
            },
            "denied_list": {
              "type": "array",
              "items": {
                "type": "string",
                "example": "CA"
              },
              "description": "List of countries or regions from where participants can not join this meeting. "
            },
            "approved_list": {
              "type": "array",
              "items": {
                "type": "string",
                "example": "CX"
              },
              "description": "List of countries or regions from where participants can join this meeting. "
            }
          },
          "description": "Approve or block users from specific regions or countries from joining this meeting. \n"
        }
      },
      "description": "Meeting settings."
    },
    "timezone": {
      "type": "string",
      "example": "America/Los_Angeles",
      "description": "The timezone to assign to the `start_time` value. Only use this field ifor scheduled or recurring meetings with a fixed time.\n\nFor a list of supported timezones and their formats, see our [timezone list](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones)."
    },
    "recurrence": {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "enum": [
            1,
            2,
            3
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Daily",
              "Weekly",
              "Monthly"
            ]
          },
          "description": "Recurrence meeting types. \n `1` - Daily.  \n `2` - Weekly.  \n `3` - Monthly."
        },
        "end_times": {
          "type": "integer",
          "default": 1,
          "example": 7,
          "maximum": 60,
          "description": "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`."
        },
        "monthly_day": {
          "type": "integer",
          "default": 1,
          "example": 1,
          "description": "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.\n\nFor 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`."
        },
        "weekly_days": {
          "enum": [
            "1",
            "2",
            "3",
            "4",
            "5",
            "6",
            "7"
          ],
          "type": "string",
          "default": "1",
          "example": "1",
          "description": "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.   \n\nThiw 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.  \n   \n  **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.\n\n   \n `1`  - Sunday.   \n `2` - Monday.  \n `3` - Tuesday.  \n `4` -  Wednesday.  \n `5` -  Thursday.  \n `6` - Friday.  \n `7` - Saturday."
        },
        "monthly_week": {
          "enum": [
            -1,
            1,
            2,
            3,
            4
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Last week",
              "First week",
              "Second week",
              "Third week",
              "Fourth week"
            ]
          },
          "description": "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.   \n `-1` - Last week of the month.  \n `1` - First week of the month.  \n `2` - Second week of the month.  \n `3` - Third week of the month.  \n `4` - Fourth week of the month."
        },
        "end_date_time": {
          "type": "string",
          "format": "date-time",
          "example": "2022-04-02T15:59:00Z",
          "description": "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`."
        },
        "repeat_interval": {
          "type": "integer",
          "example": 1,
          "description": "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`. \n\nFor 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.\n\n"
        },
        "monthly_week_day": {
          "enum": [
            1,
            2,
            3,
            4,
            5,
            6,
            7
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Sunday",
              "Monday",
              "Tuesday",
              "Wednesday",
              "Thursday",
              "Friday",
              "Saturday"
            ]
          },
          "description": "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. \n\n  \n `1` - Sunday.  \n `2` - Monday.  \n `3` - Tuesday.  \n `4` -  Wednesday.  \n `5` - Thursday.  \n `6` - Friday.  \n `7` - Saturday."
        }
      },
      "description": "Recurrence object. Use this object only for a meeting with type `8`, a recurring meeting with fixed time. "
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-25T07:29:29Z",
      "description": "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": {
      "type": "string",
      "example": "5Cj3ceXoStO6TGOVvIOVPA==",
      "description": "Unique identifier of the meeting template. \n\n[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": {
      "type": "boolean",
      "default": false,
      "example": false,
      "description": "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. \n* `true` - Create a prescheduled meeting. \n* `false` - Create a regular meeting."
    },
    "schedule_for": {
      "type": "string",
      "example": "jchill@example.com",
      "description": "The email address or `userId` of the user to schedule a meeting for."
    },
    "tracking_fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "example": "field1",
            "description": "Tracking fields type."
          },
          "value": {
            "type": "string",
            "example": "value1",
            "description": "Tracking fields value."
          }
        }
      },
      "description": "Tracking fields."
    }
  },
  "description": "Meeting object."
}

object MeetingsUpdateLivestreamRequest

{
  "type": "object",
  "required": [
    "page_url",
    "stream_key",
    "stream_url"
  ],
  "properties": {
    "page_url": {
      "type": "string",
      "format": "uri",
      "example": "https://example.com/livestream/123",
      "maxLength": 1024,
      "description": "The live stream page URL."
    },
    "resolution": {
      "type": "string",
      "example": "720p",
      "description": "The number of pixels in each dimension that the video camera can display, required when a user enables 1080p. Use a value of `720p` or `1080p`"
    },
    "stream_key": {
      "type": "string",
      "example": "contact-it@example.com",
      "maxLength": 512,
      "description": "Stream name and key."
    },
    "stream_url": {
      "type": "string",
      "example": "https://example.com/livestream",
      "maxLength": 1024,
      "description": "Streaming URL."
    }
  },
  "description": "Meeting live stream."
}

object MeetingsUpdateMeetingPollRequest

{
  "type": "object",
  "title": "Meeting and Webinar Polling Object",
  "properties": {
    "title": {
      "type": "string",
      "example": "Learn something new",
      "maxLength": 64,
      "description": "The poll's title, up to 64 characters."
    },
    "anonymous": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Allow meeting participants to answer poll questions anonymously. \n\nThis value defaults to `false`."
    },
    "poll_type": {
      "enum": [
        1,
        2,
        3
      ],
      "type": "integer",
      "example": 2,
      "description": "The type of poll: \n* `1` &mdash; Poll. \n* `2` &mdash; Advanced Poll. This feature must be enabled in your Zoom account. \n* `3` &mdash; Quiz. This feature must be enabled in your Zoom account. \n\n This value defaults to `1`."
    },
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "How useful was this meeting?",
            "maxLength": 255,
            "description": "The poll question, up to 255 characters. \n\nFor `fill_in_the_blank` polls, this field is the poll's question. For each value that the user must fill in, ensure that there are the same number of `right_answers` values."
          },
          "type": {
            "enum": [
              "single",
              "multiple",
              "matching",
              "rank_order",
              "short_answer",
              "long_answer",
              "fill_in_the_blank",
              "rating_scale"
            ],
            "type": "string",
            "example": "single",
            "extensions": {
              "x-enum-descriptions": [
                "Single choice",
                "Multiple choice",
                "Matching",
                "Rank order",
                "Short answer",
                "Long answer",
                "Fill in the blank",
                "Rating scale"
              ]
            },
            "description": "The poll's question and answer type: \n* `single` &mdash; Single choice. \n* `multiple` &mdash; Multiple choice. \n* `matching` &mdash; Matching. \n* `rank_order` &mdash; Rank order. \n* `short_answer` &mdash; Short answer. \n* `long_answer` &mdash; Long answer. \n* `fill_in_the_blank` &mdash; Fill in the blank. \n* `rating_scale` &mdash; Rating scale."
          },
          "answers": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "Extremely useful"
            },
            "minItems": 2,
            "description": "The poll question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` polls, you can only provide a maximum of 10 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers."
          },
          "prompts": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "prompt_question": {
                  "type": "string",
                  "example": "How are you?",
                  "description": "The question prompt's title."
                },
                "prompt_right_answers": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "Good"
                  },
                  "description": "The question prompt's correct answers: \n* For `matching` polls, you must provide a minimum of two correct answers, up to a maximum of 10 correct answers. \n* For `rank_order` polls, you can only provide one correct answer."
                }
              }
            },
            "description": "Information about the prompt questions. This field only applies to `matching` and `rank_order` polls. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts."
          },
          "right_answers": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "Good"
            },
            "minItems": 1,
            "description": "The poll question's correct answer(s). This field is **required** if the poll's `type` value is `3` (Quiz). \n\n For `single` and `matching` polls, this field only accepts one answer."
          },
          "case_sensitive": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether the correct answer is case sensitive. This field only applies to `fill_in_the_blank` polls: \n* `true` &mdash; The answer is case-sensitive. \n* `false` &mdash; The answer is not case-sensitive. \n\nThis value defaults to `false`."
          },
          "answer_required": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether participants must answer the question: \n* `true` &mdash; The participant must answer the question. \n* `false` &mdash; The participant does not need to answer the question. \n\n**Note:** \n* When the poll's `type` value is `1` (Poll), this value defaults to `true`. \n* When the poll's `type` value is the `2` (Advanced Poll) or `3` (Quiz) values, this value defaults to `false`."
          },
          "rating_max_label": {
            "type": "string",
            "example": "Extremely Likely",
            "description": "The high score label used for the `rating_max_value` field. \n\nThis field only applies to the `rating_scale` poll."
          },
          "rating_max_value": {
            "type": "integer",
            "example": 4,
            "maximum": 10,
            "description": "The rating scale's maximum value, up to a maximum value of 10. \n\nThis field only applies to the `rating_scale` poll."
          },
          "rating_min_label": {
            "type": "string",
            "example": "Not likely",
            "description": "The low score label used for the `rating_min_value` field. \n\nThis field only applies to the `rating_scale` poll."
          },
          "rating_min_value": {
            "type": "integer",
            "example": 0,
            "minimum": 0,
            "description": "The rating scale's minimum value. This value cannot be less than zero. \n\nThis field only applies to the `rating_scale` poll."
          },
          "show_as_dropdown": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether to display the radio selection as a drop-down box: \n* `true` &mdash; Show as a drop-down box. \n* `false` &mdash; Do not show as a drop-down box. \n\nThis value defaults to `false`."
          },
          "answer_max_character": {
            "type": "integer",
            "example": 200,
            "description": "The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` polls: \n* For `short_answer` polls, a maximum of 500 characters. \n* For `long_answer` polls, a maximum of 2,000 characters."
          },
          "answer_min_character": {
            "type": "integer",
            "example": 1,
            "minimum": 1,
            "description": "The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` polls. You must provide at least a **one** character minimum value."
          }
        }
      },
      "description": "Information about the poll's questions."
    }
  },
  "description": "Information about meeting and webinar polling."
}

object MeetingsUpdateMeetingStatusRequest

{
  "type": "object",
  "properties": {
    "action": {
      "enum": [
        "end",
        "recover"
      ],
      "type": "string",
      "example": "recover",
      "description": "`end` - End a meeting.  \n \n`recover` - [Recover](https://support.zoom.us/hc/en-us/articles/360038297111-Recover-a-deleted-meeting) a deleted meeting.\n"
    }
  }
}

object MeetingsUpdateMessageRequest

{
  "type": "object",
  "required": [
    "message_content"
  ],
  "properties": {
    "message_content": {
      "type": "string",
      "example": "This is a test message",
      "description": "The content of the chat message."
    }
  }
}

object MeetingsUpdateRegistrantStatusRequest

{
  "type": "object",
  "required": [
    "action"
  ],
  "properties": {
    "action": {
      "enum": [
        "approve",
        "cancel",
        "deny"
      ],
      "type": "string",
      "example": "approve",
      "extensions": {
        "x-enum-descriptions": [
          "Approve registrant",
          "Cancel previously approved registrant",
          "Deny registrant"
        ]
      },
      "description": "Registrant Status:  \n `approve` - Approve registrant.  \n `cancel` - Cancel previously approved registrant's registration.  \n `deny` - Deny registrant."
    },
    "registrants": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "9tboDiHUQAeOnbmudzWa5g"
          },
          "email": {
            "type": "string",
            "example": "jchill@example.com"
          }
        }
      },
      "maximum": 30,
      "description": "List of registrants."
    }
  }
}

object MeetingsUpdateRegistrationQuestionsRequest

{
  "type": "object",
  "title": "Meeting Registrant Questions",
  "properties": {
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "required": {
            "type": "boolean",
            "example": true,
            "description": "Indicates whether or not the displayed fields are required to be filled out by registrants."
          },
          "field_name": {
            "enum": [
              "last_name",
              "address",
              "city",
              "country",
              "zip",
              "state",
              "phone",
              "industry",
              "org",
              "job_title",
              "purchasing_time_frame",
              "role_in_purchase_process",
              "no_of_employees",
              "comments"
            ],
            "type": "string",
            "example": "last_name",
            "description": "Field name of the question."
          }
        }
      },
      "description": "Array of Registrant Questions"
    },
    "custom_questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "enum": [
              "short",
              "single"
            ],
            "type": "string",
            "example": "short",
            "extensions": {
              "x-enum-descriptions": [
                "Short Answer",
                "Single Answer"
              ]
            },
            "description": "Type of the question being asked."
          },
          "title": {
            "type": "string",
            "example": "How are you?",
            "description": "Title of the custom question."
          },
          "answers": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "Good"
            },
            "description": "Answer choices for the question. Can not be used for `short` question type as this type of question requires registrants to type out the answer."
          },
          "required": {
            "type": "boolean",
            "example": true,
            "description": "Indicates whether or not the custom question is required to be answered by participants or not."
          }
        }
      },
      "description": "Array of Registrant Custom Questions"
    }
  },
  "description": "Meeting Registrant Questions"
}

object MeetingsUpdateSurveyRequest

{
  "type": "object",
  "title": "Meeting Survey Object",
  "properties": {
    "custom_survey": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "example": "Learn something new",
          "maxLength": 64,
          "description": "The survey's title, up to 64 characters."
        },
        "feedback": {
          "type": "string",
          "example": "Thank you so much for taking the time to complete the survey. Your feedback really makes a difference.",
          "maxLength": 320,
          "description": "The survey's feedback, up to 320 characters. \n\n This value defaults to `Thank you so much for taking the time to complete the survey. Your feedback really makes a difference.`."
        },
        "anonymous": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Allow participants to anonymously answer survey questions. \n\n This value defaults to `true`."
        },
        "questions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "example": "How useful was this meeting?",
                "description": "The survey question, up to 420 characters."
              },
              "type": {
                "enum": [
                  "single",
                  "multiple",
                  "matching",
                  "rank_order",
                  "short_answer",
                  "long_answer",
                  "fill_in_the_blank",
                  "rating_scale"
                ],
                "type": "string",
                "example": "single",
                "extensions": {
                  "x-enum-descriptions": [
                    "Single choice",
                    "Multiple choice",
                    "Matching",
                    "Rank order",
                    "Short answer",
                    "Long answer",
                    "Fill in the blank",
                    "Rating scale"
                  ]
                },
                "description": "The survey's question and answer type. \n* `single` - Single choice. \n* `multiple` - Multiple choice. \n* `matching` - Matching. \n* `rank_order` - Rank order \n* `short_answer` - Short answer \n* `long_answer` - Long answer. \n* `fill_in_the_blank` - Fill in the blank \n* `rating_scale` - Rating scale."
              },
              "answers": {
                "type": "array",
                "items": {
                  "type": "string",
                  "example": "Extremely useful",
                  "maxLength": 200
                },
                "minItems": 2,
                "description": "The survey question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` questions, you can only provide a maximum of 50 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers."
              },
              "prompts": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "prompt_question": {
                      "type": "string",
                      "example": "How are you?",
                      "maxLength": 200,
                      "description": "The question prompt's title."
                    }
                  }
                },
                "maxItems": 10,
                "minItems": 2,
                "description": "Information about the prompt questions. This field only applies to `matching` and `rank_order` questions. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts."
              },
              "answer_required": {
                "type": "boolean",
                "default": false,
                "example": false,
                "description": "Whether participants must answer the question. \n* `true` - The participant must answer the question. \n* `false` - The participant does not need to answer the question. \n\n This value defaults to `false`."
              },
              "rating_max_label": {
                "type": "string",
                "example": "Extremely Likely",
                "maxLength": 50,
                "description": "The high score label used for the `rating_max_value` field, up to 50 characters. \n\n This field only applies to the `rating_scale` survey."
              },
              "rating_max_value": {
                "type": "integer",
                "example": 4,
                "maximum": 10,
                "description": "The rating scale's maximum value, up to a maximum value of 10. \n\n This field only applies to the `rating_scale` survey."
              },
              "rating_min_label": {
                "type": "string",
                "example": "Not likely",
                "maxLength": 50,
                "description": "The low score label used for the `rating_min_value` field, up to 50 characters. \n\n This field only applies to the `rating_scale` survey."
              },
              "rating_min_value": {
                "type": "integer",
                "example": 1,
                "minimum": 0,
                "description": "The rating scale's minimum value. This value cannot be less than zero. \n\n This field only applies to the `rating_scale` survey."
              },
              "show_as_dropdown": {
                "type": "boolean",
                "default": false,
                "example": false,
                "description": "Whether to display the radio selection as a drop-down box. \n* `true` - Show as a drop-down box. \n* `false` - Do not show as a drop-down box. \n\n This value defaults to `false`."
              },
              "answer_max_character": {
                "type": "integer",
                "example": 200,
                "description": "The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` questions. \n* For `short_answer` question, a maximum of 500 characters. \n* For `long_answer` question, a maximum of 2,000 characters."
              },
              "answer_min_character": {
                "type": "integer",
                "example": 1,
                "minimum": 1,
                "description": "The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` questions. You must provide at least a **one** character minimum value."
              }
            }
          },
          "maxItems": 100,
          "minItems": 1,
          "description": "Information about the meeting survey's questions."
        },
        "numbered_questions": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to display the number in the question name. \n\n This value defaults to `true`."
        },
        "show_question_type": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to display the question type in the question name. \n\n This value defaults to `false`."
        }
      },
      "description": "Information about the customized meeting survey."
    },
    "third_party_survey": {
      "type": "string",
      "example": "https://example.com",
      "maxLength": 64,
      "description": "The link to the third party meeting survey."
    },
    "show_in_the_browser": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Whether the **Show in the browser when the meeting ends** option is enabled. \n* `true` - Enabled. \n* `false` - Disabled. \n\n This value defaults to `true`."
    }
  },
  "description": "Information about the meeting survey."
}

object PacListAccountsResponse

{
  "type": "object",
  "properties": {
    "pac_accounts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "conference_id": {
            "type": "integer",
            "format": "int64",
            "example": 111111,
            "description": "The conference ID."
          },
          "listen_only_password": {
            "type": "string",
            "example": "3c2b1a",
            "maxLength": 6,
            "description": "The listen-only password, up to six characters in length."
          },
          "participant_password": {
            "type": "string",
            "example": "a1b2c3",
            "maxLength": 6,
            "description": "The participant password, up to six characters in length."
          },
          "global_dial_in_numbers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "number": {
                  "type": "string",
                  "example": "5550100",
                  "maxLength": 16,
                  "description": "The global dial-in number."
                },
                "country": {
                  "type": "string",
                  "example": "USA",
                  "description": "The global dial-in country code."
                }
              }
            },
            "description": "Information about the account's global dial-in numbers."
          },
          "dedicated_dial_in_number": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "number": {
                  "type": "string",
                  "example": "5550110",
                  "maxLength": 16,
                  "description": "The dial-in number."
                },
                "country": {
                  "type": "string",
                  "example": "USA",
                  "description": "The dial-in country code."
                }
              }
            },
            "description": "Information about the account's dedicated dial-in numbers."
          }
        }
      },
      "description": "Information about the PAC accounts."
    }
  }
}

object ReportsGetActiveInactiveHostReportsResponse

{
  "type": "object",
  "properties": {
    "to": {
      "type": "string",
      "format": "date",
      "example": "2022-03-25",
      "description": "End date for this report."
    },
    "from": {
      "type": "string",
      "format": "date",
      "example": "2022-03-01",
      "description": "Start date for this report."
    },
    "users": {
      "type": "array",
      "items": {
        "type": "array of objects",
        "properties": {
          "id": {
            "type": "string",
            "example": "2pyjK5VNQHadb2BY6Z4GbA",
            "description": "User ID."
          },
          "dept": {
            "type": "string",
            "example": "HR",
            "description": "User department."
          },
          "type": {
            "type": "integer",
            "example": 1,
            "description": "User type."
          },
          "email": {
            "type": "string",
            "example": "jchill@example.com",
            "description": "User email."
          },
          "meetings": {
            "type": "integer",
            "example": 45,
            "description": "Number of meetings for user."
          },
          "user_name": {
            "type": "string",
            "example": "Jill Chill",
            "description": "User display name."
          },
          "participants": {
            "type": "integer",
            "example": 56,
            "description": "Number of participants in meetings for user."
          },
          "meeting_minutes": {
            "type": "integer",
            "example": 342,
            "description": "Number of meeting minutes for user."
          },
          "custom_attributes": {
            "type": "array",
            "items": {
              "properties": {
                "key": {
                  "type": "string",
                  "example": "4444AAAiAAAAAiAiAiiAii==",
                  "description": "Identifier for the custom attribute."
                },
                "name": {
                  "type": "string",
                  "example": "age",
                  "description": "Name of the custom attribute."
                },
                "value": {
                  "type": "string",
                  "example": "18",
                  "description": "Value of the custom attribute."
                }
              }
            },
            "description": "Custom attributes that have been assigned to the user."
          }
        }
      },
      "description": "Array of user objects."
    },
    "page_size": {
      "type": "integer",
      "default": 30,
      "example": 30,
      "maximum": 300,
      "description": "The number of records returned with a single API call."
    },
    "page_count": {
      "type": "integer",
      "example": 30,
      "description": "The number of pages returned for the request made."
    },
    "page_number": {
      "type": "integer",
      "default": 1,
      "example": 1,
      "description": "The page number of the current results."
    },
    "total_records": {
      "type": "integer",
      "example": 850,
      "description": "The total number of all the records available across pages."
    },
    "total_meetings": {
      "type": "integer",
      "example": 34,
      "description": "Number of meetings for this range."
    },
    "next_page_token": {
      "type": "string",
      "example": "b43YBRLJFg3V4vsSpxvGdKIGtNbxn9h9If2",
      "description": "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."
    },
    "total_participants": {
      "type": "integer",
      "example": 56,
      "description": "Number of participants for this range."
    },
    "total_meeting_minutes": {
      "type": "integer",
      "example": 345,
      "description": "Number of meeting minutes for this range."
    }
  }
}

object ReportsGetBillingDepartmentReportsResponse

{
  "type": "object",
  "properties": {
    "currency": {
      "type": "string",
      "example": "USD",
      "description": "Currency of the billed amount."
    },
    "billing_reports": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "indfhgfhfho",
            "description": "Unique Identifier of the report. Use this ID to retrieve billing invoice via the &quot;Get Billing Invoices API&quot;. \n\nYou can also use this ID to export a CSV file of the billing report from this URL: `https://zoom.us/account/report/billing/export?id={id}`."
          },
          "type": {
            "enum": [
              0,
              1
            ],
            "type": "integer",
            "example": 1,
            "description": "Type of the billing report. The value should be either of the following:  \n \n`0` - Detailed Billing Reports\n`1` - Custom Billing Reports"
          },
          "end_date": {
            "type": "string",
            "format": "date",
            "example": "2022-03-25",
            "description": "End date of the billing period."
          },
          "start_date": {
            "type": "string",
            "format": "date",
            "example": "2022-03-25",
            "description": "Start date of the billing period."
          },
          "tax_amount": {
            "type": "string",
            "example": "456",
            "description": "Total tax amount for this billing period."
          },
          "total_amount": {
            "type": "string",
            "example": "456",
            "description": "Total billing amount for this billing period."
          }
        }
      }
    }
  }
}

object ReportsGetBillingInvoicesResponse

{
  "type": "object",
  "properties": {
    "currency": {
      "type": "string",
      "example": "USD",
      "description": "Currency of the billed amount in the invoice."
    },
    "invoices": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "end_date": {
            "type": "string",
            "format": "date",
            "example": "2022-03-25",
            "description": "End date of the invoice period."
          },
          "quantity": {
            "type": "integer",
            "example": 45,
            "description": "Number of licenses bought."
          },
          "start_date": {
            "type": "string",
            "format": "date",
            "example": "2022-03-25",
            "description": "Start date of the invoice period."
          },
          "tax_amount": {
            "type": "string",
            "example": "34",
            "description": "Tax amount in the invoice."
          },
          "total_amount": {
            "type": "string",
            "example": "45",
            "description": "Total billed amount in the invoice."
          },
          "invoice_number": {
            "type": "string",
            "example": "3",
            "description": "Invoice number "
          },
          "invoice_charge_name": {
            "type": "string",
            "example": "Audio Conferencing Options",
            "description": "Name of the invoice."
          }
        }
      }
    }
  }
}

object ReportsGetCloudRecordingUsageReportResponse

{
  "type": "object",
  "properties": {
    "to": {
      "type": "string",
      "format": "date",
      "example": "2021-12-30",
      "description": "End date for this report"
    },
    "from": {
      "type": "string",
      "format": "date",
      "example": "2021-12-01",
      "description": "Start date for this report"
    },
    "cloud_recording_storage": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "date": {
            "type": "string",
            "format": "date",
            "example": "2021-12-05",
            "description": "Date of the usage"
          },
          "usage": {
            "type": "string",
            "example": "3 MB",
            "description": "Storage used on the date"
          },
          "free_usage": {
            "type": "string",
            "example": "Unlimited",
            "description": "Free storage"
          },
          "plan_usage": {
            "type": "string",
            "example": "3 TB",
            "description": "Paid storage"
          }
        }
      },
      "description": "Array of cloud usage objects"
    }
  }
}

object ReportsGetDailyUsageReportResponse

{
  "type": "object",
  "properties": {
    "year": {
      "type": "integer",
      "example": 2022,
      "description": "Year for this report."
    },
    "dates": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "date": {
            "type": "string",
            "format": "date",
            "example": "2022-03-01",
            "description": "Date for this object."
          },
          "meetings": {
            "type": "integer",
            "example": 2,
            "description": "Number of meetings on this date."
          },
          "new_users": {
            "type": "integer",
            "example": 3,
            "description": "Number of new users on this date."
          },
          "participants": {
            "type": "integer",
            "example": 4,
            "description": "Number of participants on this date."
          },
          "meeting_minutes": {
            "type": "integer",
            "example": 34,
            "description": "Number of meeting minutes on this date."
          }
        }
      },
      "description": "Array of date objects."
    },
    "month": {
      "type": "integer",
      "example": 3,
      "description": "Month for this report."
    }
  }
}

object ReportsGetMeetingDetailReportsResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 3927350525,
      "description": "[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-): Unique identifier of the meeting in &quot;**long**&quot; format(represented as int64 data type in JSON), also known as the meeting number."
    },
    "dept": {
      "type": "string",
      "example": "HR",
      "description": "Department of the host."
    },
    "type": {
      "type": "integer",
      "example": 2,
      "description": "Meeting type."
    },
    "uuid": {
      "type": "string",
      "example": "iOTQZPmhTUq5a232ETb9eg==",
      "description": "Meeting UUID. Each meeting instance will generate its own UUID(i.e., after a meeting ends, a new UUID will be generated for the next instance of the meeting). [Double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) your UUID when using it for API calls if the UUID begins with a '/' or contains '//' in it."
    },
    "topic": {
      "type": "string",
      "example": "My Meeting",
      "description": "Meeting topic."
    },
    "duration": {
      "type": "integer",
      "example": 2,
      "description": "Meeting duration."
    },
    "end_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-15T07:42:22Z",
      "description": "Meeting end time."
    },
    "user_name": {
      "type": "string",
      "example": "Jill Chill",
      "description": "User display name."
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-15T07:40:46Z",
      "description": "Meeting start time."
    },
    "user_email": {
      "type": "string",
      "example": "jchill@example.com",
      "description": "User email."
    },
    "custom_keys": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "example": "Host Nation",
            "maxLength": 64,
            "description": "Custom key associated with the user."
          },
          "value": {
            "type": "string",
            "example": "US",
            "maxLength": 256,
            "description": "Value of the custom key associated with the user."
          }
        }
      },
      "maxItems": 10,
      "description": "Custom keys and values assigned to the meeting."
    },
    "total_minutes": {
      "type": "integer",
      "example": 3,
      "description": "Number of meeting minutes. This represents the total amount of meeting minutes attended by each participant including the host, for meetings hosted by the user. For instance if there were one host(named A) and one participant(named B) in a meeting, the value of total_minutes would be calculated as below:\n\n**total_minutes** = Total Meeting Attendance Minutes of A + Total Meeting Attendance Minutes of B"
    },
    "tracking_fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "example": "Host Nation",
            "description": "Tracking fields type."
          },
          "value": {
            "type": "string",
            "example": "US",
            "description": "Tracking fields value."
          }
        }
      },
      "description": "Tracking fields."
    },
    "participants_count": {
      "type": "integer",
      "example": 2,
      "description": "Number of meeting participants."
    }
  }
}

object ReportsGetMeetingParticipantReportsResponse

{
  "type": "object",
  "properties": {
    "page_size": {
      "type": "integer",
      "default": 30,
      "example": 30,
      "maximum": 300,
      "description": "The number of records returned within a single API call."
    },
    "page_count": {
      "type": "integer",
      "example": 1,
      "description": "The number of pages returned for the request made."
    },
    "participants": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "30R7kT7bTIKSNUFEuH_Qlg",
            "description": "The participant's universally unique ID (UUID). \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](https://developers.zoom.us) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value. \n\n**Note:** Use the `participant_user_id` value instead of this value. We will remove this response in a future release."
          },
          "name": {
            "type": "string",
            "example": "example",
            "description": "Participant display name.\n\nThis returns an empty string value if the account calling the API is a BAA account."
          },
          "status": {
            "enum": [
              "in_meeting",
              "in_waiting_room"
            ],
            "type": "string",
            "example": "in_meeting",
            "description": "The participant's status. \n* `in_meeting` - In a meeting. \n* `in_waiting_room` - In a waiting room."
          },
          "user_id": {
            "type": "string",
            "example": "27423744",
            "description": "Participant ID. This is a unique ID assigned to the participant joining a meeting and is valid for that meeting only."
          },
          "duration": {
            "type": "integer",
            "example": 259,
            "description": "Participant duration."
          },
          "failover": {
            "type": "boolean",
            "example": false,
            "description": "Indicates if failover happened during the meeting."
          },
          "bo_mtg_id": {
            "type": "string",
            "example": "27423744",
            "description": "The [breakout room](https://support.zoom.us/hc/en-us/articles/206476313-Managing-breakout-rooms) ID. Each breakout room is assigned a unique ID."
          },
          "join_time": {
            "type": "string",
            "format": "date-time",
            "example": "2022-03-23T06:58:09Z",
            "description": "Participant join time."
          },
          "leave_time": {
            "type": "string",
            "format": "date-time",
            "example": "2022-03-23T07:02:28Z",
            "description": "Participant leave time."
          },
          "user_email": {
            "type": "string",
            "example": "jchill@example.com",
            "description": "Participant email.\n\nIf the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us) for details. This returns an empty string value if the account calling the API is a BAA account."
          },
          "customer_key": {
            "type": "string",
            "example": "349589LkJyeW",
            "maxLength": 35,
            "description": "The participant's SDK identifier. This value can be alphanumeric, up to a maximum length of 35 characters."
          },
          "registrant_id": {
            "type": "string",
            "example": "abcdefghij0-klmnopq23456",
            "description": "Unique identifier of the registrant. This field is only returned if you entered &quot;registrant_id&quot; as the value of `include_fields` query parameter."
          },
          "participant_user_id": {
            "type": "string",
            "example": "DYHrdpjrS3uaOf7dPkkg8w",
            "description": "The participant's universally unique ID (UUID). \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](https://developers.zoom.us) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value."
          }
        }
      },
      "description": "Array of meeting participant objects."
    },
    "total_records": {
      "type": "integer",
      "example": 1,
      "description": "The number of all records available across pages."
    },
    "next_page_token": {
      "type": "string",
      "example": "Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3",
      "description": "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."
    }
  },
  "description": "Pagination object."
}

object ReportsGetMeetingPollReportsResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 123456,
      "description": "The [meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID)."
    },
    "uuid": {
      "type": "string",
      "example": "4444AAAiAAAAAiAiAiiAii==",
      "description": "The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."
    },
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "Jill Chill",
            "description": "The participant's display name. If the **Allow participants to answer questions anonymously** setting is enabled for a [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meet), the participant's polling information is kept anonymous and the `name` field will return the &quot;Anonymous Attendee&quot; value."
          },
          "email": {
            "type": "string",
            "format": "email",
            "example": "jchill@example.com",
            "description": "The participant's email address."
          },
          "last_name": {
            "type": "string",
            "example": "Chill",
            "description": "The participant's last name. If the **Allow participants to answer questions anonymously** setting is enabled for a [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meet), the participant's polling information is kept anonymous and the `last_name` field will return the &quot;Anonymous Attendee&quot; value."
          },
          "first_name": {
            "type": "string",
            "example": "Jill",
            "description": "The participant's first name. If the **Allow participants to answer questions anonymously** setting is enabled for a [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meet), the participant's polling information is kept anonymous and the `first_name` field will return the &quot;Anonymous Attendee&quot; value."
          },
          "question_details": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "answer": {
                  "type": "string",
                  "example": "I am wonderful.",
                  "description": "The user's given answer."
                },
                "question": {
                  "type": "string",
                  "example": "How are you?",
                  "description": "The poll question."
                },
                "date_time": {
                  "type": "string",
                  "example": "2022-02-01T12:37:12.660Z",
                  "description": "The date and time at which the user answered the poll question."
                },
                "polling_id": {
                  "type": "string",
                  "example": "798fGJEWrA",
                  "description": "The poll's ID."
                }
              }
            },
            "description": "Information about the user's questions and answers."
          }
        }
      },
      "description": "Information about the meeting questions."
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-02-01T12:34:12.660Z",
      "description": "The meeting's start time."
    }
  }
}

object ReportsGetMeetingQaReportResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 245603123123,
      "description": "The meeting ID in `long` format, represented as int64 data type in JSON. Also known as the meeting number."
    },
    "uuid": {
      "type": "string",
      "example": "4444AAAiAAAAAiAiAiiAii==",
      "description": "The meeting UUID. Each meeting instance will generate its own UUID - for example, after a meeting ends, a new UUID will be generated for the next instance of the meeting. Double-encode your UUID when using it for API calls if the UUID begins with a '/' or contains '//'."
    },
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "Jill Chill",
            "description": "Participant's display name.  \n  \n\nIf the anonymous [Q&amp;A](https://support.zoom.us/hc/en-us/articles/203686015-Getting-Started-with-Question-Answer) option is enabled and if a participant submits the Q&amp;A without providing their name, the value of the `name` field is &quot;Anonymous Attendee&quot;."
          },
          "email": {
            "type": "string",
            "example": "jchilll@example.com",
            "description": "Participant's email. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details."
          },
          "user_id": {
            "type": "string",
            "example": "hyROrs0TRCSvwmadI7L13w",
            "description": "The user ID of the user who asked the question. This value returns blank for external users."
          },
          "question_details": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "answer": {
                  "type": "string",
                  "example": "fine",
                  "deprecated": true,
                  "description": "The given answer. If this is a live answer, the value is 'live answered'.\n**Note:** All answers will be returned together and separated by semicolons. For more detailed answer information, please see the \"answer_details\" field."
                },
                "question": {
                  "type": "string",
                  "example": "how are you",
                  "description": "Asked question."
                },
                "create_time": {
                  "type": "string",
                  "example": "2022-03-15T07:48:00Z",
                  "description": "Question create time."
                },
                "question_id": {
                  "type": "string",
                  "example": "zxU4wOwnlxs",
                  "description": "Question UUID."
                },
                "answer_details": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "string",
                        "example": "Paul",
                        "description": "User display name, including the host or participant."
                      },
                      "type": {
                        "enum": [
                          "default",
                          "host_answered",
                          "participant_commented"
                        ],
                        "type": "string",
                        "default": "default",
                        "example": "default",
                        "extensions": {
                          "x-enum-description": [
                            "default - default value, does not represent any type",
                            "host_answered - answer from the host",
                            "participant_commented - comment from the participant"
                          ]
                        },
                        "description": "Type of answer."
                      },
                      "email": {
                        "type": "string",
                        "example": "paul@example.com",
                        "description": "Participant's email. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details."
                      },
                      "content": {
                        "type": "string",
                        "example": "fine",
                        "maxLength": 1024,
                        "description": "The answer from host or the comment from participant."
                      },
                      "user_id": {
                        "type": "string",
                        "example": "Cn_5wJ9mRNGyYOmpjVufBQ",
                        "description": "The user ID of the user who answered the question. This value returns blank for external users."
                      },
                      "create_time": {
                        "type": "string",
                        "example": "2022-03-15T07:50:00Z",
                        "description": "Content submit time."
                      }
                    }
                  },
                  "description": "Array of answers from the user."
                }
              }
            },
            "description": "Array of questions from user."
          }
        }
      },
      "description": "Array of meeting question objects."
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-15T07:40:46Z",
      "description": "Meeting start time."
    }
  }
}

object ReportsGetMeetingReportsResponse

{
  "type": "object",
  "properties": {
    "to": {
      "type": "string",
      "format": "date",
      "example": "2020-08-14",
      "description": "The report's end date."
    },
    "from": {
      "type": "string",
      "format": "date",
      "example": "2020-07-14",
      "description": "The report's start date."
    },
    "meetings": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "example": 12345,
            "description": "The [meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID)."
          },
          "type": {
            "enum": [
              1,
              2,
              3,
              4,
              5,
              6,
              7,
              8,
              9
            ],
            "type": "integer",
            "example": 2,
            "description": "The type of meeting or webinar. \n\nmeeting: \n* `1` &mdash; Instant meeting. \n* `2` &mdash; Scheduled meeting. \n* `3` &mdash; A recurring meeting with no fixed time. \n* `4` &mdash; A meeting created via PMI (Personal Meeting ID). \n* `7` &mdash; A [Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC). \n* `8` - Recurring meeting with a fixed time. \n\nwebinar: \n* `5` &mdash; A webinar. \n* `6` &mdash; A recurring webinar without a fixed time \n* `9` &mdash; A recurring webinar with a fixed time. "
          },
          "uuid": {
            "type": "string",
            "example": "4444AAAiAAAAAiAiAiiAii==",
            "description": "The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."
          },
          "topic": {
            "type": "string",
            "example": "My Meeting",
            "description": "The meeting's topic."
          },
          "source": {
            "type": "string",
            "example": "Zoom",
            "description": "Whether the meeting was created directly through Zoom or via an API request: \n* If the meeting was created via an OAuth app, this field returns the OAuth app's name. \n* If the meeting was created via JWT or the Zoom Web Portal, this returns the `Zoom` value."
          },
          "duration": {
            "type": "integer",
            "example": 6,
            "description": "The meeting's duration."
          },
          "end_time": {
            "type": "string",
            "format": "date-time",
            "example": "2020-07-15T23:30:19Z",
            "description": "The meeting's end date and time."
          },
          "has_chat": {
            "type": "boolean",
            "example": false,
            "description": "Indicates whether or not the chat feature was used in the meeting."
          },
          "host_name": {
            "type": "string",
            "example": "Jill",
            "description": "Host's name."
          },
          "join_time": {
            "type": "string",
            "example": "12/22/2021 16:20",
            "description": "The date and time at which the attendee joined the meeting."
          },
          "user_name": {
            "type": "string",
            "example": "Jill Chill",
            "description": "The user's display name."
          },
          "leave_time": {
            "type": "string",
            "example": "12/22/2021 17:13",
            "description": "The date and time at which the attendee left the meeting."
          },
          "start_time": {
            "type": "string",
            "format": "date-time",
            "example": "2019-07-15T23:24:52Z",
            "description": "The meeting's start date and time."
          },
          "user_email": {
            "type": "string",
            "format": "email",
            "example": "jchill@example.com",
            "description": "The user's email address."
          },
          "custom_keys": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string",
                  "example": "Host Nation",
                  "maxLength": 64,
                  "description": "The custom key name."
                },
                "value": {
                  "type": "string",
                  "example": "US",
                  "maxLength": 256,
                  "description": "The custom key's value."
                }
              }
            },
            "maxItems": 10,
            "description": "Information about the meeting's assigned custom keys and values. This returns a maximum of 10 items."
          },
          "session_key": {
            "type": "string",
            "example": "ABC36jaBI145",
            "description": "The Video SDK custom session ID."
          },
          "has_recording": {
            "type": "boolean",
            "example": false,
            "description": "Indicates whether or not the recording feature was used in the meeting."
          },
          "schedule_time": {
            "type": "string",
            "example": "12/22/2021 16:20",
            "description": "The meeting's scheduled date and time."
          },
          "total_minutes": {
            "type": "integer",
            "example": 11,
            "description": "The sum of meeting minutes from all meeting participants in the meeting."
          },
          "has_screen_share": {
            "type": "boolean",
            "example": false,
            "description": "Indicates whether or not the screenshare feature was used in the meeting."
          },
          "host_organization": {
            "type": "string",
            "example": "org",
            "description": "Host Account Name of Hosting Organization."
          },
          "participants_count": {
            "type": "integer",
            "example": 2,
            "description": "The number of meeting participants."
          },
          "join_waiting_room_time": {
            "type": "string",
            "example": "02/11/2022 16:15",
            "description": "The date and time at which the attendee joined the waiting room."
          },
          "meeting_encryption_status": {
            "enum": [
              1,
              2
            ],
            "type": "integer",
            "example": 1,
            "description": "The meeting's encryption status. \n* `1` &mdash; E2E encryption. \n* `2` &mdash; Enhanced encryption."
          },
          "participants_count_my_account": {
            "type": "integer",
            "example": 2,
            "description": "The number of meeting participants from my account."
          }
        }
      },
      "description": "Information about the meeting."
    },
    "page_size": {
      "type": "integer",
      "default": 30,
      "example": 30,
      "maximum": 300,
      "description": "The number of records returned with a single API call."
    },
    "page_count": {
      "type": "integer",
      "example": 1,
      "description": "The number of pages returned for the request made."
    },
    "page_number": {
      "type": "integer",
      "default": 1,
      "example": 1,
      "deprecated": true,
      "description": "**Deprecated.** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination."
    },
    "total_records": {
      "type": "integer",
      "example": 20,
      "description": "The total number of all the records available across pages."
    },
    "next_page_token": {
      "type": "string",
      "example": "w7587w4eiyfsudgk",
      "description": "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."
    }
  },
  "description": "Pagination Object."
}

object ReportsGetMeetingSurveyReportResponse

{
  "type": "object",
  "properties": {
    "survey_id": {
      "type": "string",
      "example": "8SFHRTGHAAAiAAAAAiAiAiiAii==",
      "description": "The survey's ID"
    },
    "meeting_id": {
      "type": "integer",
      "format": "int64",
      "example": 123456,
      "description": "The meeting ID."
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-02-01T12:34:12.660Z",
      "description": "The meeting's start time."
    },
    "survey_name": {
      "type": "string",
      "example": "Survey of this meeting",
      "description": "The name of survey"
    },
    "meeting_uuid": {
      "type": "string",
      "example": "4444AAAiAAAAAiAiAiiAii==",
      "description": "The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."
    },
    "survey_answers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "Jill Chill",
            "description": "The participant's display name. **Allow participants to answer questions anonymously** setting is enabled for a [survey](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057559), the participant's survey information is kept anonymous and the `name` field will return the &quot;Anonymous Attendee&quot; value."
          },
          "email": {
            "type": "string",
            "format": "email",
            "example": "jchill@example.com",
            "description": "The participant's email address."
          },
          "last_name": {
            "type": "string",
            "example": "Chill",
            "description": "The participant's last name. If the **Allow participants to answer questions anonymously** setting is enabled for a [survey](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057559), the participant's survey information is kept anonymous and the `last_name` field will return the &quot;Anonymous Attendee&quot; value."
          },
          "first_name": {
            "type": "string",
            "example": "Jill",
            "description": "The participant's first name. If the **Allow participants to answer questions anonymously** setting is enabled for a [survey](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057559), the participant's survey information is kept anonymous and the `first_name` field will return the &quot;Anonymous Attendee&quot; value."
          },
          "answer_details": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "answer": {
                  "type": "string",
                  "example": "I am wonderful.",
                  "description": "The user's given answer."
                },
                "question": {
                  "type": "string",
                  "example": "How are you?",
                  "description": "The survey question."
                },
                "date_time": {
                  "type": "string",
                  "example": "2022-02-01T12:37:12.660Z",
                  "description": "The date and time at which the user answered the survey question."
                },
                "question_id": {
                  "type": "string",
                  "example": "798fGJEWrA",
                  "description": "The question's ID"
                }
              }
            },
            "description": "Information about the user's questions and answers."
          }
        }
      },
      "description": "Information about the survey questions and answers."
    }
  }
}

object ReportsGetOperationLogsReportResponse

{
  "type": "object",
  "properties": {
    "page_size": {
      "type": "integer",
      "default": 30,
      "example": 30,
      "maximum": 300,
      "description": "The amount of records returns within a single API call. "
    },
    "operation_logs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "time": {
            "type": "string",
            "format": "date-time",
            "example": "2022-01-25T17:52:16Z",
            "description": "The time at which the operation was performed."
          },
          "action": {
            "type": "string",
            "example": "delete",
            "description": "Action"
          },
          "operator": {
            "type": "string",
            "example": "admin@example.com",
            "description": "The user who performed the operation."
          },
          "category_type": {
            "type": "string",
            "example": "user",
            "description": "Category type"
          },
          "operation_detail": {
            "type": "string",
            "example": "delete user - user2@example.com",
            "description": "Operation detail"
          }
        }
      },
      "description": "Array of operation log objects"
    },
    "next_page_token": {
      "type": "string",
      "example": "uBTK3NzNksdkuCUAQaFVFd86kyOr59zg4U2",
      "description": "The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of the available result list exceeds the page size. The expiration period is 15 minutes."
    }
  },
  "description": "Pagination object."
}

object ReportsGetTelephoneReportsResponse

{
  "type": "object",
  "properties": {
    "to": {
      "type": "string",
      "format": "date",
      "example": "2019-07-20",
      "description": "End date for this report."
    },
    "from": {
      "type": "string",
      "format": "date",
      "example": "2019-06-20",
      "description": "Start date for this report."
    },
    "page_size": {
      "type": "integer",
      "example": 30,
      "description": "The number of records returned with a single API call."
    },
    "page_count": {
      "type": "integer",
      "example": 1,
      "description": "The number of pages returned for the request made. This field does **not** return if the `query_date_type` parameter is the `meeting_start_time` or `meeting_end_time` value."
    },
    "total_records": {
      "type": "integer",
      "example": 1,
      "description": "The total number of all the records available across pages. This field does **not** return if the `query_date_type` parameter is the `meeting_start_time` or `meeting_end_time` value."
    },
    "next_page_token": {
      "type": "string",
      "example": "w7587w4eiyfsudgk",
      "description": "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."
    },
    "telephony_usage": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "dept": {
            "type": "string",
            "example": "HR",
            "description": "User department."
          },
          "rate": {
            "type": "number",
            "example": 0.03,
            "description": "Calling rate for the telephone call."
          },
          "type": {
            "enum": [
              "toll-free",
              "call-out",
              "call-in",
              "US toll-number",
              "global toll-number",
              "premium",
              "premium call-in",
              "Toll"
            ],
            "type": "string",
            "example": "call-out",
            "description": "Call type."
          },
          "uuid": {
            "type": "string",
            "example": "4444AAAiAAAAAiAiAiiAii==",
            "description": "Meeting UUID."
          },
          "total": {
            "type": "number",
            "example": 0.03,
            "description": "Total cost (USD) for Call Out. Calculated as plan rate by duration."
          },
          "host_id": {
            "type": "string",
            "example": "_Rn_hal7ToG5p0AWwIIsjQ",
            "description": "The user ID of the meeting host."
          },
          "duration": {
            "type": "integer",
            "example": 2,
            "description": "Call leg duration"
          },
          "end_time": {
            "type": "string",
            "format": "date-time",
            "example": "2022-03-15T07:42:22Z",
            "description": "Call leg end time"
          },
          "host_name": {
            "type": "string",
            "example": "Jill Chill",
            "description": "User display name."
          },
          "host_email": {
            "type": "string",
            "example": "jchill@example.com",
            "description": "User email."
          },
          "meeting_id": {
            "type": "integer",
            "format": "int64",
            "example": 94908911701,
            "description": "[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-): Unique identifier of the meeting in &quot;**long**&quot; format(represented as int64 data type in JSON), also known as the meeting number."
          },
          "start_time": {
            "type": "string",
            "format": "date-time",
            "example": "2022-03-15T07:40:46Z",
            "description": "Call leg start time"
          },
          "country_name": {
            "type": "string",
            "example": "US",
            "description": "Country name."
          },
          "meeting_type": {
            "type": "string",
            "example": "Meeting",
            "description": "Meeting type."
          },
          "phone_number": {
            "type": "string",
            "example": "+1 8243",
            "description": "Toll-free telephone number. "
          },
          "call_in_number": {
            "type": "string",
            "example": "ZoomGW",
            "description": "Caller's call-in number."
          },
          "signaled_number": {
            "type": "string",
            "example": "+1 8243",
            "description": "The number that is signaled to Zoom. "
          }
        }
      },
      "description": "Array of telephony objects."
    }
  }
}

object ReportsGetWebinarDetailsReportResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 345678902224,
      "description": "[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-): Unique identifier of the meeting in &quot;**long**&quot; format(represented as int64 data type in JSON), also known as the meeting number."
    },
    "dept": {
      "type": "string",
      "example": "HR",
      "description": "Department of the host."
    },
    "type": {
      "type": "integer",
      "example": 4,
      "description": "Meeting type."
    },
    "uuid": {
      "type": "string",
      "example": "4444AAAiAAAAAiAiAiiAii==",
      "description": "Webinar UUID. Each webinar instance will generate its own UUID(i.e., after a meeting ends, a new UUID will be generated when the next instance of the webinar starts). [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the UUID when using it for API calls if the UUID begins with a '/' or contains '//' in it."
    },
    "topic": {
      "type": "string",
      "example": "My Meeting",
      "description": "Meeting topic."
    },
    "duration": {
      "type": "integer",
      "example": 2,
      "description": "Meeting duration."
    },
    "end_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-15T07:42:22Z",
      "description": "Meeting end time."
    },
    "user_name": {
      "type": "string",
      "example": "Jill Chill",
      "description": "User display name."
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-15T07:40:46Z",
      "description": "Meeting start time."
    },
    "user_email": {
      "type": "string",
      "example": "jchill@example.com",
      "description": "User email."
    },
    "custom_keys": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "example": "Host Nation",
            "maxLength": 64,
            "description": "Custom key associated with the user."
          },
          "value": {
            "type": "string",
            "example": "US",
            "maxLength": 256,
            "description": "Value of the custom key associated with the user."
          }
        }
      },
      "maxItems": 10,
      "description": "Custom keys and values assigned to the meeting."
    },
    "total_minutes": {
      "type": "integer",
      "example": 3,
      "description": "Number of Webinar minutes. This represents the total amount of Webinar minutes attended by each participant including the host, for a Webinar hosted by the user. For instance if there were one host(named A) and one participant(named B) in a Webinar, the value of total_minutes would be calculated as below:\n\n**total_minutes** = Total Webinar Attendance Minutes of A + Total Webinar Attendance Minutes of B"
    },
    "tracking_fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "example": "Host Nation",
            "description": "Tracking fields type."
          },
          "value": {
            "type": "string",
            "example": "US",
            "description": "Tracking fields value."
          }
        }
      },
      "description": "Tracking fields."
    },
    "participants_count": {
      "type": "integer",
      "example": 4,
      "description": "Number of meeting participants."
    }
  }
}

object ReportsGetWebinarPollReportsResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 123456,
      "description": "The webinar ID."
    },
    "uuid": {
      "type": "string",
      "example": "4444AAAiAAAAAiAiAiiAii==",
      "description": "The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."
    },
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "Jill Chill",
            "description": "The participant's display name. **Allow participants to answer questions anonymously** setting is enabled for a [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meet), the participant's polling information is kept anonymous and the `name` field will return the &quot;Anonymous Attendee&quot; value."
          },
          "email": {
            "type": "string",
            "format": "email",
            "example": "jchill@example.com",
            "description": "The participant's email address."
          },
          "last_name": {
            "type": "string",
            "example": "Chill",
            "description": "The participant's last name. If the **Allow participants to answer questions anonymously** setting is enabled for a [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meet), the participant's polling information is kept anonymous and the `last_name` field will return the &quot;Anonymous Attendee&quot; value."
          },
          "first_name": {
            "type": "string",
            "example": "Jill",
            "description": "The participant's first name. If the **Allow participants to answer questions anonymously** setting is enabled for a [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meet), the participant's polling information is kept anonymous and the `first_name` field will return the &quot;Anonymous Attendee&quot; value."
          },
          "question_details": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "answer": {
                  "type": "string",
                  "example": "I am wonderful.",
                  "description": "The user's given answer."
                },
                "question": {
                  "type": "string",
                  "example": "How are you?",
                  "description": "The poll question."
                },
                "date_time": {
                  "type": "string",
                  "example": "2022-02-01T12:37:12.660Z",
                  "description": "The date and time at which the user answered the poll question."
                },
                "polling_id": {
                  "type": "string",
                  "example": "798fGJEWrA",
                  "description": "The poll's ID."
                }
              }
            },
            "description": "Information about the user's questions and answers."
          }
        }
      },
      "description": "Information about the webinar questions."
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-02-01T12:34:12.660Z",
      "description": "The webinar's start time."
    }
  }
}

object ReportsGetWebinarQaReportResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 245603123123,
      "description": "Webinar ID in `long` format, represented as int64 data type in JSON. Also known as the webinar number."
    },
    "uuid": {
      "type": "string",
      "example": "4444AAAiAAAAAiAiAiiAii==",
      "description": "Webinar UUID. Each webinar instance will generate its own UUID - after a webinar ends, a new UUID will be generated for the next instance of the webinar. Double-encode your UUID when using it for API calls if the UUID begins with a '/' or contains '//' in it."
    },
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "Jill Chill",
            "description": "Participant's display name.  \n  \n\nIf anonymous [Q&amp;A](https://support.zoom.us/hc/en-us/articles/203686015-Getting-Started-with-Question-Answer) option is enabled and if a participant submits the Q&amp;A without providing their name, the value of the `name` field will be &quot;Anonymous Attendee&quot;."
          },
          "email": {
            "type": "string",
            "example": "jchilll@example.com",
            "description": "Participant's email. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details."
          },
          "user_id": {
            "type": "string",
            "example": "hyROrs0TRCSvwmadI7L13w",
            "description": "The user ID of the user who asked the question. This value returns blank for external users."
          },
          "question_details": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "answer": {
                  "type": "string",
                  "example": "fine",
                  "deprecated": true,
                  "description": "The given answer. If this is a live answer, the value is 'live answered'.\n**Note:** All answers will be returned together and separated by semicolons. For more detailed answer information, please see the \"answer_details\" field."
                },
                "question": {
                  "type": "string",
                  "example": "how are you",
                  "description": "Asked question."
                },
                "create_time": {
                  "type": "string",
                  "example": "2022-03-15T07:48:00Z",
                  "description": "Question creation time."
                },
                "question_id": {
                  "type": "string",
                  "example": "zxU4wOwnlxs",
                  "description": "Question UUID."
                },
                "answer_details": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "string",
                        "example": "Paul",
                        "description": "User display name, including the host or participant. "
                      },
                      "type": {
                        "enum": [
                          "default",
                          "host_answered",
                          "participant_commented"
                        ],
                        "type": "string",
                        "default": "default",
                        "example": "default",
                        "extensions": {
                          "x-enum-description": [
                            "default - default value, does not represent any type",
                            "host_answered - answer from the host",
                            "participant_commented - comment from the participant"
                          ]
                        },
                        "description": "Type of answer."
                      },
                      "email": {
                        "type": "string",
                        "example": "paul@example.com",
                        "description": "Participant's email. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details."
                      },
                      "content": {
                        "type": "string",
                        "example": "fine",
                        "maxLength": 1024,
                        "description": "The answer from the host or the comment from a participant."
                      },
                      "user_id": {
                        "type": "string",
                        "example": "Cn_5wJ9mRNGyYOmpjVufBQ",
                        "description": "The user ID of the user who answered the question. This value returns blank for external users."
                      },
                      "create_time": {
                        "type": "string",
                        "example": "2022-03-15T07:50:00Z",
                        "description": "Content submission time."
                      }
                    }
                  },
                  "description": "Array of answers from user."
                }
              }
            },
            "description": "Array of questions from the user."
          }
        }
      },
      "description": "Array of webinar question objects."
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-15T07:40:46Z",
      "description": "Webinar start time."
    }
  }
}

object ReportsGetWebinarSurveyReportResponse

{
  "type": "object",
  "properties": {
    "survey_id": {
      "type": "string",
      "example": "8SFHRTGHAAAiAAAAAiAiAiiAii==",
      "description": "The survey's ID"
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-02-01T12:34:12.660Z",
      "description": "The webinar's start time."
    },
    "webinar_id": {
      "type": "integer",
      "format": "int64",
      "example": 123456,
      "description": "The webinar ID."
    },
    "survey_name": {
      "type": "string",
      "example": "Survey of this meeting",
      "description": "The name of survey"
    },
    "webinar_uuid": {
      "type": "string",
      "example": "4444AAAiAAAAAiAiAiiAii==",
      "description": "The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."
    },
    "survey_answers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "Jill Chill",
            "description": "The participant's display name. **Allow participants to answer questions anonymously** setting is enabled for a [survey](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057559), the participant's survey information is kept anonymous and the `name` field will return the &quot;Anonymous Attendee&quot; value."
          },
          "email": {
            "type": "string",
            "format": "email",
            "example": "jchill@example.com",
            "description": "The participant's email address."
          },
          "last_name": {
            "type": "string",
            "example": "Chill",
            "description": "The participant's last name. If the **Allow participants to answer questions anonymously** setting is enabled for a [survey](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057559), the participant's survey information is kept anonymous and the `last_name` field will return the &quot;Anonymous Attendee&quot; value."
          },
          "first_name": {
            "type": "string",
            "example": "Jill",
            "description": "The participant's first name. If the **Allow participants to answer questions anonymously** setting is enabled for a [survey](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057559), the participant's survey information is kept anonymous and the `first_name` field will return the &quot;Anonymous Attendee&quot; value."
          },
          "answer_details": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "answer": {
                  "type": "string",
                  "example": "I am wonderful.",
                  "description": "The user's given answer."
                },
                "question": {
                  "type": "string",
                  "example": "How are you?",
                  "description": "The survey question."
                },
                "date_time": {
                  "type": "string",
                  "example": "2022-02-01T12:37:12.660Z",
                  "description": "The date and time at which the user answered the survey question."
                },
                "question_id": {
                  "type": "string",
                  "example": "798fGJEWrA",
                  "description": "The question's ID"
                }
              }
            },
            "description": "Information about the user's questions and answers."
          }
        }
      },
      "description": "Information about the survey questions and answers."
    }
  }
}

object ReportsListSignInSignOutActivitiesResponse

{
  "type": "object",
  "properties": {
    "to": {
      "type": "string",
      "example": "2019-09-20T00:00:00Z",
      "description": "End date until which you want the activity logs report to be generated"
    },
    "from": {
      "type": "string",
      "example": "2019-09-01T00:00:00Z",
      "description": "Start date from which you want the activity logs report to be generated."
    },
    "page_size": {
      "type": "integer",
      "example": 30,
      "description": "The number of records returned with a single API call."
    },
    "activity_logs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "time": {
            "type": "string",
            "format": "date-time",
            "example": "2019-09-15T19:13:41Z",
            "description": "Time during which the activity occurred."
          },
          "type": {
            "enum": [
              "Sign in",
              "Sign out"
            ],
            "type": "string",
            "example": "Sign out",
            "description": "The type of activity. \n* `Sign in` &mdash; Sign in activity by user. \n* `Sign out` &mdash; Sign out activity by user."
          },
          "email": {
            "type": "string",
            "format": "email",
            "example": "jchill@example.com",
            "description": "Email address of the user used for the activity."
          },
          "version": {
            "type": "string",
            "example": "5.9.1.2581",
            "description": "Zoom client version of the user."
          },
          "ip_address": {
            "type": "string",
            "example": "192.0.2.1",
            "description": "The IP address of the user's device."
          },
          "client_type": {
            "type": "string",
            "example": "Browser",
            "description": "The client interface type using which the activity was performed."
          }
        }
      },
      "description": "Array of activity logs."
    },
    "next_page_token": {
      "type": "string",
      "example": "b43YBRLJFg3V4vsSpxvGdKIGtNbxn9h9If2",
      "description": "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."
    }
  },
  "description": "Report object"
}

object ReportsListUpcomingEventsReportResponse

{
  "type": "object",
  "properties": {
    "to": {
      "type": "string",
      "format": "date",
      "example": "2022-03-25",
      "description": "The report's end date. This value must be within the past six months and cannot exceed a month from the `from` value."
    },
    "from": {
      "type": "string",
      "format": "date",
      "example": "2022-03-01",
      "description": "The report's start date. This value must be within the past six months."
    },
    "page_size": {
      "type": "integer",
      "default": 30,
      "example": 30,
      "maximum": 300,
      "description": "The number of records returned in a single API call."
    },
    "next_page_token": {
      "type": "string",
      "example": "b43YBRLJFg3V4vsSpxvGdKIGtNbxn9h9If2",
      "description": "The next page token is used to paginate through large result sets. A next page token returns when the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
    },
    "upcoming_events": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "vawMH9zAQLytjCnQiQXSUg==",
            "description": "The event's unique ID."
          },
          "dept": {
            "type": "string",
            "example": "HR",
            "description": "The event host's department."
          },
          "topic": {
            "type": "string",
            "example": "My Meeting",
            "description": "The event's topic."
          },
          "host_id": {
            "type": "string",
            "example": "Or4-ZeV_SHCOfWRC71O1Fg",
            "description": "The event host's ID."
          },
          "host_name": {
            "type": "string",
            "example": "chi chi",
            "description": "The event host's name."
          },
          "start_time": {
            "type": "string",
            "example": "2022-03-15T07:40:46Z",
            "description": "The event's start time."
          }
        }
      },
      "description": "Information about the upcoming event."
    }
  }
}

object ReportsWebinarParticipantsListResponse

{
  "type": "object",
  "properties": {
    "page_size": {
      "type": "integer",
      "default": 30,
      "example": 30,
      "maximum": 300,
      "description": "The number of records returned within a single API call."
    },
    "page_count": {
      "type": "integer",
      "example": 1,
      "description": "The number of pages returned for the request made."
    },
    "participants": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "ABCDEF123456",
            "description": "The participant's universally unique ID (UUID). \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](https://developers.zoom.us) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value. \n\n**Note:** Use the `participant_user_id` value instead of this value. We will remove this response in a future release."
          },
          "name": {
            "type": "string",
            "example": "jchill",
            "description": "The participant's display name. This returns an empty string value if the account calling the API is a BAA account."
          },
          "status": {
            "enum": [
              "in_meeting",
              "in_waiting_room"
            ],
            "type": "string",
            "example": "in_meeting",
            "description": "The participant's status. \n* `in_meeting` - In a meeting. \n* `in_waiting_room` - In a waiting room."
          },
          "user_id": {
            "type": "string",
            "example": "ABCDEF123456",
            "description": "The participant's ID. This ID is assigned to the participant upon joining the webinar and is only valid for that webinar."
          },
          "duration": {
            "type": "integer",
            "example": 20,
            "description": "The participant's attendance duration."
          },
          "failover": {
            "type": "boolean",
            "example": false,
            "description": "Whether failover occurred during the webinar."
          },
          "join_time": {
            "type": "string",
            "format": "date-time",
            "example": "2019-02-01T12:34:12.660Z",
            "description": "The participant's join time."
          },
          "leave_time": {
            "type": "string",
            "format": "date-time",
            "example": "2019-02-01T12:54:12.660Z",
            "description": "The participant's leave time."
          },
          "user_email": {
            "type": "string",
            "example": "jchill@example.com",
            "pattern": "(^\\s*$|^[A-Za-z0-9!#$%&''*+/=?^_`{|}~-]+(\\.[A-Za-z0-9!#$%&''*+/=?^_`{|}~-]+)*@[A-Za-z0-9-]+(\\.[A-Za-z0-9-]+)*(\\.[A-Za-z]{2,})$)",
            "description": "The participant's email address. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us) for details. This returns an empty string value if the account calling the API is a BAA account."
          },
          "customer_key": {
            "type": "string",
            "example": "349589LkJyeW",
            "maxLength": 35,
            "description": "The participant's SDK identifier. This value can be alphanumeric, up to a maximum length of 35 characters."
          },
          "registrant_id": {
            "type": "string",
            "example": "123456FEDCBA",
            "description": "The registrant's ID. This field only returns if you provide the `registrant_id` value for the `include_fields` query parameter."
          },
          "participant_user_id": {
            "type": "string",
            "example": "DYHrdpjrS3uaOf7dPkkg8w",
            "description": "The participant's universally unique ID (UUID). \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](https://developers.zoom.us) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value."
          }
        }
      },
      "description": "Information about the webinar participant."
    },
    "total_records": {
      "type": "integer",
      "example": 1,
      "description": "The number of all records available across pages."
    },
    "next_page_token": {
      "type": "string",
      "example": "Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3",
      "description": "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."
    }
  },
  "description": "Pagination object."
}

object SipPhoneEnableUserSipPhoneRequest

{
  "type": "object",
  "required": [
    "authorization_name",
    "domain",
    "password",
    "proxy_server",
    "register_server",
    "user_email",
    "user_name",
    "voice_mail"
  ],
  "properties": {
    "domain": {
      "type": "string",
      "example": "example.com",
      "maxLength": 64,
      "description": "The name or IP address of your provider's SIP domain (example: CDC.WEB). "
    },
    "password": {
      "type": "string",
      "example": "123456",
      "description": "The password generated for the user in the SIP account."
    },
    "user_name": {
      "type": "string",
      "example": "Jill Chill",
      "maxLength": 64,
      "description": "The phone number associated with the user in the SIP account."
    },
    "user_email": {
      "type": "string",
      "format": "email",
      "example": "jchill@example.com",
      "maxLength": 64,
      "description": "The email address of the user to associate with the SIP Phone. Can add `.win`, `.mac`, `.android`, `.ipad`, `.iphone`, `.linux`, `.pc`, `.mobile`, `.pad` at the end of the email (for example, `user@example.com.mac`) to add accounts for different platforms for the same user."
    },
    "voice_mail": {
      "type": "string",
      "example": "4000",
      "maxLength": 255,
      "description": "The number to dial for checking voicemail."
    },
    "proxy_server": {
      "type": "string",
      "example": "192.0.2.2",
      "description": "The IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server."
    },
    "proxy_server2": {
      "type": "string",
      "example": "192.0.2.4",
      "description": "The IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server, or empty."
    },
    "proxy_server3": {
      "type": "string",
      "example": "192.0.2.6",
      "description": "The IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server, or empty."
    },
    "register_server": {
      "type": "string",
      "example": "192.0.2.1",
      "description": "The IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address."
    },
    "register_server2": {
      "type": "string",
      "example": "192.0.2.3",
      "description": "The IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address."
    },
    "register_server3": {
      "type": "string",
      "example": "192.0.2.5",
      "description": "The IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address."
    },
    "authorization_name": {
      "type": "string",
      "example": "testname",
      "maxLength": 64,
      "description": "The authorization name of the user that is registered for SIP phone."
    },
    "transport_protocol": {
      "enum": [
        "UDP",
        "TCP",
        "TLS",
        "AUTO"
      ],
      "type": "string",
      "example": "UDP",
      "description": "Protocols supported by the SIP provider.  \n  The value must be either `UDP`, `TCP`, `TLS`, `AUTO`."
    },
    "transport_protocol2": {
      "enum": [
        "UDP",
        "TCP",
        "TLS",
        "AUTO"
      ],
      "type": "string",
      "example": "UDP",
      "description": "Protocols supported by the SIP provider.  \n  The value must be either `UDP`, `TCP`, `TLS`, `AUTO`."
    },
    "transport_protocol3": {
      "enum": [
        "UDP",
        "TCP",
        "TLS",
        "AUTO"
      ],
      "type": "string",
      "example": "UDP",
      "description": "Protocols supported by the SIP provider.  \n  The value must be either `UDP`, `TCP`, `TLS`, `AUTO`."
    },
    "registration_expire_time": {
      "type": "integer",
      "default": 60,
      "example": 60,
      "maximum": 127,
      "minimum": 1,
      "description": "The number of minutes after which the SIP registration of the Zoom client user will expire, and the client will auto register to the SIP server."
    }
  }
}

object SipPhoneEnableUserSipPhoneResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "123456",
      "description": "The SIP phone ID."
    },
    "domain": {
      "type": "string",
      "example": "example.com",
      "maxLength": 64,
      "description": "The name or IP address of your provider's SIP domain (example: CDC.WEB). "
    },
    "password": {
      "type": "string",
      "example": "123456",
      "description": "The password generated for the user in the SIP account."
    },
    "user_name": {
      "type": "string",
      "example": "Jill Chill",
      "maxLength": 64,
      "description": "The phone number associated with the user in the SIP account."
    },
    "user_email": {
      "type": "string",
      "format": "email",
      "example": "jchill@example.com",
      "maxLength": 64,
      "description": "The email address of the user to associate with the SIP Phone. Can add `.win`, `.mac`, `.android`, `.ipad`, `.iphone`, `.linux`, `.pc`, `.mobile`, `.pad` at the end of the email (for example, `user@example.com.mac`) to add accounts for different platforms for the same user."
    },
    "voice_mail": {
      "type": "string",
      "example": "4000",
      "maxLength": 255,
      "description": "The number to dial for checking voicemail."
    },
    "proxy_server": {
      "type": "string",
      "example": "192.0.2.2",
      "description": "The IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server."
    },
    "proxy_server2": {
      "type": "string",
      "example": "192.0.2.4",
      "description": "The IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server, or empty."
    },
    "proxy_server3": {
      "type": "string",
      "example": "192.0.2.6",
      "description": "The IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server, or empty."
    },
    "register_server": {
      "type": "string",
      "example": "192.0.2.1",
      "description": "The IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address."
    },
    "register_server2": {
      "type": "string",
      "example": "192.0.2.3",
      "description": "The IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address."
    },
    "register_server3": {
      "type": "string",
      "example": "192.0.2.5",
      "description": "The IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address."
    },
    "authorization_name": {
      "type": "string",
      "example": "testname",
      "maxLength": 64,
      "description": "The authorization name of the user that is registered for SIP phone."
    },
    "transport_protocol": {
      "enum": [
        "UDP",
        "TCP",
        "TLS",
        "AUTO"
      ],
      "type": "string",
      "example": "UDP",
      "description": "Protocols supported by the SIP provider.  \n  The value must be either `UDP`, `TCP`, `TLS`, `AUTO`."
    },
    "transport_protocol2": {
      "enum": [
        "UDP",
        "TCP",
        "TLS",
        "AUTO"
      ],
      "type": "string",
      "example": "UDP",
      "description": "Protocols supported by the SIP provider.  \n  The value must be either `UDP`, `TCP`, `TLS`, `AUTO`."
    },
    "transport_protocol3": {
      "enum": [
        "UDP",
        "TCP",
        "TLS",
        "AUTO"
      ],
      "type": "string",
      "example": "UDP",
      "description": "Protocols supported by the SIP provider.  \n  The value must be either `UDP`, `TCP`, `TLS`, `AUTO`."
    },
    "registration_expire_time": {
      "type": "integer",
      "default": 60,
      "example": 60,
      "maximum": 127,
      "minimum": 1,
      "description": "The number of minutes after which the SIP registration of the Zoom client user will expire, and the client will auto register to the SIP server."
    }
  }
}

object SipPhoneListResponse

{
  "type": "object",
  "properties": {
    "phones": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "123456",
            "description": "The SIP phone ID."
          },
          "domain": {
            "type": "string",
            "example": "example.com",
            "description": "The name or IP address of your provider's SIP domain."
          },
          "password": {
            "type": "string",
            "example": "apassword1",
            "description": "The password generated for the user in the SIP account.\n"
          },
          "user_name": {
            "type": "string",
            "example": "Jill Chill",
            "description": "The phone number associated with the user in the SIP account. "
          },
          "user_email": {
            "type": "string",
            "format": "email",
            "example": "jchill@example.com",
            "description": "The email address of the user to associate with the SIP Phone. Can add `.win`, `.mac`, `.android`, `.ipad`, `.iphone`, `.linux`, `.pc`, `.mobile`, `.pad` at the end of the email (for example, `user@example.com.mac`) to add accounts for different platforms for the same user."
          },
          "voice_mail": {
            "type": "string",
            "example": "4000",
            "description": "The number to dial for checking voicemail."
          },
          "proxy_server": {
            "type": "string",
            "example": "192.0.2.2",
            "description": "The IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server, or empty."
          },
          "proxy_server2": {
            "type": "string",
            "example": "192.0.2.4",
            "description": "The IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server, or empty."
          },
          "proxy_server3": {
            "type": "string",
            "example": "192.0.2.6",
            "description": "The IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server, or empty."
          },
          "register_server": {
            "type": "string",
            "example": "192.0.2.1",
            "description": "The IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address."
          },
          "register_server2": {
            "type": "string",
            "example": "192.0.2.3",
            "description": "The IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address."
          },
          "register_server3": {
            "type": "string",
            "example": "192.0.2.5",
            "description": "The IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address."
          },
          "authorization_name": {
            "type": "string",
            "example": "testname",
            "description": "The authorization name of the user that is registered for SIP phone."
          },
          "transport_protocol": {
            "enum": [
              "UDP",
              "TCP",
              "TLS",
              "AUTO"
            ],
            "type": "string",
            "example": "UDP",
            "description": "Protocols supported by the SIP provider.  \n  The value must be either `UDP`, `TCP`, `TLS`, `AUTO`."
          },
          "transport_protocol2": {
            "enum": [
              "UDP",
              "TCP",
              "TLS",
              "AUTO"
            ],
            "type": "string",
            "example": "UDP",
            "description": "Protocols supported by the SIP provider.  \n  The value must be either `UDP`, `TCP`, `TLS`, `AUTO`."
          },
          "transport_protocol3": {
            "enum": [
              "UDP",
              "TCP",
              "TLS",
              "AUTO"
            ],
            "type": "string",
            "example": "UDP",
            "description": "Protocols supported by the SIP provider.  \n  The value must be either `UDP`, `TCP`, `TLS`, `AUTO`."
          },
          "registration_expire_time": {
            "type": "integer",
            "example": 60,
            "description": "The number of minutes after which the SIP registration of the Zoom client user will expire, and the client will auto register to the SIP server. "
          }
        }
      },
      "description": "SIP phones object."
    },
    "page_size": {
      "type": "integer",
      "example": 30,
      "description": "The number of records returned within a single API call."
    },
    "page_count": {
      "type": "integer",
      "example": 1,
      "description": "The number of pages returned for the request made."
    },
    "page_number": {
      "type": "integer",
      "example": 1,
      "description": "The page number of the current results."
    },
    "total_records": {
      "type": "integer",
      "example": 20,
      "description": "The total number of all the records available across pages."
    },
    "next_page_token": {
      "type": "string",
      "example": "Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3"
    }
  }
}

object SipPhoneUpdateSpecificPhoneRequest

{
  "type": "object",
  "required": [
    "authorization_name",
    "domain",
    "password",
    "proxy_server",
    "proxy_server2",
    "proxy_server3",
    "register_server",
    "register_server2",
    "register_server3",
    "user_name",
    "voice_mail"
  ],
  "properties": {
    "domain": {
      "type": "string",
      "example": "example.com",
      "maxLength": 64,
      "description": "The name or IP address of your provider's SIP domain (example: CDC.WEB). "
    },
    "password": {
      "type": "string",
      "example": "123456",
      "description": "The password generated for the user in the SIP account."
    },
    "user_name": {
      "type": "string",
      "example": "Jill Chill",
      "maxLength": 64,
      "description": "The phone number associated with the user in the SIP account."
    },
    "voice_mail": {
      "type": "string",
      "example": "4000",
      "maxLength": 255,
      "description": "The number to dial for checking voicemail."
    },
    "proxy_server": {
      "type": "string",
      "example": "192.0.2.2",
      "description": "The IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server."
    },
    "proxy_server2": {
      "type": "string",
      "example": "192.0.2.4",
      "description": "The IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server."
    },
    "proxy_server3": {
      "type": "string",
      "example": "192.0.2.6",
      "description": "The IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server."
    },
    "register_server": {
      "type": "string",
      "example": "192.0.2.1",
      "description": "The IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address."
    },
    "register_server2": {
      "type": "string",
      "example": "192.0.2.3",
      "description": "The IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address."
    },
    "register_server3": {
      "type": "string",
      "example": "192.0.2.5",
      "description": "The IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address."
    },
    "authorization_name": {
      "type": "string",
      "example": "testname",
      "maxLength": 64,
      "description": "The authorization name of the user that is registered for SIP phone."
    },
    "transport_protocol": {
      "enum": [
        "UDP",
        "TCP",
        "TLS",
        "AUTO"
      ],
      "type": "string",
      "example": "UDP",
      "description": "Protocols supported by the SIP provider.  \n  The value must be either `UDP`, `TCP`, `TLS`, `AUTO`."
    },
    "transport_protocol2": {
      "enum": [
        "UDP",
        "TCP",
        "TLS",
        "AUTO"
      ],
      "type": "string",
      "example": "UDP",
      "description": "Protocols supported by the SIP provider.  \n  The value must be either `UDP`, `TCP`, `TLS`, `AUTO`."
    },
    "transport_protocol3": {
      "enum": [
        "UDP",
        "TCP",
        "TLS",
        "AUTO"
      ],
      "type": "string",
      "example": "UDP",
      "description": "Protocols supported by the SIP provider.  \n  The value must be either `UDP`, `TCP`, `TLS`, `AUTO`."
    },
    "registration_expire_time": {
      "type": "integer",
      "default": 60,
      "example": 60,
      "maximum": 127,
      "minimum": 1,
      "description": "The number of minutes after which the SIP registration of the Zoom client user will expire, and the client will auto register to the SIP server."
    }
  }
}

object TrackingFieldCreateFieldRequest

{
  "type": "object",
  "title": "Tracking Field",
  "properties": {
    "field": {
      "type": "string",
      "example": "field1",
      "description": "Label/ Name for the tracking field."
    },
    "visible": {
      "type": "boolean",
      "example": true,
      "description": "Tracking Field Visible"
    },
    "required": {
      "type": "boolean",
      "example": false,
      "description": "Tracking Field Required"
    },
    "recommended_values": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "value1"
      },
      "description": "Array of recommended values"
    }
  },
  "description": "Tracking Field"
}

object TrackingFieldCreateFieldResponse

{
  "type": "object",
  "title": "Tracking Field",
  "properties": {
    "id": {
      "type": "string",
      "example": "a32CJji-weJ92",
      "description": "Tracking Field ID"
    },
    "field": {
      "type": "string",
      "example": "field1",
      "description": "Label/ Name for the tracking field."
    },
    "visible": {
      "type": "boolean",
      "example": true,
      "description": "Tracking Field Visible"
    },
    "required": {
      "type": "boolean",
      "example": false,
      "description": "Tracking Field Required"
    },
    "recommended_values": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "value1"
      },
      "description": "Array of recommended values"
    }
  },
  "description": "Tracking Field"
}

object TrackingFieldGetResponse

{
  "type": "object",
  "title": "Tracking Field",
  "properties": {
    "id": {
      "type": "string",
      "example": "a32CJji-weJ92",
      "description": "Tracking Field ID"
    },
    "field": {
      "type": "string",
      "example": "field1",
      "description": "Label/ Name for the tracking field."
    },
    "visible": {
      "type": "boolean",
      "example": true,
      "description": "Tracking Field Visible"
    },
    "required": {
      "type": "boolean",
      "example": false,
      "description": "Tracking Field Required"
    },
    "recommended_values": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "value1"
      },
      "description": "Array of recommended values"
    }
  },
  "description": "Tracking Field"
}

object TrackingFieldListResponse

{
  "type": "object",
  "properties": {
    "total_records": {
      "type": "integer",
      "example": 1,
      "description": "The number of all records available across pages"
    },
    "tracking_fields": {
      "type": "array",
      "items": {
        "type": "object",
        "title": "Tracking Field",
        "properties": {
          "id": {
            "type": "string",
            "example": "a32CJji-weJ92",
            "description": "ID of Tracking Field"
          },
          "field": {
            "type": "string",
            "example": "field1",
            "description": "Label/ Name for the tracking field."
          },
          "visible": {
            "type": "boolean",
            "example": true,
            "description": "Tracking Field Visible"
          },
          "required": {
            "type": "boolean",
            "example": false,
            "description": "Tracking Field Required"
          },
          "recommended_values": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "value1"
            },
            "description": "Array of recommended values"
          }
        },
        "description": "Tracking Field"
      },
      "description": "Array of Tracking Fields"
    }
  },
  "description": "Tracking Field List"
}

object TrackingFieldUpdateRequest

{
  "type": "object",
  "title": "Tracking Field",
  "properties": {
    "field": {
      "type": "string",
      "example": "field1",
      "description": "Label/ Name for the tracking field."
    },
    "visible": {
      "type": "boolean",
      "example": true,
      "description": "Tracking Field Visible"
    },
    "required": {
      "type": "boolean",
      "example": false,
      "description": "Tracking Field Required"
    },
    "recommended_values": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "value1"
      },
      "description": "Array of recommended values"
    }
  },
  "description": "Tracking Field"
}

object TspAddUserTspAccountRequest

{
  "type": "object",
  "title": "TSP Accounts List",
  "required": [
    "conference_code",
    "leader_pin"
  ],
  "properties": {
    "leader_pin": {
      "type": "string",
      "example": "US_TSP_TB",
      "maxLength": 16,
      "minLength": 1,
      "description": "Leader PIN: numeric value, length is less than 16."
    },
    "tsp_bridge": {
      "enum": [
        "US_TSP_TB",
        "EU_TSP_TB"
      ],
      "type": "string",
      "example": "US_TSP_TB",
      "description": "Telephony bridge"
    },
    "conference_code": {
      "type": "string",
      "example": "0125",
      "maxLength": 16,
      "minLength": 1,
      "description": "Conference code: numeric value, length is less than 16."
    },
    "dial_in_numbers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "example": "1",
            "maxLength": 6,
            "description": "Country code."
          },
          "type": {
            "enum": [
              "toll",
              "tollfree",
              "media_link"
            ],
            "type": "string",
            "example": "toll",
            "extensions": {
              "x-enum-descriptions": [
                "Toll number <br/>",
                "Toll free number <br/>",
                "Media link phone number <br/>"
              ]
            },
            "description": "Dial-in number types:  \n `toll` - Toll number.  \n `tollfree` -Toll free number.  \n \n`media_link` - Media link."
          },
          "number": {
            "type": "string",
            "example": "+1 1000200200",
            "maxLength": 16,
            "minLength": 1,
            "description": "Dial-in number: length is less than 16."
          },
          "country_label": {
            "type": "string",
            "example": "America",
            "maxLength": 10,
            "description": "Country Label, if passed, will display in place of code."
          }
        }
      },
      "description": "List of dial in numbers."
    }
  },
  "description": "List of TSP accounts."
}

object TspAddUserTspAccountResponse

{
  "type": "object",
  "title": "TSP Accounts List",
  "required": [
    "conference_code",
    "leader_pin"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "1",
      "description": "The ID of the TSP account."
    },
    "leader_pin": {
      "type": "string",
      "example": "US_TSP_TB",
      "maxLength": 16,
      "minLength": 1,
      "description": "Leader PIN: numeric value, length is less than 16."
    },
    "tsp_bridge": {
      "enum": [
        "US_TSP_TB",
        "EU_TSP_TB"
      ],
      "type": "string",
      "example": "US_TSP_TB",
      "description": "Telephony bridge"
    },
    "conference_code": {
      "type": "string",
      "example": "0125",
      "maxLength": 16,
      "minLength": 1,
      "description": "Conference code: numeric value, length is less than 16."
    },
    "dial_in_numbers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "example": "1",
            "maxLength": 6,
            "description": "Country code."
          },
          "type": {
            "enum": [
              "toll",
              "tollfree",
              "media_link"
            ],
            "type": "string",
            "example": "toll",
            "extensions": {
              "x-enum-descriptions": [
                "Toll number <br/>",
                "Toll free number <br/>",
                "Media link phone number <br/>"
              ]
            },
            "description": "Dial-in number types:  \n `toll` - Toll number.  \n `tollfree` -Toll free number.  \n \n`media_link` - Media link."
          },
          "number": {
            "type": "string",
            "example": "+1 1000200200",
            "maxLength": 16,
            "minLength": 1,
            "description": "Dial-in number: length is less than 16."
          },
          "country_label": {
            "type": "string",
            "example": "America",
            "maxLength": 10,
            "description": "Country Label, if passed, will display in place of code."
          }
        }
      },
      "description": "List of dial in numbers."
    }
  },
  "description": "List of TSP accounts."
}

object TspGetAccountInfoResponse

{
  "type": "object",
  "properties": {
    "enable": {
      "type": "boolean",
      "example": true,
      "description": "Enable Telephony Service Provider for account users."
    },
    "tsp_bridge": {
      "enum": [
        "US_TSP_TB",
        "EU_TSP_TB"
      ],
      "type": "string",
      "example": "US_TSP_TB",
      "description": "Telephony bridge zone"
    },
    "tsp_enabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable TSP feature for account. This has to be enabled to use any other tsp settings/features."
    },
    "tsp_provider": {
      "type": "string",
      "example": "someprovidername",
      "description": "Telephony Service Provider."
    },
    "dial_in_numbers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "example": "1",
            "description": "Country Code"
          },
          "type": {
            "type": "string",
            "example": "toll",
            "description": "Dial-in number type."
          },
          "number": {
            "type": "string",
            "example": "+1 1000200200",
            "maxLength": 16,
            "description": "Dial-in number, length is less than 16"
          }
        }
      }
    },
    "dial_in_number_unrestricted": {
      "type": "boolean",
      "example": false,
      "description": "Control restriction on account users adding a TSP number outside of account's dial in numbers."
    },
    "modify_credential_forbidden": {
      "type": "boolean",
      "example": true,
      "description": "Control restriction on account users being able to modify their TSP credentials."
    },
    "master_account_setting_extended": {
      "type": "boolean",
      "example": true,
      "description": "For master account, extend its TSP setting to all sub accounts. For sub account, extend TSP setting from master account."
    }
  }
}

object TspGetUserTspAccountResponse

{
  "type": "object",
  "title": "TSP Account",
  "required": [
    "conference_code",
    "leader_pin"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "1",
      "description": "The TSP account ID."
    },
    "leader_pin": {
      "type": "string",
      "example": "11189898",
      "maxLength": 16,
      "minLength": 1,
      "description": "Leader PIN: numeric value, length is less than 16."
    },
    "tsp_bridge": {
      "enum": [
        "US_TSP_TB",
        "EU_TSP_TB"
      ],
      "type": "string",
      "example": "US_TSP_TB",
      "description": "Telephony bridge"
    },
    "conference_code": {
      "type": "string",
      "example": "0125",
      "maxLength": 16,
      "minLength": 1,
      "description": "Conference code: numeric value, length is less than 16."
    },
    "dial_in_numbers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "example": "1",
            "maxLength": 6,
            "description": "Country code."
          },
          "type": {
            "enum": [
              "toll",
              "tollfree",
              "media_link"
            ],
            "type": "string",
            "example": "toll",
            "extensions": {
              "x-enum-descriptions": [
                "Toll number <br/>",
                "Toll free number <br/>",
                "Media link phone number <br/>"
              ]
            },
            "description": "Dial-in number types:  \n `toll` - Toll number.  \n `tollfree` -Toll free number.   \n  `media_link` - Media link phone number. This is used for PSTN integration instead of a paid bridge number."
          },
          "number": {
            "type": "string",
            "example": "+1 1000200200",
            "maxLength": 16,
            "minLength": 1,
            "description": "Dial-in number: length is less than 16."
          },
          "country_label": {
            "type": "string",
            "example": "America",
            "maxLength": 10,
            "description": "Country Label, if passed, will display in place of code."
          }
        }
      },
      "description": "List of dial in numbers."
    }
  },
  "description": "TSP account of the user."
}

object TspListUserTspAccountsResponse

{
  "type": "object",
  "properties": {
    "tsp_accounts": {
      "type": "array",
      "items": {
        "type": "object",
        "title": "TSP Accounts List",
        "required": [
          "conference_code",
          "leader_pin"
        ],
        "properties": {
          "id": {
            "enum": [
              "1",
              "2"
            ],
            "type": "string",
            "example": "1",
            "description": "The TSP credential ID."
          },
          "leader_pin": {
            "type": "string",
            "example": "11189898",
            "maxLength": 16,
            "minLength": 1,
            "description": "Leader PIN: numeric value, length is less than 16."
          },
          "tsp_bridge": {
            "enum": [
              "US_TSP_TB",
              "EU_TSP_TB"
            ],
            "type": "string",
            "example": "US_TSP_TB",
            "description": "Telephony bridge\n"
          },
          "conference_code": {
            "type": "string",
            "example": "0125",
            "maxLength": 16,
            "minLength": 1,
            "description": "Conference code: numeric value, length is less than 16."
          },
          "dial_in_numbers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "code": {
                  "type": "string",
                  "example": "1",
                  "maxLength": 6,
                  "description": "Country code."
                },
                "type": {
                  "enum": [
                    "toll",
                    "tollfree",
                    "media_link"
                  ],
                  "type": "string",
                  "example": "toll",
                  "extensions": {
                    "x-enum-descriptions": [
                      "Toll number <br/>",
                      "Toll free number <br/>",
                      "Media link phone number <br/>"
                    ]
                  },
                  "description": "Dial-in number types:  \n `toll` - Toll number.  \n `tollfree` -Toll free number.  \n \n`media_link` - Media link"
                },
                "number": {
                  "type": "string",
                  "example": "+1 1000200200",
                  "maxLength": 16,
                  "minLength": 1,
                  "description": "Dial-in number: length is less than 16."
                },
                "country_label": {
                  "type": "string",
                  "example": "America",
                  "maxLength": 10,
                  "description": "Country Label, if passed, will display in place of code."
                }
              }
            },
            "description": "List of dial in numbers."
          }
        },
        "description": "List of TSP accounts."
      }
    }
  }
}

object TspSetGlobalDialInUrlRequest

{
  "type": "object",
  "title": "TSP Global Dial-In URL Setting",
  "properties": {
    "audio_url": {
      "type": "string",
      "example": "https://example.com",
      "maxLength": 512,
      "description": "The global dial-in URL for a TSP enabled account. The URL must be valid with a max-length of 512 characters."
    }
  }
}

object TspUpdateAccountTspInformationRequest

{
  "type": "object",
  "properties": {
    "enable": {
      "type": "boolean",
      "example": true,
      "description": "Enable 3rd party audio conferencing for account users"
    },
    "tsp_bridge": {
      "enum": [
        "US_TSP_TB",
        "EU_TSP_TB"
      ],
      "type": "string",
      "example": "US_TSP_TB",
      "description": "Telephony bridge"
    },
    "tsp_enabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable TSP feature for account. This has to be enabled to use any other tsp settings/features."
    },
    "tsp_provider": {
      "type": "string",
      "example": "someprovidername",
      "description": "3rd party audio conferencing provider"
    },
    "dial_in_number_unrestricted": {
      "type": "boolean",
      "example": true,
      "description": "Control restriction on account users adding a TSP number outside of account's dial in numbers."
    },
    "modify_credential_forbidden": {
      "type": "boolean",
      "example": true,
      "description": "Control restriction on account users being able to modify their TSP credentials."
    },
    "master_account_setting_extended": {
      "type": "boolean",
      "example": true,
      "description": "For master account, extend its TSP setting to all sub accounts. For sub account, extend TSP setting from master account."
    }
  }
}

object TspUpdateUserTspAccountRequest

{
  "type": "object",
  "title": "TSP Account",
  "required": [
    "conference_code",
    "leader_pin"
  ],
  "properties": {
    "leader_pin": {
      "type": "string",
      "example": "11189898",
      "maxLength": 16,
      "minLength": 1,
      "description": "Leader PIN: numeric value, length is less than 16."
    },
    "tsp_bridge": {
      "enum": [
        "US_TSP_TB",
        "EU_TSP_TB"
      ],
      "type": "string",
      "example": "US_TSP_TB",
      "description": "Telephony bridge"
    },
    "conference_code": {
      "type": "string",
      "example": "0125",
      "maxLength": 16,
      "minLength": 1,
      "description": "Conference code: numeric value, length is less than 16."
    },
    "dial_in_numbers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "example": "1",
            "maxLength": 6,
            "description": "Country code."
          },
          "type": {
            "enum": [
              "toll",
              "tollfree",
              "media_link"
            ],
            "type": "string",
            "example": "toll",
            "extensions": {
              "x-enum-descriptions": [
                "Toll number <br/>",
                "Toll free number <br/>",
                "Media link phone number <br/>"
              ]
            },
            "description": "Dial-in number types:  \n `toll` - Toll number.  \n `tollfree` -Toll free number.  \n `media_link` - Media Link Phone Number. It is used for PSTN integration instead of paid bridge number."
          },
          "number": {
            "type": "string",
            "example": "+1 1000200200",
            "maxLength": 16,
            "minLength": 1,
            "description": "Dial-in number: length is less than 16."
          },
          "country_label": {
            "type": "string",
            "example": "America",
            "maxLength": 10,
            "description": "Country Label, if passed, will display in place of code."
          }
        }
      },
      "description": "List of dial in numbers."
    }
  },
  "description": "TSP account."
}

object WebinarsAddPanelistsRequest

{
  "type": "object",
  "properties": {
    "panelists": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "Jill Chill",
            "description": "The panelist's full name.\n\n**Note:** This value cannot exceed more than 12 Chinese characters."
          },
          "email": {
            "type": "string",
            "format": "email",
            "example": "jchill@example.com",
            "description": "Panelist's email. See the [email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for return value details."
          },
          "name_tag_id": {
            "type": "string",
            "example": "xHhPyb8ERMCmiC5njPjFdQ",
            "description": "The name tag ID to bind."
          },
          "name_tag_name": {
            "type": "string",
            "example": "xHhPyb8ERMCmiC5njPjFdQ",
            "description": "The panelist's name to display in the name tag."
          },
          "name_tag_pronouns": {
            "type": "string",
            "example": "pronouns",
            "description": "The pronouns to display in the name tag."
          },
          "name_tag_description": {
            "type": "string",
            "example": "description",
            "description": "The description for the name tag, such the person's title."
          },
          "virtual_background_id": {
            "type": "string",
            "example": "xHhPyb8ERMCmiC5njPjFdQ",
            "description": "The virtual background ID to bind."
          }
        },
        "description": "Panelist base object."
      },
      "maximum": 30,
      "description": "List of panelist objects."
    }
  },
  "description": "Webinar panelist."
}

object WebinarsAddPanelistsResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "95204914252",
      "description": "Webinar Id."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-26T07:30:16Z",
      "description": "The time when the panelist was added."
    }
  }
}

object WebinarsAddRegistrantRequest

{
  "type": "object",
  "required": [
    "email",
    "first_name"
  ],
  "properties": {
    "org": {
      "type": "string",
      "example": "Cooking Org",
      "description": "The registrant's organization."
    },
    "zip": {
      "type": "string",
      "example": "94045",
      "description": "The registrant's ZIP or postal code."
    },
    "city": {
      "type": "string",
      "example": "Mountain View",
      "description": "The registrant's city."
    },
    "email": {
      "type": "string",
      "format": "email",
      "example": "jchill@example.com",
      "maxLength": 128,
      "description": "The registrant's email address."
    },
    "phone": {
      "type": "string",
      "example": "5550100",
      "description": "The registrant's phone number."
    },
    "state": {
      "type": "string",
      "example": "CA",
      "description": "The registrant's state or province."
    },
    "address": {
      "type": "string",
      "example": "1800 Amphibious Blvd.",
      "description": "The registrant's address."
    },
    "country": {
      "type": "string",
      "example": "US",
      "description": "The registrant's two-letter [country code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries)."
    },
    "comments": {
      "type": "string",
      "example": "Looking forward to the discussion.",
      "description": "The registrant's questions and comments."
    },
    "industry": {
      "type": "string",
      "example": "Food",
      "description": "The registrant's industry."
    },
    "language": {
      "enum": [
        "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"
      ],
      "type": "string",
      "example": "en-US",
      "description": "The registrant's language preference for confirmation emails: \n* `en-US` - English (US) \n* `de-DE` - German (Germany) \n* `es-ES` - Spanish (Spain) \n* `fr-FR` - French (France) \n* `jp-JP` - Japanese \n* `pt-PT` - Portuguese (Portugal) \n* `ru-RU` - Russian \n* `zh-CN` - Chinese (PRC) \n* `zh-TW` - Chinese (Taiwan) \n* `ko-KO` - Korean \n* `it-IT` - Italian (Italy) \n* `vi-VN` - Vietnamese \n* `pl-PL` - Polish \n* `Tr-TR` - Turkish"
    },
    "job_title": {
      "type": "string",
      "example": "Chef",
      "description": "The registrant's job title."
    },
    "last_name": {
      "type": "string",
      "example": "Chill",
      "maxLength": 64,
      "description": "The registrant's last name."
    },
    "source_id": {
      "type": "string",
      "example": "4816766181770",
      "description": "The tracking source's unique identifier."
    },
    "first_name": {
      "type": "string",
      "example": "Jill",
      "maxLength": 64,
      "description": "The registrant's first name."
    },
    "no_of_employees": {
      "enum": [
        "",
        "1-20",
        "21-50",
        "51-100",
        "101-500",
        "500-1,000",
        "1,001-5,000",
        "5,001-10,000",
        "More than 10,000"
      ],
      "type": "string",
      "example": "1-20",
      "description": "The registrant's number of employees: \n* `1-20` \n* `21-50` \n* `51-100` \n* `101-500` \n* `500-1,000` \n* `1,001-5,000` \n* `5,001-10,000` \n* `More than 10,000`"
    },
    "custom_questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "example": "What do you hope to learn from this?",
            "description": "The custom question's title."
          },
          "value": {
            "type": "string",
            "example": "Look forward to learning how you come up with new recipes and what other services you offer.",
            "maxLength": 128,
            "description": "The custom question's response value. This has a limit of 128 characters."
          }
        },
        "description": "Information about custom questions."
      },
      "description": "Information about custom questions."
    },
    "purchasing_time_frame": {
      "enum": [
        "",
        "Within a month",
        "1-3 months",
        "4-6 months",
        "More than 6 months",
        "No timeframe"
      ],
      "type": "string",
      "example": "1-3 months",
      "description": "The registrant's purchasing time frame: \n* `Within a month` \n* `1-3 months` \n* `4-6 months` \n* `More than 6 months` \n* `No timeframe`"
    },
    "role_in_purchase_process": {
      "enum": [
        "",
        "Decision Maker",
        "Evaluator/Recommender",
        "Influencer",
        "Not involved"
      ],
      "type": "string",
      "example": "Influencer",
      "description": "The registrant's role in the purchase process: \n* `Decision Maker` \n* `Evaluator/Recommender` \n* `Influencer` \n* `Not involved`"
    }
  },
  "description": "Information about the webinar registrant."
}

object WebinarsAddRegistrantResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 92674392836,
      "description": "The webinar's ID."
    },
    "topic": {
      "type": "string",
      "example": "My Webinar",
      "maxLength": 200,
      "description": "The webinar's topic."
    },
    "join_url": {
      "type": "string",
      "example": "https://example.com/j/22222",
      "description": "The URL the registrant can use to join the webinar."
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2021-07-13T21:44:51Z",
      "description": "The webinar's start time."
    },
    "occurrences": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "example": "available",
            "description": "Occurrence status."
          },
          "duration": {
            "type": "integer",
            "example": 60,
            "description": "Duration."
          },
          "start_time": {
            "type": "string",
            "format": "date-time",
            "example": "2022-03-25T07:46:00Z",
            "description": "Start time."
          },
          "occurrence_id": {
            "type": "string",
            "example": "1648194360000",
            "description": "Occurrence ID: Unique identifier that identifies 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."
          }
        },
        "description": "Occurrence object. This object is only returned for recurring webinars."
      },
      "description": "Array of occurrence objects."
    },
    "registrant_id": {
      "type": "string",
      "example": "fdgsfh2ey82fuh",
      "description": "The registrant's ID."
    }
  }
}

object WebinarsCreateBatchRegistrantsRequest

{
  "type": "object",
  "properties": {
    "registrants": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "email",
          "first_name"
        ],
        "properties": {
          "email": {
            "type": "string",
            "format": "email",
            "example": "jchill@example.com",
            "description": "The registrant's email address."
          },
          "last_name": {
            "type": "string",
            "example": "Chill",
            "description": "The registrant's last name."
          },
          "first_name": {
            "type": "string",
            "example": "Jill",
            "description": "The registrant's first name."
          }
        }
      }
    },
    "auto_approve": {
      "type": "boolean",
      "example": true,
      "description": "If a meeting was scheduled with approval_type `1` (manual approval), but you want to automatically approve registrants added via this API, set the value of this field to `true`. \n\nYou **cannot** use this field to change approval setting for a meeting that was originally scheduled with approval_type `0` (automatic approval)."
    }
  }
}

object WebinarsCreateBatchRegistrantsResponse

{
  "type": "object",
  "properties": {
    "registrants": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "example": "jchill@example.com",
            "description": "The registrant's email address."
          },
          "join_url": {
            "type": "string",
            "example": "https://example.com/j/11111",
            "description": "Unique URL using which registrant can join the webinar."
          },
          "registrant_id": {
            "type": "string",
            "example": "-rOym-zdTHOdbT3A7u7u5g",
            "description": "The registrant's unique identifier."
          }
        }
      }
    }
  }
}

object WebinarsCreateBrandingNameTagRequest

{
  "type": "object",
  "required": [
    "accent_color",
    "background_color",
    "name",
    "text_color"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "name",
      "description": "The name tag's name.\n\n**Note:** This value cannot exceed more than 50 characters."
    },
    "is_default": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Whether set the name tag as the default name tag or not."
    },
    "text_color": {
      "type": "string",
      "format": "Hex color code",
      "example": "0e72ed",
      "description": "The name tag's text color."
    },
    "accent_color": {
      "type": "string",
      "format": "Hex color code",
      "example": "0e72ed",
      "description": "The name tag's accent color."
    },
    "background_color": {
      "type": "string",
      "format": "Hex color code",
      "example": "0e72ed",
      "description": "The name tag's background color."
    },
    "set_default_for_all_panelists": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Whether to set the name tag as the new default for all panelists or not. This includes panelists not currently assigned a default name tag."
    }
  },
  "description": "Name tag information"
}

object WebinarsCreateBrandingNameTagResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "J0sFXN2PSOCGrqTqLRwgAQ",
      "description": "The name tag's ID."
    },
    "name": {
      "type": "string",
      "example": "name",
      "description": "The name tag's name."
    },
    "is_default": {
      "type": "boolean",
      "example": true,
      "description": "Whether the name tag is the default name tag or not."
    },
    "text_color": {
      "type": "string",
      "example": "0e72ed",
      "description": "The name tag's text color."
    },
    "accent_color": {
      "type": "string",
      "example": "0e72ed",
      "description": "The name tag's accent color."
    },
    "background_color": {
      "type": "string",
      "example": "0e72ed",
      "description": "The name tag's background_color color."
    }
  }
}

object WebinarsCreateInviteLinksRequest

{
  "type": "object",
  "title": "Invite links",
  "properties": {
    "ttl": {
      "type": "integer",
      "format": "int64",
      "default": 7200,
      "example": 1000,
      "maximum": 7776000,
      "minimum": 0,
      "description": "The invite link's expiration time, in seconds. \n\nThis value defaults to `7200`."
    },
    "attendees": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "example": "Jill Chill",
            "maxLength": 64,
            "description": "User display name."
          }
        }
      },
      "maxItems": 500,
      "minItems": 1,
      "description": "The attendees list."
    }
  },
  "description": "Invite Links"
}

object WebinarsCreateInviteLinksResponse

{
  "type": "object",
  "title": "Invite Links",
  "properties": {
    "attendees": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "Jill Chill",
            "description": "The user's display name."
          },
          "join_url": {
            "type": "string",
            "example": "https://example.com/j/11111",
            "description": "The URL to join the meeting."
          }
        }
      },
      "description": "The attendee list."
    }
  },
  "description": "Invite links response."
}

object WebinarsCreatePollRequest

{
  "type": "object",
  "title": "Meeting and webinar polling object.",
  "properties": {
    "title": {
      "type": "string",
      "example": "Learn something new",
      "maxLength": 64,
      "description": "The poll's title, up to 64 characters."
    },
    "anonymous": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Allow meeting participants to answer poll questions anonymously. \n\nThis value defaults to `false`."
    },
    "poll_type": {
      "enum": [
        1,
        2,
        3
      ],
      "type": "integer",
      "example": 2,
      "description": "The type of poll. \n* `1` - Poll. \n* `2` - Advanced Poll. This feature must be enabled in your Zoom account. \n* `3` - Quiz. This feature must be enabled in your Zoom account. \n\n This value defaults to `1`."
    },
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "How useful was this meeting?",
            "maxLength": 255,
            "description": "The poll question, up to 255 characters. \n\nFor `fill_in_the_blank` polls, this field is the poll's question. For each value that the user must fill in, ensure that there are the same number of `right_answers` values."
          },
          "type": {
            "enum": [
              "single",
              "multiple",
              "matching",
              "rank_order",
              "short_answer",
              "long_answer",
              "fill_in_the_blank",
              "rating_scale"
            ],
            "type": "string",
            "example": "single",
            "extensions": {
              "x-enum-descriptions": [
                "Single choice",
                "Multiple choice",
                "Matching",
                "Rank order",
                "Short answer",
                "Long answer",
                "Fill in the blank",
                "Rating scale"
              ]
            },
            "description": "The poll's question and answer type. \n* `single` - Single choice. \n* `multiple` - Multiple choice. \n* `matching` - Matching. \n* `rank_order` - Rank order. \n* `short_answer` - Short answer. \n* `long_answer` - Long answer. \n* `fill_in_the_blank` - Fill in the blank. \n* `rating_scale` - Rating scale."
          },
          "answers": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "Extremely useful"
            },
            "minItems": 2,
            "description": "The poll question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` polls, you can only provide a maximum of 10 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers."
          },
          "prompts": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "prompt_question": {
                  "type": "string",
                  "example": "How are you?",
                  "description": "The question prompt's title."
                },
                "prompt_right_answers": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "Good"
                  },
                  "description": "The question prompt's correct answers: \n* For `matching` polls, you must provide a minimum of two correct answers, up to a maximum of 10 correct answers. \n* For `rank_order` polls, you can only provide one correct answer."
                }
              }
            },
            "description": "Information about the prompt questions. This field only applies to `matching` and `rank_order` polls. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts."
          },
          "right_answers": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "Good"
            },
            "minItems": 1,
            "description": "The poll question's correct answer(s). This field is **required** if the poll's `type` value is `3` (Quiz). \n\n For `single` and `matching` polls, this field only accepts one answer."
          },
          "case_sensitive": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether the correct answer is case sensitive. This field only applies to `fill_in_the_blank` polls. \n* `true` - The answer is case-sensitive. \n* `false` - The answer is not case-sensitive. \n\nThis value defaults to `false`."
          },
          "answer_required": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether participants must answer the question. \n* `true` - The participant must answer the question. \n* `false` - The participant does not need to answer the question. \n\n**Note:** \n* When the poll's `type` value is `1` (Poll), this value defaults to `true`. \n* When the poll's `type` value is the `2` (Advanced Poll) or `3` (Quiz) values, this value defaults to `false`."
          },
          "rating_max_label": {
            "type": "string",
            "example": "Extremely Likely",
            "description": "The high score label used for the `rating_max_value` field. \n\nThis field only applies to the `rating_scale` poll."
          },
          "rating_max_value": {
            "type": "integer",
            "example": 4,
            "maximum": 10,
            "description": "The rating scale's maximum value, up to a maximum value of 10. \n\nThis field only applies to the `rating_scale` poll."
          },
          "rating_min_label": {
            "type": "string",
            "example": "Not likely",
            "description": "The low score label used for the `rating_min_value` field. \n\nThis field only applies to the `rating_scale` poll."
          },
          "rating_min_value": {
            "type": "integer",
            "example": 0,
            "minimum": 0,
            "description": "The rating scale's minimum value. This value cannot be less than zero. \n\nThis field only applies to the `rating_scale` poll."
          },
          "show_as_dropdown": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether to display the radio selection as a drop-down box. \n* `true` - Show as a drop-down box. \n* `false` - Do not show as a drop-down box. \n\nThis value defaults to `false`."
          },
          "answer_max_character": {
            "type": "integer",
            "example": 200,
            "description": "The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` polls: \n* For `short_answer` polls, a maximum of 500 characters. \n* For `long_answer` polls, a maximum of 2,000 characters."
          },
          "answer_min_character": {
            "type": "integer",
            "example": 1,
            "minimum": 1,
            "description": "The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` polls. You must provide at least a **one** character minimum value."
          }
        }
      },
      "description": "Information about the poll's questions."
    }
  },
  "description": "Information about meeting and webinar polling."
}

object WebinarsCreatePollResponse

{
  "type": "object",
  "title": "Meeting and webinar polling object.",
  "properties": {
    "id": {
      "type": "string",
      "example": "QalIoKWLTJehBJ8e1xRrbQ",
      "description": "Webinar Poll ID"
    },
    "title": {
      "type": "string",
      "example": "Learn something new",
      "maxLength": 64,
      "description": "The poll's title, up to 64 characters."
    },
    "status": {
      "enum": [
        "notstart",
        "started",
        "ended",
        "sharing"
      ],
      "type": "string",
      "example": "notstart",
      "extensions": {
        "x-enum-descriptions": [
          "Poll not start",
          "Poll started",
          "Poll ended",
          "Poll is sharing"
        ]
      },
      "description": "Status of the Webinar Poll:  \n `notstart` - Poll not started  \n `started` - Poll started  \n `ended` - Poll ended  \n `sharing` - Sharing poll results"
    },
    "anonymous": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Allow meeting participants to answer poll questions anonymously. \n\nThis value defaults to `false`."
    },
    "poll_type": {
      "enum": [
        1,
        2,
        3
      ],
      "type": "integer",
      "example": 2,
      "description": "The type of poll. \n* `1` - Poll. \n* `2` - Advanced Poll. This feature must be enabled in your Zoom account. \n* `3` - Quiz. This feature must be enabled in your Zoom account. \n\n This value defaults to `1`."
    },
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "How useful was this meeting?",
            "maxLength": 255,
            "description": "The poll question, up to 255 characters. \n\nFor `fill_in_the_blank` polls, this field is the poll's question. For each value that the user must fill in, ensure that there are the same number of `right_answers` values."
          },
          "type": {
            "enum": [
              "single",
              "multiple",
              "matching",
              "rank_order",
              "short_answer",
              "long_answer",
              "fill_in_the_blank",
              "rating_scale"
            ],
            "type": "string",
            "example": "single",
            "extensions": {
              "x-enum-descriptions": [
                "Single choice",
                "Multiple choice",
                "Matching",
                "Rank order",
                "Short answer",
                "Long answer",
                "Fill in the blank",
                "Rating scale"
              ]
            },
            "description": "The poll's question and answer type. \n* `single` - Single choice. \n* `multiple` - Multiple choice. \n* `matching` - Matching. \n* `rank_order` - Rank order. \n* `short_answer` - Short answer. \n* `long_answer` - Long answer. \n* `fill_in_the_blank` - Fill in the blank. \n* `rating_scale` - Rating scale."
          },
          "answers": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "Extremely useful"
            },
            "minItems": 2,
            "description": "The poll question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` polls, you can only provide a maximum of 10 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers."
          },
          "prompts": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "prompt_question": {
                  "type": "string",
                  "example": "How are you?",
                  "description": "The question prompt's title."
                },
                "prompt_right_answers": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "Good"
                  },
                  "description": "The question prompt's correct answers: \n* For `matching` polls, you must provide a minimum of two correct answers, up to a maximum of 10 correct answers. \n* For `rank_order` polls, you can only provide one correct answer."
                }
              }
            },
            "description": "Information about the prompt questions. This field only applies to `matching` and `rank_order` polls. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts."
          },
          "right_answers": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "Good"
            },
            "minItems": 1,
            "description": "The poll question's correct answer(s). This field is **required** if the poll's `type` value is `3` (Quiz). \n\n For `single` and `matching` polls, this field only accepts one answer."
          },
          "case_sensitive": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether the correct answer is case sensitive. This field only applies to `fill_in_the_blank` polls. \n* `true` - The answer is case-sensitive. \n* `false` - The answer is not case-sensitive. \n\nThis value defaults to `false`."
          },
          "answer_required": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether participants must answer the question. \n* `true` - The participant must answer the question. \n* `false` - The participant does not need to answer the question. \n\n**Note:** \n* When the poll's `type` value is `1` (Poll), this value defaults to `true`. \n* When the poll's `type` value is the `2` (Advanced Poll) or `3` (Quiz) values, this value defaults to `false`."
          },
          "rating_max_label": {
            "type": "string",
            "example": "Extremely Likely",
            "description": "The high score label used for the `rating_max_value` field. \n\nThis field only applies to the `rating_scale` poll."
          },
          "rating_max_value": {
            "type": "integer",
            "example": 4,
            "maximum": 10,
            "description": "The rating scale's maximum value, up to a maximum value of 10. \n\nThis field only applies to the `rating_scale` poll."
          },
          "rating_min_label": {
            "type": "string",
            "example": "Not likely",
            "description": "The low score label used for the `rating_min_value` field. \n\nThis field only applies to the `rating_scale` poll."
          },
          "rating_min_value": {
            "type": "integer",
            "example": 0,
            "minimum": 0,
            "description": "The rating scale's minimum value. This value cannot be less than zero. \n\nThis field only applies to the `rating_scale` poll."
          },
          "show_as_dropdown": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether to display the radio selection as a drop-down box. \n* `true` - Show as a drop-down box. \n* `false` - Do not show as a drop-down box. \n\nThis value defaults to `false`."
          },
          "answer_max_character": {
            "type": "integer",
            "example": 200,
            "description": "The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` polls: \n* For `short_answer` polls, a maximum of 500 characters. \n* For `long_answer` polls, a maximum of 2,000 characters."
          },
          "answer_min_character": {
            "type": "integer",
            "example": 1,
            "minimum": 1,
            "description": "The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` polls. You must provide at least a **one** character minimum value."
          }
        }
      },
      "description": "Information about the poll's questions."
    }
  },
  "description": "Information about meeting and webinar polling."
}

object WebinarsCreateWebinarRequest

{
  "type": "object",
  "properties": {
    "type": {
      "enum": [
        5,
        6,
        9
      ],
      "type": "integer",
      "default": 5,
      "example": 5,
      "extensions": {
        "x-enum-descriptions": [
          "Webinar",
          "Recurring webinar with no fixed time",
          "Recurring webinar with fixed time"
        ]
      },
      "description": "Webinar types.\n `5` - Webinar.  \n `6` - Recurring webinar with no fixed time.  \n `9` - Recurring webinar with a fixed time."
    },
    "topic": {
      "type": "string",
      "example": "My Webinar",
      "description": "Webinar topic."
    },
    "agenda": {
      "type": "string",
      "example": "My Webinar",
      "description": "Webinar description."
    },
    "duration": {
      "type": "integer",
      "example": 60,
      "description": "Webinar duration in minutes. Used for scheduled webinars only."
    },
    "password": {
      "type": "string",
      "example": "123456",
      "description": "Webinar passcode. Passcode may only contain the characters [a-z A-Z 0-9 @ - _ * !]. Maximum of 10 characters.\n\nIf **Require a passcode when scheduling new meetings** setting has been **enabled** **and** [locked](https://support.zoom.us/hc/en-us/articles/115005269866-Using-Tiered-Settings#locked) for the user, the passcode field will be autogenerated for the Webinar in the response even if it is not provided in the API request. \n \n\n**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.   \n   \n If the requirements are enabled, you can view those requirements by calling the [**Get account settings**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/ma#operation/accountSettings) API."
    },
    "settings": {
      "type": "object",
      "properties": {
        "audio": {
          "enum": [
            "both",
            "telephony",
            "voip",
            "thirdParty"
          ],
          "type": "string",
          "default": "both",
          "example": "telephony",
          "extensions": {
            "x-enum-descriptions": [
              "Both Telephony and VoIP",
              "Telephony only",
              "VoIP only",
              "Third party audio conference"
            ]
          },
          "description": "Determine how participants can join the audio portion of the meeting.(Not supported for simulive webinar.)"
        },
        "hd_video": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Default to HD video.(Not supported for simulive webinar.)"
        },
        "on_demand": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Make the webinar on-demand. Not supported for simulive webinar."
        },
        "host_video": {
          "type": "boolean",
          "example": true,
          "description": "Start video when host joins webinar.(Not supported for simulive webinar.)"
        },
        "survey_url": {
          "type": "string",
          "example": "https://example.com",
          "description": "Survey URL for post webinar survey"
        },
        "contact_name": {
          "type": "string",
          "example": "Jill Chill",
          "description": "Contact name for registration"
        },
        "add_watermark": {
          "type": "boolean",
          "example": true,
          "description": "Add watermark that identifies the viewing participant. Not supported for simulive webinar."
        },
        "approval_type": {
          "enum": [
            0,
            1,
            2
          ],
          "type": "integer",
          "default": 2,
          "example": 0,
          "extensions": {
            "x-enum-descriptions": [
              "Automatically Approve",
              "Manually Approve",
              "No Registration Required"
            ]
          },
          "description": "The default value is `2`. To enable registration required, set the approval type to `0` or `1`.  Values include:  \n \n\n`0` - Automatically approve.  \n `1` - Manually approve.  \n `2` - No registration required."
        },
        "contact_email": {
          "type": "string",
          "example": "jchill@example.com",
          "description": "Contact email for registration"
        },
        "enforce_login": {
          "type": "boolean",
          "example": true,
          "deprecated": true,
          "description": "Only signed-in users can join this meeting. \n\n**This field is deprecated and will not be supported in future.**   \n   \n  Instead of this field, use the `meeting_authentication`, `authentication_option`, or `authentication_domains` fields to establish the authentication mechanism for this Webinar. "
        },
        "auto_recording": {
          "enum": [
            "local",
            "cloud",
            "none"
          ],
          "type": "string",
          "default": "none",
          "example": "cloud",
          "extensions": {
            "x-enum-descriptions": [
              "Record to local device",
              "Record to cloud",
              "No Recording"
            ]
          },
          "description": "Automatic recording. Not supported for simulive webinar.   \n `local` - Record on local.  \n `cloud` -  Record on cloud.  \n `none` - Disabled."
        },
        "email_language": {
          "type": "string",
          "example": "en-US",
          "description": "Set the email language.\n`en-US`,`de-DE`,`es-ES`,`fr-FR`,`id-ID`,`jp-JP`,`nl-NL`,`pl-PL`,`pt-PT`,`ru-RU`,`tr-TR`,`zh-CN`, `zh-TW`, `ko-KO`, `it-IT`, `vi-VN`."
        },
        "panelists_video": {
          "type": "boolean",
          "example": true,
          "description": "Start video when panelists join webinar. Not supported for simulive webinar."
        },
        "practice_session": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Enable practice session."
        },
        "alternative_hosts": {
          "type": "string",
          "example": "jchill@example.com;thill@example.com",
          "description": "Alternative host emails or IDs. Multiple values separated by comma."
        },
        "registration_type": {
          "enum": [
            1,
            2,
            3
          ],
          "type": "integer",
          "default": 1,
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Attendees register once and can attend any of the occurrences",
              "Attendees need to register for each occurrence to attend",
              "Attendees register once and can choose one or more occurrences to attend"
            ]
          },
          "description": "Registration types. Only used for recurring webinars with a fixed time.  \n `1` - Attendees register once and can attend any of the webinar sessions.  \n `2` - Attendees need to register for each session in order to attend.  \n `3` - Attendees register once and can choose one or more sessions to attend."
        },
        "show_share_button": {
          "type": "boolean",
          "example": true,
          "description": "Show social share buttons on the registration page."
        },
        "close_registration": {
          "type": "boolean",
          "example": true,
          "deprecated": true,
          "description": "Close registration after event date."
        },
        "add_audio_watermark": {
          "type": "boolean",
          "example": true,
          "description": "Add audio watermark that identifies the participants. Not supported for simulive webinar."
        },
        "post_webinar_survey": {
          "type": "boolean",
          "example": true,
          "description": "Zoom will open a survey page in attendees' browsers after leaving the webinar"
        },
        "question_and_answer": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Enable [Q&amp;A](https://support.zoom.us/hc/en-us/articles/203686015-Using-Q-A-as-the-webinar-host#:~:text=Overview,and%20upvote%20each%20other's%20questions.) for webinar.\n\n* `false` - Disable Q&amp;A for webinar."
            },
            "auto_reply_text": {
              "type": "string",
              "example": "Thank you for your question. We will get back to you shortly.",
              "description": "If `allow_auto_reply` = true, the text to be included in the automatic response. "
            },
            "allow_auto_reply": {
              "type": "boolean",
              "example": true,
              "description": "If simulive webinar, \n\n* `true` - allow auto-reply to attendees. \n\n* `false` - don't allow auto-reply to the attendees."
            },
            "answer_questions": {
              "enum": [
                "only",
                "all"
              ],
              "type": "string",
              "example": "all",
              "description": "Indicate whether you want attendees to be able to view answered questions only or view all questions.\n\n* `only` - Attendees are able to view answered questions only.\n\n*  `all` - Attendees are able to view all questions submitted in the Q&amp;A."
            },
            "attendees_can_upvote": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Attendees can click the thumbs up button to bring popular questions to the top of the Q&amp;A window.\n\n* `false` - Attendees can not click the thumbs up button on questions."
            },
            "attendees_can_comment": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Attendees can answer questions or leave a comment in the question thread.\n\n* `false` - Attendees can not answer questions or leave a comment in the question thread"
            },
            "allow_submit_questions": {
              "type": "boolean",
              "example": true,
              "description": "* `true`: Allow participants to submit questions.\n\n* `false`: Do not allow submit questions."
            },
            "allow_anonymous_questions": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Allow participants to send questions without providing their name to the host, co-host, and panelists..\n\n* `false` - Do not allow anonymous questions.(Not supported for simulive webinar.)"
            }
          },
          "description": "[Q&amp;A](https://support.zoom.us/hc/en-us/articles/203686015-Using-Q-A-as-the-webinar-host#:~:text=Overview,and%20upvote%20each%20other's%20questions.) for webinar."
        },
        "audio_conference_info": {
          "type": "string",
          "example": "test",
          "maxLength": 2048,
          "description": "Third party audio conference info."
        },
        "authentication_option": {
          "type": "string",
          "example": "signIn_D8cJuqWVQ623CI4Q8yQK0Q",
          "description": "Specify the authentication type for users to join a Webinar with`meeting_authentication` setting set to `true`. The value of this field can be retrieved from the `id` field within `authentication_options` array in the response of [**Get user settings**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods#operation/userSettings) API."
        },
        "enforce_login_domains": {
          "type": "string",
          "example": "example.com",
          "deprecated": true,
          "description": "Only signed-in users with specified domains can join meetings.\n\n**This field is deprecated and will not be supported in future.**   \n \n  Instead of this field, use the `authentication_domains` field for this webinar. "
        },
        "allow_multiple_devices": {
          "type": "boolean",
          "example": true,
          "description": "Allow attendees to join from multiple devices."
        },
        "authentication_domains": {
          "type": "string",
          "example": "example.com",
          "description": "Meeting authentication domains. This option allows you to specify the rule so that Zoom users whose email address contains a certain domain can join the webinar. You can either provide multiple comma-separated domains, use a wildcard for listing domains, or use both methods."
        },
        "hd_video_for_attendees": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether HD video for attendees is enabled. This value defaults to `false`.(Not supported for simulive webinar.)"
        },
        "meeting_authentication": {
          "type": "boolean",
          "example": true,
          "description": "Only [authenticated](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) users can join meeting if the value of this field is set to `true`."
        },
        "enable_session_branding": {
          "type": "boolean",
          "example": true,
          "description": "Whether the **Webinar Session Branding** setting is enabled. This setting lets hosts visually customize a webinar by setting a session background. This also lets hosts set Virtual Background and apply name tags to hosts, alternative hosts, panelists, interpreters, and speakers."
        },
        "language_interpretation": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "Enable [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars) for the webinar."
            },
            "interpreters": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "format": "email",
                    "example": "interpreter@example.com",
                    "description": "The interpreter's email address."
                  },
                  "languages": {
                    "type": "string",
                    "example": "US,CN",
                    "description": "A comma-separated list of the interpreter's languages. The string must contain two [country IDs](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries). \n\nFor example, if the interpreter will translate from English to Chinese, then this value will be `US,CN`."
                  }
                }
              },
              "description": "Information about the webinar's language interpreters."
            }
          },
          "description": "The webinar's [language interpretation settings](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** This feature is only available for certain Webinar add-on, Education, and Business and higher plans. If this feature is not enabled on the host's account, this setting will **not** be applied to the webinar. This is not supported for simulive webinars."
        },
        "panelist_authentication": {
          "type": "boolean",
          "example": true,
          "description": "Require panelists to authenticate to join"
        },
        "global_dial_in_countries": {
          "type": "array",
          "items": {
            "type": "string",
            "example": "US"
          },
          "description": "List of global dial-in countries"
        },
        "registrants_restrict_number": {
          "type": "integer",
          "default": 0,
          "example": 100,
          "maximum": 20000,
          "minimum": 0,
          "description": "Restrict number of registrants for a webinar. By default, it is set to `0`. A `0` value means that the restriction option is disabled. Provide a number higher than 0 to restrict the webinar registrants by the that number."
        },
        "sign_language_interpretation": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "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 webinar."
            },
            "interpreters": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "format": "email",
                    "example": "interpreter@example.com",
                    "description": "The interpreter's email address."
                  },
                  "sign_language": {
                    "type": "string",
                    "example": "American",
                    "description": "The interpreter's sign language. \n\n To get this value, use the `sign_language_interpretation` object's `languages` and `custom_languages` values in the [**Get user settings**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods#operation/userSettings) API response."
                  }
                }
              },
              "maximum": 20,
              "description": "Information about the webinar's sign language interpreters."
            }
          },
          "description": "The webinar's [sign language interpretation settings](https://support.zoom.us/hc/en-us/articles/9644962487309-Using-sign-language-interpretation-in-a-meeting-or-webinar). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** If this feature is not enabled on the host's account, this setting will **not** be applied to the webinar."
        },
        "alternative_host_update_polls": {
          "type": "boolean",
          "example": true,
          "description": "Whether the **Allow alternative hosts to add or edit polls** feature is enabled. This requires Zoom version 5.8.0 or higher."
        },
        "send_1080p_video_to_attendees": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to always send 1080p video to attendees. This value defaults to `false`.(Not supported for simulive webinar.)"
        },
        "registrants_email_notification": {
          "type": "boolean",
          "example": true,
          "description": "Send email notifications to registrants about approval, cancellation, denial of the registration. The value of this field must be set to true in order to use the `registrants_confirmation_email` field."
        },
        "follow_up_absentees_email_notification": {
          "type": "object",
          "properties": {
            "type": {
              "enum": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7
              ],
              "type": "integer",
              "example": 0,
              "extensions": {
                "x-enum-descriptions": [
                  "Send 1 days after the scheduled end date.",
                  "Send 2 days after the scheduled end date.",
                  "Send 3 days after the scheduled end date.",
                  "Send 4 days after the scheduled end date.",
                  "Send 5 days after the scheduled end date.",
                  "Send 6 days after the scheduled end date.",
                  "Send 7 days after the scheduled end date."
                ]
              },
              "description": "`0` - No plan.  \n `1` - Send 1 days after the scheduled end date.  \n `2` - Send 2 days after the scheduled end date.  \n `3` - Send 3 days after the scheduled end date.  \n `4` - Send 4 days after the scheduled end date.  \n `5` - Send 5 days after the scheduled end date.  \n `6` - Send 6 days after the scheduled end date.  \n `7` - Send 7 days after the scheduled end date."
            },
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Send follow-up email to absentees.\n\n* `false` - Do not send follow-up email to absentees."
            }
          },
          "description": "Send follow-up email to absentees."
        },
        "follow_up_attendees_email_notification": {
          "type": "object",
          "properties": {
            "type": {
              "enum": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7
              ],
              "type": "integer",
              "example": 0,
              "extensions": {
                "x-enum-descriptions": [
                  "Send 1 day after the scheduled end date.",
                  "Send 2 days after the scheduled end date.",
                  "Send 3 days after the scheduled end date.",
                  "Send 4 days after the scheduled end date.",
                  "Send 5 days after the scheduled end date.",
                  "Send 6 days after the scheduled end date.",
                  "Send 7 days after the scheduled end date."
                ]
              },
              "description": "`0` - No plan.  \n `1` - Send 1 day after the scheduled end date.  \n `2` - Send 2 days after the scheduled end date.  \n `3` - Send 3 days after the scheduled end date.  \n `4` - Send 4 days after the scheduled end date.  \n `5` - Send 5 days after the scheduled end date.  \n `6` - Send 6 days after the scheduled end date.  \n `7` - Send 7 days after the scheduled end date."
            },
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "* `true`: Send follow-up email to attendees.\n\n* `false`: Do not send follow-up email to attendees."
            }
          },
          "description": "Send follow-up email to attendees."
        },
        "panelists_invitation_email_notification": {
          "type": "boolean",
          "example": true,
          "description": "Send invitation email to panelists. If `false`, do not send invitation email to panelists."
        },
        "attendees_and_panelists_reminder_email_notification": {
          "type": "object",
          "properties": {
            "type": {
              "enum": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7
              ],
              "type": "integer",
              "example": 0,
              "extensions": {
                "x-enum-descriptions": [
                  "Send 1 hour before webinar.",
                  "Send 1 day before webinar.",
                  "Send 1 hour and 1 day before webinar.",
                  "Send 1 week before webinar.",
                  "Send 1 hour and 1 week before webinar.",
                  "Send 1 day and 1 week before webinar.",
                  "Send 1 hour, 1 day and 1 week before webinar."
                ]
              },
              "description": "`0` - No plan.  \n `1` - Send 1 hour before webinar.  \n `2` - Send 1 day before webinar.  \n `3` - Send 1 hour and 1 day before webinar.  \n `4` - Send 1 week before webinar.  \n `5` - Send 1 hour and 1 week before webinar.  \n `6` - Send 1 day and 1 week before webinar.  \n `7` - Send 1 hour, 1 day and 1 week before webinar."
            },
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "* `true`: Send reminder email to attendees and panelists.\n\n* `false`: Do not send reminder email to attendees and panelists."
            }
          },
          "description": "Send reminder email to attendees and panelists."
        }
      },
      "description": "Create webinar settings."
    },
    "timezone": {
      "type": "string",
      "example": "America/Los_Angeles",
      "description": "The timezone to assign to the `start_time` value. This field is only used for scheduled or recurring webinars with a fixed time.\n\nFor a list of supported timezones and their formats, see our [timezone list](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones)."
    },
    "recurrence": {
      "type": "object",
      "title": "Recurrence webinar",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "enum": [
            1,
            2,
            3
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Daily",
              "Weekly",
              "Monthly"
            ]
          },
          "description": "Recurrence webinar types.\n `1` - Daily.  \n `2` - Weekly.  \n `3` - Monthly."
        },
        "end_times": {
          "type": "integer",
          "default": 1,
          "example": 7,
          "maximum": 60,
          "description": "Select how many times the webinar will recur before it is canceled. The maximum number of recurring is 60. Cannot be used with `end_date_time`."
        },
        "monthly_day": {
          "type": "integer",
          "example": 1,
          "description": "Use this field **only if you're scheduling a recurring webinar of type** `3` to state which day in a month the webinar should recur. The value range is from 1 to 31.\n\nFor instance, if you would like the webinar to recur on 23rd of each month, provide `23` as the value of this field and `1` as the value of the `repeat_interval` field. Instead, if you would like the webinar to recur once every three months, on 23rd of the month, change the value of the `repeat_interval` field to `3`."
        },
        "weekly_days": {
          "type": "string",
          "example": "1",
          "description": "Use this field **only if you're scheduling a recurring webinar of type** `2` to state which day(s) of the week the webinar should repeat.\nThe value for this field could be a number between `1` to `7` in string format. For instance, if the webinar should recur on Sunday, provide `1` as the value of this field.    \n   \n  **Note:** If you would like the webinar to occur on multiple days of a week, you should provide comma separated values for this field. For instance, if the webinar should recur on Sundays and Tuesdays, provide `1,3` as the value of this field.\n\n  \n `1`  - Sunday.   \n `2` - Monday.  \n `3` - Tuesday.  \n `4` -  Wednesday.  \n `5` -  Thursday.  \n `6` - Friday.  \n `7` - Saturday.\n\n"
        },
        "monthly_week": {
          "enum": [
            -1,
            1,
            2,
            3,
            4
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Last week",
              "First week",
              "Second week",
              "Third week",
              "Fourth week"
            ]
          },
          "description": "Use this field **only if you're scheduling a recurring webinar of type** `3` to state the week of the month when the webinar 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 webinar should recur.**   \n `-1` - Last week of the month.  \n `1` - First week of the month.  \n `2` - Second week of the month.  \n `3` - Third week of the month.  \n `4` - Fourth week of the month."
        },
        "end_date_time": {
          "type": "string",
          "format": "date-time",
          "example": "2022-04-02T15:59:00Z",
          "description": "Select a date when the webinar will recur before it is canceled. Should be in UTC time, such as 2017-11-25T12:00:00Z. Cannot be used with `end_times`."
        },
        "repeat_interval": {
          "type": "integer",
          "example": 1,
          "description": "Define the interval when the webinar should recur. For instance, if you would like to schedule a Webinar that recurs every two months, you must set the value of this field as `2` and the value of the `type` parameter as `3`. \n\nFor a daily webinar, the maximum interval you can set is `90` days. For a weekly webinar, the maximum interval that you can set is `12` weeks. For a monthly webinar, the maximum interval that you can set is `3` months."
        },
        "monthly_week_day": {
          "enum": [
            1,
            2,
            3,
            4,
            5,
            6,
            7
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Sunday",
              "Monday",
              "Tuesday",
              "Wednesday",
              "Thursday",
              "Friday",
              "Saturday"
            ]
          },
          "description": "Use this field **only if you're scheduling a recurring webinar of type** `3` to state a specific day in a week when the monthly webinar should recur. To use this field, you must also use the `monthly_week` field.   \n `1` - Sunday.  \n `2` - Monday.  \n `3` - Tuesday.  \n `4` -  Wednesday.  \n `5` - Thursday.  \n `6` - Friday.  \n `7` - Saturday."
        }
      },
      "description": "Recurrence object. Use this object only for a webinar of type `9`, a recurring webinar with fixed time. "
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-26T06:44:14Z",
      "description": "Webinar start time. We support two formats for `start_time` - local time and GMT.  \n  \n\nTo set time as GMT the format should be `yyyy-MM-dd`T`HH:mm:ssZ`.\n\nTo set time using a specific timezone, use `yyyy-MM-dd`T`HH:mm:ss` format and specify the timezone [ID](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones) in the `timezone` field OR leave it blank and the timezone set on your Zoom account will be used. You can also set the time as UTC as the timezone field.\n\nThe `start_time` should only be used for scheduled and / or recurring webinars with fixed time."
    },
    "is_simulive": {
      "type": "boolean",
      "example": true,
      "description": "Whether to set the webinar simulive."
    },
    "template_id": {
      "type": "string",
      "example": "5Cj3ceXoStO6TGOVvIOVPA==",
      "description": "The webinar template ID to schedule a webinar using a [webinar template](https://support.zoom.us/hc/en-us/articles/115001079746-Webinar-Templates) or a [admin webinar template](https://support.zoom.us/hc/en-us/articles/8137753618957-Configuring-admin-webinar-templates). For a list of webinar templates, use the [**List webinar templates**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods#operation/listWebinarTemplates) API."
    },
    "schedule_for": {
      "type": "string",
      "example": "jchill@example.com",
      "description": "The email address or user ID of the user to schedule a webinar for."
    },
    "record_file_id": {
      "type": "string",
      "example": "f09340e1-cdc3-4eae-9a74-98f9777ed908",
      "description": "The previously recorded file's ID for `simulive`."
    },
    "tracking_fields": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "field"
        ],
        "properties": {
          "field": {
            "type": "string",
            "example": "field1",
            "description": "Tracking fields type."
          },
          "value": {
            "type": "string",
            "example": "value1",
            "description": "Tracking fields value."
          }
        }
      },
      "description": "Tracking fields."
    }
  },
  "description": "Webinar object."
}

object WebinarsCreateWebinarResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 95204914252,
      "description": "Webinar ID in **long** format, represented as int64 data type in JSON. Also known as the webinar number."
    },
    "type": {
      "enum": [
        5,
        6,
        9
      ],
      "type": "integer",
      "default": 5,
      "example": 5,
      "extensions": {
        "x-enum-descriptions": [
          "Webinar",
          "Recurring Webinar with no fixed time",
          "Recurring Webinar with fixed time"
        ]
      },
      "description": "Webinar Types:  \n `5` - Webinar.  \n `6` - Recurring webinar with no fixed time.  \n `9` - Recurring webinar with a fixed time."
    },
    "uuid": {
      "type": "string",
      "example": "Bznyg8KZTdCVbQxvS/oZ7w==",
      "description": "Unique identifier of a webinar. Each webinar instance will generate its own UUID. Ror example, after a webinar ends, a new UUID will be generated for the next instance of the Webinar). Once a Webinar ends, the value of the UUID for the same webinar will be different from when it was scheduled."
    },
    "topic": {
      "type": "string",
      "example": "My Webinar",
      "maxLength": 200,
      "description": "Webinar topic."
    },
    "agenda": {
      "type": "string",
      "example": "My Webinar",
      "description": "Webinar agenda."
    },
    "host_id": {
      "type": "string",
      "example": "30R7kT7bTIKSNUFEuH_Qlg",
      "description": "ID of the user set as host of the webinar."
    },
    "duration": {
      "type": "integer",
      "example": 60,
      "description": "Webinar duration."
    },
    "join_url": {
      "type": "string",
      "example": "https://example.com/j/11111",
      "description": "URL to join the webinar. Only share this URL with the users who should be invited to the Webinar."
    },
    "password": {
      "type": "string",
      "example": "123456",
      "maxLength": 10,
      "description": "Webinar passcode. \n\nIf **Require a passcode when scheduling new meetings** setting has been **enabled** **and** [locked](https://support.zoom.us/hc/en-us/articles/115005269866-Using-Tiered-Settings#locked) for the user, the passcode field will be autogenerated for the Webinar in the response even if it is not provided in the API request.   \n   \n \n**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.   \n   \n If the requirements are enabled, you can view those requirements by calling either the [**Get user settings**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods#operation/userSettings) API or the [**Get account settings**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/ma#operation/accountSettings) API."
    },
    "settings": {
      "type": "object",
      "properties": {
        "audio": {
          "enum": [
            "both",
            "telephony",
            "voip",
            "thirdParty"
          ],
          "type": "string",
          "default": "both",
          "example": "telephony",
          "extensions": {
            "x-enum-descriptions": [
              "Both Telephony and VoIP",
              "Telephony only",
              "VoIP only",
              "Third party audio conference"
            ]
          },
          "description": "Determine how participants can join the audio portion of the webinar."
        },
        "hd_video": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Default to HD video."
        },
        "on_demand": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Make the webinar on-demand"
        },
        "host_video": {
          "type": "boolean",
          "example": true,
          "description": "Start video when host joins webinar."
        },
        "survey_url": {
          "type": "string",
          "example": "https://example.com",
          "description": "Survey url for post webinar survey"
        },
        "contact_name": {
          "type": "string",
          "example": "Jill Chill",
          "description": "Contact name for registration"
        },
        "add_watermark": {
          "type": "boolean",
          "example": true,
          "description": "Add watermark that identifies the viewing participant."
        },
        "approval_type": {
          "enum": [
            0,
            1,
            2
          ],
          "type": "integer",
          "default": 2,
          "example": 0,
          "extensions": {
            "x-enum-descriptions": [
              "Automatically Approve",
              "Manually Approve",
              "No Registration Required"
            ]
          },
          "description": "`0` - Automatically approve.  \n `1` - Manually approve.  \n `2` - No registration required."
        },
        "contact_email": {
          "type": "string",
          "example": "jchill@example.com",
          "description": "Contact email for registration"
        },
        "enforce_login": {
          "type": "boolean",
          "example": true,
          "deprecated": true,
          "description": "Only signed in users can join this meeting.\n\n**This field is deprecated and will not be supported in the future.**\n\n 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 webinar."
        },
        "auto_recording": {
          "enum": [
            "local",
            "cloud",
            "none"
          ],
          "type": "string",
          "default": "none",
          "example": "cloud",
          "extensions": {
            "x-enum-descriptions": [
              "Record to local device",
              "Record to cloud",
              "No Recording"
            ]
          },
          "description": "Automatic recording. \n `local` - Record on local.  \n `cloud` -  Record on cloud.  \n `none` - Disabled."
        },
        "email_language": {
          "type": "string",
          "example": "en-US",
          "description": "Set the email language to one of the following:\n`en-US`,`de-DE`,`es-ES`,`fr-FR`,`jp-JP`,`pt-PT`,`ru-RU`,`zh-CN`, `zh-TW`, `ko-KO`, `it-IT`, `vi-VN`."
        },
        "panelists_video": {
          "type": "boolean",
          "example": true,
          "description": "Start video when panelists join webinar."
        },
        "practice_session": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Enable practice session."
        },
        "alternative_hosts": {
          "type": "string",
          "example": "jchill@example.com",
          "description": "Alternative host emails or IDs. Multiple values separated by comma."
        },
        "registration_type": {
          "enum": [
            1,
            2,
            3
          ],
          "type": "integer",
          "default": 1,
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Attendees register once and can attend any of the occurrences",
              "Attendees need to register for each occurrence to attend",
              "Attendees register once and can choose one or more occurrences to attend"
            ]
          },
          "description": "Registration types. Only used for recurring webinars with a fixed time.  \n `1` - Attendees register once and can attend any of the webinar sessions.  \n `2` - Attendees need to register for each session in order to attend.  \n `3` - Attendees register once and can choose one or more sessions to attend."
        },
        "show_share_button": {
          "type": "boolean",
          "example": true,
          "description": "Show social share buttons on the registration page."
        },
        "close_registration": {
          "type": "boolean",
          "example": true,
          "deprecated": true,
          "description": "Close registration after event date."
        },
        "notify_registrants": {
          "type": "boolean",
          "example": true,
          "description": "Send notification email to registrants when the host updates a webinar."
        },
        "add_audio_watermark": {
          "type": "boolean",
          "example": true,
          "description": "Add audio watermark that identifies the participants."
        },
        "authentication_name": {
          "type": "string",
          "example": "Sign in to Zoom",
          "description": "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)."
        },
        "post_webinar_survey": {
          "type": "boolean",
          "example": true,
          "description": "Zoom will open a survey page in attendees' browsers after leaving the webinar"
        },
        "question_and_answer": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "* `true`: Enable [Q&amp;A](https://support.zoom.us/hc/en-us/articles/203686015-Using-Q-A-as-the-webinar-host#:~:text=Overview,and%20upvote%20each%20other's%20questions.) for webinar.\n\n* `false`: Disable Q&amp;A for webinar."
            },
            "auto_reply_text": {
              "type": "string",
              "example": "Thank you for your question. We will get back to you shortly.",
              "description": "If `allow_auto_reply` = true, the text to be included in the automatic response. "
            },
            "allow_auto_reply": {
              "type": "boolean",
              "example": true,
              "description": "If simulive webinar, \n\n* `true`: allow auto-reply to attendees. \n\n* `false`: don't allow auto-reply to the attendees."
            },
            "answer_questions": {
              "enum": [
                "only",
                "all"
              ],
              "type": "string",
              "example": "all",
              "description": "Indicate whether you want attendees to be able to view answered questions only or view all questions.\n\n* `only`: Attendees are able to view answered questions only.\n\n*  `all`: Attendees are able to view all questions submitted in the Q&amp;A."
            },
            "attendees_can_upvote": {
              "type": "boolean",
              "example": true,
              "description": "* `true`: Attendees can click the thumbs up button to bring popular questions to the top of the Q&amp;A window.\n\n* `false`: Attendees can not click the thumbs up button on questions."
            },
            "attendees_can_comment": {
              "type": "boolean",
              "example": true,
              "description": "* `true`: Attendees can answer questions or leave a comment in the question thread.\n\n* `false`: Attendees can not answer questions or leave a comment in the question thread"
            },
            "allow_submit_questions": {
              "type": "boolean",
              "example": true,
              "description": "* `true`: Allow participants to submit questions.\n\n* `false`: Do not allow submit questions."
            },
            "allow_anonymous_questions": {
              "type": "boolean",
              "example": true,
              "description": "* `true`: Allow participants to send questions without providing their name to the host, co-host, and panelists..\n\n* `false`: Do not allow anonymous questions."
            }
          },
          "description": "[Q&amp;A](https://support.zoom.us/hc/en-us/articles/203686015-Using-Q-A-as-the-webinar-host#:~:text=Overview,and%20upvote%20each%20other's%20questions.) for webinar."
        },
        "audio_conference_info": {
          "type": "string",
          "example": "test",
          "maxLength": 2048,
          "description": "Third party audio conference info."
        },
        "authentication_option": {
          "type": "string",
          "example": "signIn_D8cJuqWVQ623CI4Q8yQK0Q",
          "description": "Webinar authentication option ID."
        },
        "enforce_login_domains": {
          "type": "string",
          "example": "example.com",
          "deprecated": true,
          "description": "Only signed in users with specified domains can join meetings.\n\n**This field is deprecated and will not be supported in the future.**\n\n 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 webinar."
        },
        "allow_multiple_devices": {
          "type": "boolean",
          "example": true,
          "description": "Allow attendees to join from multiple devices."
        },
        "authentication_domains": {
          "type": "string",
          "example": "example.com",
          "description": "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."
        },
        "hd_video_for_attendees": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether HD video for attendees is enabled."
        },
        "meeting_authentication": {
          "type": "boolean",
          "example": true,
          "description": "Only authenticated users can join Webinar."
        },
        "enable_session_branding": {
          "type": "boolean",
          "example": true,
          "description": "Whether the **Webinar Session Branding** setting is enabled. This setting lets hosts visually customize a webinar by setting a session background. This also lets hosts use [Webinar Session Branding](https://support.zoom.us/hc/en-us/articles/4836268732045-Using-Webinar-Session-Branding) to set the Virtual Background for and apply name tags to hosts, alternative hosts, panelists, interpreters, and speakers."
        },
        "language_interpretation": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "Enable [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars) for the webinar."
            },
            "interpreters": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "format": "email",
                    "example": "interpreter@example.com",
                    "description": "The interpreter's email address."
                  },
                  "languages": {
                    "type": "string",
                    "example": "US,CN",
                    "description": "A comma-separated list of the interpreter's languages. The string must contain two [country IDs](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries). \n\nFor example, if the interpreter will translate from English to Chinese, then this value will be `US,CN`."
                  }
                }
              },
              "description": "Information about the webinar's language interpreters."
            }
          },
          "description": "The webinar's [language interpretation settings](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** This feature is only available for certain Webinar add-on, Education, and Business and higher plans. If this feature is not enabled on the host's account, this setting will **not** be applied to the webinar."
        },
        "panelist_authentication": {
          "type": "boolean",
          "example": true,
          "description": "Require panelists to authenticate to join"
        },
        "global_dial_in_countries": {
          "type": "array",
          "items": {
            "type": "string",
            "example": "US"
          },
          "description": "List of global dial-in countries"
        },
        "registrants_restrict_number": {
          "type": "integer",
          "default": 0,
          "example": 100,
          "maximum": 20000,
          "minimum": 0,
          "description": "Restrict number of registrants for a webinar. By default, it is set to `0`. A `0` value means that the restriction option is disabled. Provide a number higher than 0 to restrict the webinar registrants by the that number."
        },
        "sign_language_interpretation": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "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 webinar."
            },
            "interpreters": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "format": "email",
                    "example": "interpreter@example.com",
                    "description": "The interpreter's email address."
                  },
                  "sign_language": {
                    "type": "string",
                    "example": "American",
                    "description": "The interpreter's sign language. \n\n To get this value, use the `sign_language_interpretation` object's `languages` and `custom_languages` values in the [**Get user settings**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods#operation/userSettings) API response."
                  }
                }
              },
              "maximum": 20,
              "description": "Information about the webinar's sign language interpreters."
            }
          },
          "description": "The webinar's [sign language interpretation settings](https://support.zoom.us/hc/en-us/articles/9644962487309-Using-sign-language-interpretation-in-a-meeting-or-webinar). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** If this feature is not enabled on the host's account, this setting will **not** be applied to the webinar."
        },
        "alternative_host_update_polls": {
          "type": "boolean",
          "example": true,
          "description": "Whether the **Allow alternative hosts to add or edit polls** feature is enabled. This requires Zoom version 5.8.0 or higher."
        },
        "send_1080p_video_to_attendees": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Always send 1080p video to attendees."
        },
        "registrants_confirmation_email": {
          "type": "boolean",
          "example": true,
          "description": "Send confirmation email to registrants"
        },
        "registrants_email_notification": {
          "type": "boolean",
          "example": true,
          "description": "Send email notifications to registrants about approval, cancellation, denial of the registration. The value of this field must be set to true in order to use the `registrants_confirmation_email` field."
        },
        "follow_up_absentees_email_notification": {
          "type": "object",
          "properties": {
            "type": {
              "enum": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7
              ],
              "type": "integer",
              "example": 0,
              "extensions": {
                "x-enum-descriptions": [
                  "Send 1 days after the scheduled end date.",
                  "Send 2 days after the scheduled end date.",
                  "Send 3 days after the scheduled end date.",
                  "Send 4 days after the scheduled end date.",
                  "Send 5 days after the scheduled end date.",
                  "Send 6 days after the scheduled end date.",
                  "Send 7 days after the scheduled end date."
                ]
              },
              "description": "`0` - No plan.  \n `1` - Send 1 days after the scheduled end date.  \n `2` - Send 2 days after the scheduled end date.  \n `3` - Send 3 days after the scheduled end date.  \n `4` - Send 4 days after the scheduled end date.  \n `5` - Send 5 days after the scheduled end date.  \n `6` - Send 6 days after the scheduled end date.  \n `7` - Send 7 days after the scheduled end date."
            },
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "* `true`: Send follow-up email to absentees.\n\n* `false`: Do not send follow-up email to absentees."
            }
          },
          "description": "Send follow-up email to absentees."
        },
        "follow_up_attendees_email_notification": {
          "type": "object",
          "properties": {
            "type": {
              "enum": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7
              ],
              "type": "integer",
              "example": 0,
              "extensions": {
                "x-enum-descriptions": [
                  "Send 1 day after the scheduled end date.",
                  "Send 2 days after the scheduled end date.",
                  "Send 3 days after the scheduled end date.",
                  "Send 4 days after the scheduled end date.",
                  "Send 5 days after the scheduled end date.",
                  "Send 6 days after the scheduled end date.",
                  "Send 7 days after the scheduled end date."
                ]
              },
              "description": "`0` - No plan.  \n `1` - Send 1 day after the scheduled end date.  \n `2` - Send 2 days after the scheduled end date.  \n `3` - Send 3 days after the scheduled end date.  \n `4` - Send 4 days after the scheduled end date.  \n `5` - Send 5 days after the scheduled end date.  \n `6` - Send 6 days after the scheduled end date.  \n `7` - Send 7 days after the scheduled end date."
            },
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "* `true`: Send follow-up email to attendees.\n\n* `false`: Do not send follow-up email to attendees."
            }
          },
          "description": "Send follow-up email to attendees."
        },
        "panelists_invitation_email_notification": {
          "type": "boolean",
          "example": true,
          "description": "Send invitation email to panelists. If `false`, do not send invitation email to panelists."
        },
        "attendees_and_panelists_reminder_email_notification": {
          "type": "object",
          "properties": {
            "type": {
              "enum": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7
              ],
              "type": "integer",
              "example": 0,
              "extensions": {
                "x-enum-descriptions": [
                  "Send 1 hour before webinar.",
                  "Send 1 day before webinar.",
                  "Send 1 hour and 1 day before webinar.",
                  "Send 1 week before webinar.",
                  "Send 1 hour and 1 week before webinar.",
                  "Send 1 day and 1 week before webinar.",
                  "Send 1 hour, 1 day and 1 week before webinar."
                ]
              },
              "description": "`0` - No plan.  \n `1` - Send 1 hour before webinar.  \n `2` - Send 1 day before webinar.  \n `3` - Send 1 hour and 1 day before webinar.  \n `4` - Send 1 week before webinar.  \n `5` - Send 1 hour and 1 week before webinar.  \n `6` - Send 1 day and 1 week before webinar.  \n `7` - Send 1 hour, 1 day and 1 week before webinar."
            },
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Send reminder email to attendees and panelists.\n\n* `false` - Do not send reminder email to attendees and panelists."
            }
          },
          "description": "Send reminder email to attendees and panelists."
        }
      },
      "description": "Webinar settings."
    },
    "timezone": {
      "type": "string",
      "example": "America/Los_Angeles",
      "description": "Time zone to format start_time."
    },
    "start_url": {
      "type": "string",
      "example": "https://example.com/s/11111",
      "description": "  \n The `start_url` of a webinar is a URL using which a host or an alternative host can start the webinar. This URL should only be used by the host of the meeting and should not be shared with anyone other than the host of the webinar. \n\nThe expiration time for the `start_url` field listed in the response of the [**Create a webinar**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods#operation/webinarCreate) API is two hours for all regular users. \n\t\nFor users created using the `custCreate` option via the [**Create users**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods#operation/userCreate) API, the expiration time of the `start_url` field is 90 days.\n\t\nFor security reasons, to retrieve the latest value for the `start_url` field programmatically after expiry, call the [**Get a webinar**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods#operation/webinar) API and refer to the value of the `start_url` field in the response.  \n   \n   \n "
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-26T07:18:32Z",
      "description": "Create time."
    },
    "host_email": {
      "type": "string",
      "format": "email",
      "example": "jchill@example.com",
      "description": "Email address of the meeting host."
    },
    "recurrence": {
      "type": "object",
      "title": "Recurrence webinar",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "enum": [
            1,
            2,
            3
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Daily",
              "Weekly",
              "Monthly"
            ]
          },
          "description": "Recurrence webinar types. \n `1` - Daily.  \n `2` - Weekly.  \n `3` - Monthly."
        },
        "end_times": {
          "type": "integer",
          "default": 1,
          "example": 7,
          "maximum": 60,
          "description": "Select how many times the webinar will recur before it is canceled. The maximum number of recurring is 60. Can't be used with `end_date_time`."
        },
        "monthly_day": {
          "type": "integer",
          "example": 1,
          "description": "Use this field **only if you're scheduling a recurring webinar of type** `3` to state which day in a month the webinar should recur. The value range is from 1 to 31.\n\nFor instance, if you would like the webinar to recur on 23rd of each month, provide `23` as the value of this field and `1` as the value of the `repeat_interval` field. Instead, if you would like the webinar to recur once every three months, on 23rd of the month, change the value of the `repeat_interval` field to `3`."
        },
        "weekly_days": {
          "type": "string",
          "example": "1",
          "description": "Use this field **only if you're scheduling a recurring webinar of type** `2` to state which day(s) of the week the webinar should repeat.   \n  The value for this field could be a number between `1` to `7` in string format. For instance, if the Webinar should recur on Sunday, provide `1` as the value of this field.\n\n**Note:** If you would like the webinar to occur on multiple days of a week, you should provide comma separated values for this field. For instance, if the webinar should recur on Sundays and Tuesdays, provide `1,3` as the value of this field.\n\n  \n `1` - Sunday.   \n `2` - Monday.  \n `3` - Tuesday.  \n `4` -  Wednesday.  \n `5` -  Thursday.  \n `6` - Friday.  \n `7` - Saturday.\n\n"
        },
        "monthly_week": {
          "enum": [
            -1,
            1,
            2,
            3,
            4
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Last week",
              "First week",
              "Second week",
              "Third week",
              "Fourth week"
            ]
          },
          "description": "Use this field **only if you're scheduling a recurring webinar of type** `3` to state the week of the month when the webinar 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 webinar should recur.**   \n `-1` - Last week of the month.  \n `1` - First week of the month.  \n `2` - Second week of the month.  \n `3` - Third week of the month.  \n `4` - Fourth week of the month."
        },
        "end_date_time": {
          "type": "string",
          "format": "date-time",
          "example": "2022-04-02T15:59:00Z",
          "description": "Select a date when the webinar will recur before it is canceled. Should be in UTC time, such as 2017-11-25T12:00:00Z. Can't be used with `end_times`."
        },
        "repeat_interval": {
          "type": "integer",
          "example": 1,
          "description": "Define the interval when the webinar should recur. For instance, if you would like to schedule a Webinar that recurs every two months, you must set the value of this field as `2` and the value of the `type` parameter as `3`. \n\nFor a daily webinar, the maximum interval you can set is `90` days. For a weekly webinar, the maximum interval that you can set is `12` weeks. For a monthly webinar, the maximum interval that you can set is `3` months."
        },
        "monthly_week_day": {
          "enum": [
            1,
            2,
            3,
            4,
            5,
            6,
            7
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Sunday",
              "Monday",
              "Tuesday",
              "Wednesday",
              "Thursday",
              "Friday",
              "Saturday"
            ]
          },
          "description": "Use this field **only if you're scheduling a recurring webinar of type** `3` to state a specific day in a week when the monthly webinar should recur. To use this field, you must also use the `monthly_week` field.   \n `1` - Sunday.  \n `2` - Monday.  \n `3` - Tuesday.  \n `4` -  Wednesday.  \n `5` - Thursday.  \n `6` - Friday.  \n `7` - Saturday."
        }
      },
      "description": "Recurrence object. Use this object only for a webinar of type `9` i.e., a recurring webinar with fixed time. "
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-26T07:18:32Z",
      "description": "Webinar start time in GMT/UTC."
    },
    "is_simulive": {
      "type": "boolean",
      "example": true,
      "description": "Whether the webinar is `simulive`."
    },
    "occurrences": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "status": {
            "enum": [
              "available",
              "deleted"
            ],
            "type": "string",
            "example": "available",
            "description": "Occurrence status. \n `available` - Available occurrence.  \n `deleted` -  Deleted occurrence."
          },
          "duration": {
            "type": "integer",
            "example": 60,
            "description": "Duration."
          },
          "start_time": {
            "type": "string",
            "format": "date-time",
            "example": "2022-03-25T07:46:00Z",
            "description": "Start time."
          },
          "occurrence_id": {
            "type": "string",
            "example": "1648194360000",
            "description": "Occurrence ID: Unique Identifier that identifies 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."
          }
        },
        "description": "Occurrence object. This object is only returned for recurring webinars."
      },
      "description": "Array of occurrence objects."
    },
    "template_id": {
      "type": "string",
      "example": "ull6574eur",
      "description": "Unique identifier of the webinar template. Use this field only if you would like to [schedule the webinar using an existing template](https://support.zoom.us/hc/en-us/articles/115001079746-Webinar-Templates#schedule). The value of this field can be retrieved from [**List webinar templates**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods#operation/listWebinarTemplates) API.\nYou must provide the user ID of the host instead of the email address in the `userId` path parameter in order to use a template for scheduling a Webinar."
    },
    "h323_passcode": {
      "type": "string",
      "example": "123456",
      "description": "H.323/SIP room system passcode."
    },
    "record_file_id": {
      "type": "string",
      "example": "f09340e1-cdc3-4eae-9a74-98f9777ed908",
      "description": "The previously recorded file's ID for `simulive`."
    },
    "tracking_fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "example": "field1",
            "description": "Tracking fields type"
          },
          "value": {
            "type": "string",
            "example": "value1",
            "description": "Tracking fields value"
          }
        }
      },
      "description": "Tracking fields"
    },
    "encrypted_passcode": {
      "type": "string",
      "example": "8pEkRweVXPV3Ob2KJYgFTRlDtl1gSn.1",
      "description": "Encrypted passcode for third party endpoints (H323/SIP)."
    },
    "registrants_confirmation_email": {
      "type": "boolean",
      "example": true,
      "description": "Specify whether or not registrants of this webinar should receive confirmation emails."
    }
  },
  "description": "Webinar object."
}

object WebinarsCreateWebinarTemplateRequest

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "example": "Weekly Meeting Template",
      "description": "The webinar template's name."
    },
    "overwrite": {
      "type": "boolean",
      "default": false,
      "example": false,
      "description": "Overwrite an existing webinar template if the template is created from same existing webinar."
    },
    "webinar_id": {
      "type": "integer",
      "format": "int64",
      "example": 96172769962,
      "description": "The webinar ID in long (int64) format."
    },
    "save_recurrence": {
      "type": "boolean",
      "default": false,
      "example": false,
      "description": "If the field is set to true, the recurrence webinar template will be saved as the scheduled webinar."
    }
  }
}

object WebinarsCreateWebinarTemplateResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "ull6574eur",
      "description": "The webinar template's ID."
    },
    "name": {
      "type": "string",
      "example": "Weekly Meeting Template",
      "description": "The webinar template's name."
    }
  }
}

object WebinarsGetDetailsResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 97871060099,
      "description": "Webinar ID in **long** format(represented as int64 data type in JSON), also known as the webinar number."
    },
    "type": {
      "enum": [
        5,
        6,
        9
      ],
      "type": "integer",
      "default": 5,
      "example": 5,
      "extensions": {
        "x-enum-descriptions": [
          "Webinar",
          "Recurring Webinar with no fixed time",
          "Recurring Webinar with fixed time"
        ]
      },
      "description": "Webinar types. \n `5` - Webinar.  \n `6` - Recurring webinar with no fixed time.  \n `9` - Recurring webinar with a fixed time."
    },
    "uuid": {
      "type": "string",
      "example": "m3WqMkvuRXyYqH+eKWhk9w==",
      "description": "Unique webinar ID. Each webinar instance will generate its own webinar UUID. After a webinar ends, a new UUID is generated for the next instance of the webinar. Retrieve a list of UUIDs from past webinar instances using the [**List past webinar instances**](https://developers.zoom.us) API. [Double encode](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#meeting-id-and-uuid) your UUID when using it for API calls if the UUID begins with a `/` or contains `//` in it.\n\n"
    },
    "topic": {
      "type": "string",
      "example": "My Webinar",
      "maxLength": 200,
      "description": "Webinar topic."
    },
    "agenda": {
      "type": "string",
      "example": "My webinar",
      "description": "Webinar agenda."
    },
    "host_id": {
      "type": "string",
      "example": "30R7kT7bTIKSNUFEuH_Qlg",
      "description": "ID of the user set as host of webinar."
    },
    "duration": {
      "type": "integer",
      "example": 60,
      "description": "Webinar duration."
    },
    "join_url": {
      "type": "string",
      "example": "https://example.com/j/11111",
      "description": "URL to join the webinar. Only share this URL with the users who should be invited to the webinar."
    },
    "password": {
      "type": "string",
      "example": "123456",
      "maxLength": 10,
      "description": "Webinar passcode. \n\nIf **Require a passcode when scheduling new meetings** setting has been **enabled** **and** [locked](https://support.zoom.us/hc/en-us/articles/115005269866-Using-Tiered-Settings#locked) for the user, the passcode field will be autogenerated for the Webinar in the response even if it is not provided in the API request.   \n   \n \n**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.   \n   \n If the requirements are enabled, you can 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."
    },
    "settings": {
      "type": "object",
      "properties": {
        "audio": {
          "enum": [
            "both",
            "telephony",
            "voip",
            "thirdParty"
          ],
          "type": "string",
          "default": "both",
          "example": "telephony",
          "extensions": {
            "x-enum-descriptions": [
              "Both Telephony and VoIP",
              "Telephony only",
              "VoIP only",
              "Third party audio conference"
            ]
          },
          "description": "Determine how participants can join the audio portion of the webinar."
        },
        "hd_video": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Default to HD video."
        },
        "on_demand": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Make the webinar on-demand."
        },
        "host_video": {
          "type": "boolean",
          "example": true,
          "description": "Start video when host joins webinar."
        },
        "survey_url": {
          "type": "string",
          "example": "https://example.com",
          "description": "Survey URL for post webinar survey."
        },
        "contact_name": {
          "type": "string",
          "example": "Jill Chill",
          "description": "Contact name for registration."
        },
        "add_watermark": {
          "type": "boolean",
          "example": true,
          "description": "Add watermark that identifies the viewing participant."
        },
        "approval_type": {
          "enum": [
            0,
            1,
            2
          ],
          "type": "integer",
          "default": 2,
          "example": 0,
          "extensions": {
            "x-enum-descriptions": [
              "Automatically Approve",
              "Manually Approve",
              "No Registration Required"
            ]
          },
          "description": "`0` - Automatically approve.  \n `1` - Manually approve.  \n `2` - No registration required."
        },
        "contact_email": {
          "type": "string",
          "example": "jchill@example.com",
          "description": "Contact email for registration."
        },
        "enforce_login": {
          "type": "boolean",
          "example": true,
          "deprecated": true,
          "description": "Only signed in users can join this meeting.\n\n**This field is deprecated and will not be supported in the future.**    \n\n 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 Webinar."
        },
        "auto_recording": {
          "enum": [
            "local",
            "cloud",
            "none"
          ],
          "type": "string",
          "default": "none",
          "example": "cloud",
          "extensions": {
            "x-enum-descriptions": [
              "Record to local device",
              "Record to cloud",
              "No Recording"
            ]
          },
          "description": "Automatic recording. \n `local` - Record on local.  \n `cloud` -  Record on cloud.  \n `none` - Disabled."
        },
        "email_language": {
          "type": "string",
          "example": "en-US",
          "description": "Set the email language. The only options are\n`en-US`,`de-DE`,`es-ES`,`fr-FR`,`jp-JP`,`pt-PT`,`ru-RU`,`zh-CN`, `zh-TW`, `ko-KO`, `it-IT`, `vi-VN`."
        },
        "panelists_video": {
          "type": "boolean",
          "example": true,
          "description": "Start video when panelists join webinar."
        },
        "practice_session": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Enable practice session."
        },
        "alternative_hosts": {
          "type": "string",
          "example": "jchill@example.com",
          "description": "Alternative host emails or IDs. Multiple values separated by comma."
        },
        "registration_type": {
          "enum": [
            1,
            2,
            3
          ],
          "type": "integer",
          "default": 1,
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Attendees register once and can attend any of the occurrences",
              "Attendees need to register for each occurrence to attend",
              "Attendees register once and can choose one or more occurrences to attend"
            ]
          },
          "description": "Registration types. Only used for recurring webinars with a fixed time.  \n `1` - Attendees register once and can attend any of the webinar sessions.  \n `2` - Attendees need to register for each session in order to attend.  \n `3` - Attendees register once and can choose one or more sessions to attend."
        },
        "show_share_button": {
          "type": "boolean",
          "example": true,
          "description": "Show social share buttons on the registration page."
        },
        "close_registration": {
          "type": "boolean",
          "example": true,
          "deprecated": true,
          "description": "Close registration after event date."
        },
        "notify_registrants": {
          "type": "boolean",
          "example": true,
          "description": "Send notification email to registrants when the host updates a webinar."
        },
        "add_audio_watermark": {
          "type": "boolean",
          "example": true,
          "description": "Add audio watermark that identifies the participants."
        },
        "authentication_name": {
          "type": "string",
          "example": "Sign in to Zoom",
          "description": "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)."
        },
        "post_webinar_survey": {
          "type": "boolean",
          "example": true,
          "description": "Zoom will open a survey page in attendees' browsers after leaving the webinar."
        },
        "question_and_answer": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "* `true`: Enable [Q&amp;A](https://support.zoom.us/hc/en-us/articles/203686015-Using-Q-A-as-the-webinar-host#:~:text=Overview,and%20upvote%20each%20other's%20questions.) for webinar.\n\n* `false`: Disable Q&amp;A for webinar."
            },
            "auto_reply_text": {
              "type": "string",
              "example": "Thank you for your question. We will get back to you shortly.",
              "description": "If `allow_auto_reply` = true, the text to be included in the automatic response. "
            },
            "allow_auto_reply": {
              "type": "boolean",
              "example": true,
              "description": "If simulive webinar, \n\n* `true` - allow auto-reply to attendees. \n\n* `false` - don't allow auto-reply to the attendees."
            },
            "answer_questions": {
              "enum": [
                "only",
                "all"
              ],
              "type": "string",
              "example": "all",
              "description": "Indicate whether you want attendees to be able to view answered questions only or view all questions.\n\n* `only` - Attendees are able to view answered questions only.\n\n*  `all` - Attendees are able to view all questions submitted in the Q&amp;A."
            },
            "attendees_can_upvote": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Attendees can click the thumbs up button to bring popular questions to the top of the Q&amp;A window.\n\n* `false` - Attendees can not click the thumbs up button on questions."
            },
            "attendees_can_comment": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Attendees can answer questions or leave a comment in the question thread.\n\n* `false` - Attendees can not answer questions or leave a comment in the question thread"
            },
            "allow_submit_questions": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Allow participants to submit questions.\n\n* `false` - Do not allow submit questions."
            },
            "allow_anonymous_questions": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Allow participants to send questions without providing their name to the host, co-host, and panelists.\n\n* `false` - Do not allow anonymous questions."
            }
          },
          "description": "[Q&amp;A](https://support.zoom.us/hc/en-us/articles/203686015-Using-Q-A-as-the-webinar-host#:~:text=Overview,and%20upvote%20each%20other's%20questions.) for webinar."
        },
        "audio_conference_info": {
          "type": "string",
          "example": "test",
          "maxLength": 2048,
          "description": "Third party audio conference info."
        },
        "authentication_option": {
          "type": "string",
          "example": "signIn_D8cJuqWVQ623CI4Q8yQK0Q",
          "description": "Webinar authentication option id."
        },
        "enforce_login_domains": {
          "type": "string",
          "example": "example.com",
          "deprecated": true,
          "description": "Only signed in users with specified domains can join meetings.\n\n**This field is deprecated and will not be supported in the future.**    \n\n 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 Webinar."
        },
        "allow_multiple_devices": {
          "type": "boolean",
          "example": true,
          "description": "Allow attendees to join from multiple devices."
        },
        "authentication_domains": {
          "type": "string",
          "example": "example.com",
          "description": "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."
        },
        "hd_video_for_attendees": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether HD video for attendees is enabled."
        },
        "meeting_authentication": {
          "type": "boolean",
          "example": true,
          "description": "Only authenticated users can join the webinar."
        },
        "enable_session_branding": {
          "type": "boolean",
          "example": true,
          "description": "Whether the **Webinar Session Branding** setting is enabled. This setting lets hosts visually customize a webinar by setting a session background. This also lets hosts use [webinar session branding](https://support.zoom.us/hc/en-us/articles/4836268732045-Using-Webinar-Session-Branding) to set the Virtual Background for and apply name tags to hosts, alternative hosts, panelists, interpreters, and speakers."
        },
        "language_interpretation": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "Enable [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars) for the webinar."
            },
            "interpreters": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "format": "email",
                    "example": "interpreter@example.com",
                    "description": "The interpreter's email address."
                  },
                  "languages": {
                    "type": "string",
                    "example": "US,CN",
                    "description": "A comma-separated list of the interpreter's languages. The string must contain two [country IDs](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries). \n\nFor example, if the interpreter will translate from English to Chinese, then this value will be `US,CN`."
                  }
                }
              },
              "description": "Information about the webinar's language interpreters."
            }
          },
          "description": "The webinar's [language interpretation settings](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** This feature is only available for certain Webinar add-on, Education, and Business and higher plans. If this feature is not enabled on the host's account, this setting will **not** be applied to the webinar."
        },
        "panelist_authentication": {
          "type": "boolean",
          "example": true,
          "description": "Require panelists to authenticate to join."
        },
        "global_dial_in_countries": {
          "type": "array",
          "items": {
            "type": "string",
            "example": "US"
          },
          "description": "List of global dial-in countries"
        },
        "registrants_restrict_number": {
          "type": "integer",
          "default": 0,
          "example": 100,
          "maximum": 20000,
          "minimum": 0,
          "description": "Restrict number of registrants for a webinar. By default, it is set to `0`. A `0` value means that the restriction option is disabled. Provide a number higher than 0 to restrict the webinar registrants by the that number."
        },
        "sign_language_interpretation": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "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 webinar."
            },
            "interpreters": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "format": "email",
                    "example": "interpreter@example.com",
                    "description": "The interpreter's email address."
                  },
                  "sign_language": {
                    "type": "string",
                    "example": "American",
                    "description": "The interpreter's sign language. \n\n To get this value, use the `sign_language_interpretation` object's `languages` and `custom_languages` values in the [**Get user settings**](/api-reference/zoom-api/methods#operation/userSettings) API response."
                  }
                }
              },
              "maximum": 20,
              "description": "Information about the webinar's sign language interpreters."
            }
          },
          "description": "The webinar's [sign language interpretation settings](https://support.zoom.us/hc/en-us/articles/9644962487309-Using-sign-language-interpretation-in-a-meeting-or-webinar). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** If this feature is not enabled on the host's account, this setting will **not** be applied to the webinar."
        },
        "alternative_host_update_polls": {
          "type": "boolean",
          "example": true,
          "description": "Whether the **Allow alternative hosts to add or edit polls** feature is enabled. This requires Zoom version 5.8.0 or higher."
        },
        "send_1080p_video_to_attendees": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Always send 1080p video to attendees."
        },
        "registrants_confirmation_email": {
          "type": "boolean",
          "example": true,
          "description": "Send confirmation email to registrants"
        },
        "registrants_email_notification": {
          "type": "boolean",
          "example": true,
          "description": "Send email notifications to registrants about approval, cancellation, denial of the registration. The value of this field must be set to true in order to use the `registrants_confirmation_email` field."
        },
        "follow_up_absentees_email_notification": {
          "type": "object",
          "properties": {
            "type": {
              "enum": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7
              ],
              "type": "integer",
              "example": 0,
              "extensions": {
                "x-enum-descriptions": [
                  "Send 1 days after the scheduled end date.",
                  "Send 2 days after the scheduled end date.",
                  "Send 3 days after the scheduled end date.",
                  "Send 4 days after the scheduled end date.",
                  "Send 5 days after the scheduled end date.",
                  "Send 6 days after the scheduled end date.",
                  "Send 7 days after the scheduled end date."
                ]
              },
              "description": "`0` - No plan.  \n `1` - Send 1 days after the scheduled end date.  \n `2` - Send 2 days after the scheduled end date.  \n `3` - Send 3 days after the scheduled end date.  \n `4` - Send 4 days after the scheduled end date.  \n `5` - Send 5 days after the scheduled end date.  \n `6` - Send 6 days after the scheduled end date.  \n `7` - Send 7 days after the scheduled end date."
            },
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Send follow-up email to absentees.\n\n* `false` - Do not send follow-up email to absentees."
            }
          },
          "description": "Send follow-up email to absentees."
        },
        "follow_up_attendees_email_notification": {
          "type": "object",
          "properties": {
            "type": {
              "enum": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7
              ],
              "type": "integer",
              "example": 0,
              "extensions": {
                "x-enum-descriptions": [
                  "Send 1 day after the scheduled end date.",
                  "Send 2 days after the scheduled end date.",
                  "Send 3 days after the scheduled end date.",
                  "Send 4 days after the scheduled end date.",
                  "Send 5 days after the scheduled end date.",
                  "Send 6 days after the scheduled end date.",
                  "Send 7 days after the scheduled end date."
                ]
              },
              "description": "`0` - No plan.  \n `1` - Send 1 day after the scheduled end date.  \n `2` - Send 2 days after the scheduled end date.  \n `3` - Send 3 days after the scheduled end date.  \n `4` - Send 4 days after the scheduled end date.  \n `5` - Send 5 days after the scheduled end date.  \n `6` - Send 6 days after the scheduled end date.  \n `7` - Send 7 days after the scheduled end date."
            },
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Send follow-up email to attendees.\n\n* `false` - Do not send follow-up email to attendees."
            }
          },
          "description": "Send follow-up email to attendees."
        },
        "panelists_invitation_email_notification": {
          "type": "boolean",
          "example": true,
          "description": "Send invitation email to panelists. If `false`, do not send invitation email to panelists."
        },
        "attendees_and_panelists_reminder_email_notification": {
          "type": "object",
          "properties": {
            "type": {
              "enum": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7
              ],
              "type": "integer",
              "example": 0,
              "extensions": {
                "x-enum-descriptions": [
                  "Send 1 hour before webinar.",
                  "Send 1 day before webinar.",
                  "Send 1 hour and 1 day before webinar.",
                  "Send 1 week before webinar.",
                  "Send 1 hour and 1 week before webinar.",
                  "Send 1 day and 1 week before webinar.",
                  "Send 1 hour, 1 day and 1 week before webinar."
                ]
              },
              "description": "`0` - No plan.  \n `1` - Send 1 hour before webinar.  \n `2` - Send 1 day before webinar.  \n `3` - Send 1 hour and 1 day before webinar.  \n `4` - Send 1 week before webinar.  \n `5` - Send 1 hour and 1 week before webinar.  \n `6` - Send 1 day and 1 week before webinar.  \n `7` - Send 1 hour, 1 day and 1 week before webinar."
            },
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Send reminder email to attendees and panelists.\n\n* `false` - Do not send reminder email to attendees and panelists."
            }
          },
          "description": "Send reminder email to attendees and panelists."
        }
      },
      "description": "Webinar settings."
    },
    "timezone": {
      "type": "string",
      "example": "America/Los_Angeles",
      "description": "Time zone to format `start_time`."
    },
    "start_url": {
      "type": "string",
      "example": "https://example.com/s/11111",
      "description": "  \n The `start_url` of a webinar is a URL using which a host or an alternative host can start the webinar. This URL should only be used by the host of the meeting and should not be shared with anyone other than the host of the webinar. \n\nThe expiration time for the `start_url` field listed in the response of the [**Create a webinar**](https://developers.zoom.us) API is two hours for all regular users. \n\t\nFor users created using the `custCreate` option via the [**Create users**](https://developers.zoom.us) API, the expiration time of the `start_url` field is 90 days.\n\t\nFor security reasons, to retrieve the latest value for the `start_url` field programmatically (after expiry), you must call the [**Get a webinar**](https://developers.zoom.us) API and refer to the value of the `start_url` field in the response.\n\n\n "
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-26T07:18:32Z",
      "description": "Create time."
    },
    "host_email": {
      "type": "string",
      "format": "email",
      "example": "jchill@example.com",
      "description": "Email address of the meeting host."
    },
    "recurrence": {
      "type": "object",
      "title": "Recurrence webinar",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "enum": [
            1,
            2,
            3
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Daily",
              "Weekly",
              "Monthly"
            ]
          },
          "description": "Recurrence webinar types.  \n `1` - Daily.  \n `2` - Weekly.  \n `3` - Monthly."
        },
        "end_times": {
          "type": "integer",
          "default": 1,
          "example": 7,
          "maximum": 60,
          "description": "Select how many times the webinar will recur before it is canceled. The maximum number of recurring is 60. Cannot be used with `end_date_time`."
        },
        "monthly_day": {
          "type": "integer",
          "example": 1,
          "description": "Use this field **only if you're scheduling a recurring webinar of type** `3` to state which day in a month, the webinar should recur. The value range is from 1 to 31.\n\nFor instance, if you would like the webinar to recur on 23rd of each month, provide `23` as the value of this field and `1` as the value of the `repeat_interval` field. Instead, if you would like the webinar to recur once every three months, on 23rd of the month, change the value of the `repeat_interval` field to `3`."
        },
        "weekly_days": {
          "type": "string",
          "example": "1",
          "description": "Use this field **only if you're scheduling a recurring webinar of type** `2` to state which day(s) of the week the webinar should repeat.   \n  The value for this field could be a number between `1` to `7` in string format. For instance, if the Webinar should recur on Sunday, provide `1` as the value of this field.    \n   \n  **Note:** If you would like the webinar to occur on multiple days of a week, you should provide comma separated values for this field. For instance, if the Webinar should recur on Sundays and Tuesdays provide `1,3` as the value of this field.\n\n  \n `1`  - Sunday.   \n `2` - Monday.  \n `3` - Tuesday.  \n `4` -  Wednesday.  \n `5` -  Thursday.  \n `6` - Friday.  \n `7` - Saturday.\n\n"
        },
        "monthly_week": {
          "enum": [
            -1,
            1,
            2,
            3,
            4
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Last week",
              "First week",
              "Second week",
              "Third week",
              "Fourth week"
            ]
          },
          "description": "Use this field **only if you're scheduling a recurring webinar of type** `3` to state the week of the month when the webinar 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 webinar should recur.**   \n `-1` - Last week of the month.  \n `1` - First week of the month.  \n `2` - Second week of the month.  \n `3` - Third week of the month.  \n `4` - Fourth week of the month."
        },
        "end_date_time": {
          "type": "string",
          "format": "date-time",
          "example": "2022-04-02T15:59:00Z",
          "description": "Select a date when the webinar will recur before it is canceled. Should be in UTC time, such as 2017-11-25T12:00:00Z. (Cannot be used with `end_times`.)"
        },
        "repeat_interval": {
          "type": "integer",
          "example": 1,
          "description": "Define the interval when the webinar should recur. For instance, to schedule a webinar that recurs every two months, you must set the value of this field as `2` and the value of the `type` parameter as `3`. \n\nFor a daily webinar, the maximum interval you can set is `90` days. For a weekly webinar, the maximum interval that you can set is `12` weeks. For a monthly webinar, the maximum interval that you can set is `3` months."
        },
        "monthly_week_day": {
          "enum": [
            1,
            2,
            3,
            4,
            5,
            6,
            7
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Sunday",
              "Monday",
              "Tuesday",
              "Wednesday",
              "Thursday",
              "Friday",
              "Saturday"
            ]
          },
          "description": "Use this field **only if you're scheduling a recurring webinar of type** `3` to state a specific day in a week when the monthly webinar should recur. To use this field, you must also use the `monthly_week` field.   \n `1` - Sunday.  \n `2` - Monday.  \n `3` - Tuesday.  \n `4` -  Wednesday.  \n `5` - Thursday.  \n `6` - Friday.  \n `7` - Saturday."
        }
      },
      "description": "Recurrence object. Use this object only for a webinar of type `9` i.e., a recurring webinar with fixed time. "
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-26T07:18:32Z",
      "description": "Webinar start time in GMT/UTC."
    },
    "is_simulive": {
      "type": "boolean",
      "example": true,
      "description": "Whether the webinar is `simulive`."
    },
    "occurrences": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "status": {
            "enum": [
              "available",
              "deleted"
            ],
            "type": "string",
            "example": "available",
            "description": "Occurrence status: \n `available` - Available occurrence.  \n `deleted` -  Deleted occurrence."
          },
          "duration": {
            "type": "integer",
            "example": 60,
            "description": "Duration."
          },
          "start_time": {
            "type": "string",
            "format": "date-time",
            "example": "2022-03-25T07:46:00Z",
            "description": "Start time."
          },
          "occurrence_id": {
            "type": "string",
            "example": "1648194360000",
            "description": "Occurrence ID: Unique Identifier that identifies 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."
          }
        },
        "description": "Occurrence object. This object is only returned for recurring webinars."
      },
      "description": "Array of occurrence objects."
    },
    "h323_passcode": {
      "type": "string",
      "example": "123456",
      "description": "H.323/SIP room system passcode."
    },
    "record_file_id": {
      "type": "string",
      "example": "f09340e1-cdc3-4eae-9a74-98f9777ed908",
      "description": "The previously recorded file's ID for `simulive`."
    },
    "tracking_fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "example": "field1",
            "description": "Tracking fields type."
          },
          "value": {
            "type": "string",
            "example": "value1",
            "description": "Tracking fields value."
          }
        }
      },
      "description": "Tracking fields."
    },
    "encrypted_passcode": {
      "type": "string",
      "example": "8pEkRweVXPV3Ob2KJYgFTRlDtl1gSn.1",
      "description": "Encrypted passcode for third party endpoints (H323/SIP)."
    }
  },
  "description": "Webinar object."
}

object WebinarsGetJoinTokenLocalRecordingResponse

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "example": "2njt50mj",
      "description": "The join token."
    },
    "expire_in": {
      "enum": [
        120
      ],
      "type": "integer",
      "format": "int64",
      "example": 120,
      "description": "The number of seconds the join token is valid for before it expires. This value always returns `120`."
    }
  },
  "description": "Information about the webinar's local recorder join token."
}

object WebinarsGetLiveStreamDetailsResponse

{
  "type": "object",
  "properties": {
    "page_url": {
      "type": "string",
      "example": "https://example.com/livestream/123",
      "description": "Live streaming page URL. This is the URL using which anyone can view the live stream of the webinar."
    },
    "resolution": {
      "type": "string",
      "example": "720p",
      "description": "The number of pixels in each dimension that the video camera can display."
    },
    "stream_key": {
      "type": "string",
      "example": "contact-it@example.com",
      "description": "Stream key."
    },
    "stream_url": {
      "type": "string",
      "example": "https://example.com/livestream",
      "description": "Stream URL."
    }
  }
}

object WebinarsGetMeetingArchiveTokenForLocalArchivingResponse

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "example": "2njt50mj",
      "description": "The archive token."
    },
    "expire_in": {
      "enum": [
        120
      ],
      "type": "integer",
      "format": "int64",
      "example": 120,
      "description": "The number of seconds the archive token is valid for before it expires. This value always returns `120`."
    }
  },
  "description": "Information about the webinar's local archive token."
}

object WebinarsGetPollDetailsResponse

{
  "type": "object",
  "title": "Meeting and Webinar Polling Object",
  "properties": {
    "id": {
      "type": "string",
      "example": "QalIoKWLTJehBJ8e1xRrbQ",
      "description": "Webinar Poll ID"
    },
    "title": {
      "type": "string",
      "example": "Learn something new",
      "maxLength": 64,
      "description": "The poll's title, up to 64 characters."
    },
    "status": {
      "enum": [
        "notstart",
        "started",
        "ended",
        "sharing"
      ],
      "type": "string",
      "example": "notstart",
      "extensions": {
        "x-enum-descriptions": [
          "Poll not start",
          "Poll started",
          "Poll ended",
          "Poll is sharing"
        ]
      },
      "description": "Status of the Webinar Poll:  \n `notstart` - Poll not started  \n `started` - Poll started  \n `ended` - Poll ended  \n `sharing` - Sharing poll results"
    },
    "anonymous": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Allow meeting participants to answer poll questions anonymously. \n\nThis value defaults to `false`."
    },
    "poll_type": {
      "enum": [
        1,
        2,
        3
      ],
      "type": "integer",
      "example": 2,
      "description": "The type of poll: \n* `1` &mdash; Poll. \n* `2` &mdash; Advanced Poll. This feature must be enabled in your Zoom account. \n* `3` &mdash; Quiz. This feature must be enabled in your Zoom account. \n\n This value defaults to `1`."
    },
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "How useful was this meeting?",
            "maxLength": 255,
            "description": "The poll question, up to 255 characters. \n\nFor `fill_in_the_blank` polls, this field is the poll's question. For each value that the user must fill in, ensure that there are the same number of `right_answers` values."
          },
          "type": {
            "enum": [
              "single",
              "multiple",
              "matching",
              "rank_order",
              "short_answer",
              "long_answer",
              "fill_in_the_blank",
              "rating_scale"
            ],
            "type": "string",
            "example": "single",
            "extensions": {
              "x-enum-descriptions": [
                "Single choice",
                "Multiple choice",
                "Matching",
                "Rank order",
                "Short answer",
                "Long answer",
                "Fill in the blank",
                "Rating scale"
              ]
            },
            "description": "The poll's question and answer type: \n* `single` &mdash; Single choice. \n* `multiple` &mdash; Multiple choice. \n* `matching` &mdash; Matching. \n* `rank_order` &mdash; Rank order. \n* `short_answer` &mdash; Short answer. \n* `long_answer` &mdash; Long answer. \n* `fill_in_the_blank` &mdash; Fill in the blank. \n* `rating_scale` &mdash; Rating scale."
          },
          "answers": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "Extremely useful"
            },
            "minItems": 2,
            "description": "The poll question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` polls, you can only provide a maximum of 10 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers."
          },
          "prompts": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "prompt_question": {
                  "type": "string",
                  "example": "How are you?",
                  "description": "The question prompt's title."
                },
                "prompt_right_answers": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "Good"
                  },
                  "description": "The question prompt's correct answers: \n* For `matching` polls, you must provide a minimum of two correct answers, up to a maximum of 10 correct answers. \n* For `rank_order` polls, you can only provide one correct answer."
                }
              }
            },
            "description": "Information about the prompt questions. This field only applies to `matching` and `rank_order` polls. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts."
          },
          "right_answers": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "Good"
            },
            "minItems": 1,
            "description": "The poll question's correct answer(s). This field is **required** if the poll's `type` value is `3` (Quiz). \n\n For `single` and `matching` polls, this field only accepts one answer."
          },
          "case_sensitive": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether the correct answer is case sensitive. This field only applies to `fill_in_the_blank` polls: \n* `true` &mdash; The answer is case-sensitive. \n* `false` &mdash; The answer is not case-sensitive. \n\nThis value defaults to `false`."
          },
          "answer_required": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether participants must answer the question: \n* `true` &mdash; The participant must answer the question. \n* `false` &mdash; The participant does not need to answer the question. \n\n**Note:** \n* When the poll's `type` value is `1` (Poll), this value defaults to `true`. \n* When the poll's `type` value is the `2` (Advanced Poll) or `3` (Quiz) values, this value defaults to `false`."
          },
          "rating_max_label": {
            "type": "string",
            "example": "Extremely Likely",
            "description": "The high score label used for the `rating_max_value` field. \n\nThis field only applies to the `rating_scale` poll."
          },
          "rating_max_value": {
            "type": "integer",
            "example": 4,
            "maximum": 10,
            "description": "The rating scale's maximum value, up to a maximum value of 10. \n\nThis field only applies to the `rating_scale` poll."
          },
          "rating_min_label": {
            "type": "string",
            "example": "Not likely",
            "description": "The low score label used for the `rating_min_value` field. \n\nThis field only applies to the `rating_scale` poll."
          },
          "rating_min_value": {
            "type": "integer",
            "example": 0,
            "minimum": 0,
            "description": "The rating scale's minimum value. This value cannot be less than zero. \n\nThis field only applies to the `rating_scale` poll."
          },
          "show_as_dropdown": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether to display the radio selection as a drop-down box: \n* `true` &mdash; Show as a drop-down box. \n* `false` &mdash; Do not show as a drop-down box. \n\nThis value defaults to `false`."
          },
          "answer_max_character": {
            "type": "integer",
            "example": 200,
            "description": "The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` polls: \n* For `short_answer` polls, a maximum of 500 characters. \n* For `long_answer` polls, a maximum of 2,000 characters."
          },
          "answer_min_character": {
            "type": "integer",
            "example": 1,
            "minimum": 1,
            "description": "The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` polls. You must provide at least a **one** character minimum value."
          }
        }
      },
      "description": "Information about the poll's questions."
    }
  },
  "description": "Information about meeting and webinar polling."
}

object WebinarsGetSessionBrandingResponse

{
  "type": "object",
  "properties": {
    "name_tags": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "zazQjwDuQkS3Q2EprNd7jQ",
            "description": "The name tag's ID."
          },
          "name": {
            "type": "string",
            "example": "name",
            "description": "The name tag's name."
          },
          "is_default": {
            "type": "boolean",
            "example": true,
            "description": "Whether the file is the default name tag or not."
          },
          "text_color": {
            "type": "string",
            "example": "0e72ed",
            "description": "The name tag's text color."
          },
          "accent_color": {
            "type": "string",
            "example": "0e72ed",
            "description": "The name tag's accent color."
          },
          "background_color": {
            "type": "string",
            "example": "0e72ed",
            "description": "The name tag's background color."
          }
        }
      },
      "description": "Information about the webinar's name tag."
    },
    "wallpaper": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "zazQjwDuQkS3Q2EprNd7jQ",
          "description": "The wallpaper's file ID."
        }
      },
      "description": "Information about the webinar's [Wallpaper] file."
    },
    "virtual_backgrounds": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "zazQjwDuQkS3Q2EprNd7jQ",
            "description": "The Virtual Background's file ID."
          },
          "name": {
            "type": "string",
            "example": "beach.jpg",
            "description": "The Virtual Background's file name."
          },
          "is_default": {
            "type": "boolean",
            "example": true,
            "description": "Whether the file is the default Virtual Background file."
          }
        }
      },
      "description": "Information about the webinar's [Virtual Background](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background) files."
    }
  },
  "description": "Information about the webinar's sessions branding."
}

object WebinarsGetSipUriWithPasscodeRequest

{
  "type": "object",
  "properties": {
    "passcode": {
      "type": "string",
      "example": "xxxx",
      "description": "If customers want a passcode to be embedded in the SIP URI dial string, they must supply the passcode. Zoom will not validate the passcode."
    }
  }
}

object WebinarsGetSipUriWithPasscodeResponse

{
  "type": "object",
  "properties": {
    "expire_in": {
      "type": "integer",
      "format": "int64",
      "example": 7200,
      "description": "The number of seconds the encoded SIP URI is valid before it expires."
    },
    "sip_dialing": {
      "type": "string",
      "example": "9678722567.xxxx....30qonrvgy@zoomcrc.com",
      "description": "The webinar's encoded SIP URI."
    },
    "paid_crc_plan_participant": {
      "type": "boolean",
      "example": true,
      "description": "Whether the API caller has a Conference Room Connector (CRC) plan."
    },
    "participant_identifier_code": {
      "type": "string",
      "example": "30qonrvgy",
      "description": "This value identifies the webinar participant. It is automatically embedded in the SIP URI if the API caller has a CRC plan."
    }
  },
  "description": "Information about the webinar's encoded SIP URI."
}

object WebinarsGetSurveyResponse

{
  "type": "object",
  "title": "Webinar survey object",
  "properties": {
    "custom_survey": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "example": "Learn something new",
          "maxLength": 64,
          "description": "The survey's title, up to 64 characters."
        },
        "feedback": {
          "type": "string",
          "example": "Thank you so much for taking the time to complete the survey. Your feedback really makes a difference.",
          "maxLength": 320,
          "description": "The survey's feedback, up to 320 characters. \n\n This value defaults to `Thank you so much for taking the time to complete the survey, your feedback really makes a difference.`."
        },
        "anonymous": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Allow participants to anonymously answer survey questions. \n* `true` - Anonymous survey enabled. \n* `false` - Participants cannot answer survey questions anonymously. \n\n This value defaults to `true`."
        },
        "questions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "example": "How useful was this webinar?",
                "description": "The survey question, up to 420 characters."
              },
              "type": {
                "enum": [
                  "single",
                  "multiple",
                  "matching",
                  "rank_order",
                  "short_answer",
                  "long_answer",
                  "fill_in_the_blank",
                  "rating_scale"
                ],
                "type": "string",
                "example": "single",
                "extensions": {
                  "x-enum-descriptions": [
                    "Single choice",
                    "Multiple choice",
                    "Matching",
                    "Rank order",
                    "Short answer",
                    "Long answer",
                    "Fill in the blank",
                    "Rating scale"
                  ]
                },
                "description": "The survey's question and answer type. \n* `single` - Single choice. \n* `multiple` - Multiple choice. \n* `matching` - Matching. \n* `rank_order` - Rank order \n* `short_answer` - Short answer \n* `long_answer` - Long answer. \n* `fill_in_the_blank` - Fill in the blank \n* `rating_scale` - Rating scale."
              },
              "answers": {
                "type": "array",
                "items": {
                  "type": "string",
                  "example": "Extremely useful",
                  "maxLength": 200
                },
                "minItems": 2,
                "description": "The survey question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` questions, you can only provide a maximum of 50 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers."
              },
              "prompts": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "prompt_question": {
                      "type": "string",
                      "example": "How are you?",
                      "maxLength": 200,
                      "description": "The question prompt's title."
                    }
                  }
                },
                "maxItems": 10,
                "minItems": 2,
                "description": "Information about the prompt questions. This field only applies to `matching` and `rank_order` questions. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts."
              },
              "answer_required": {
                "type": "boolean",
                "default": false,
                "example": false,
                "description": "Whether participants must answer the question. \n* `true` - The participant must answer the question. \n* `false` - The participant does not need to answer the question. \n\n This value defaults to `false`."
              },
              "rating_max_label": {
                "type": "string",
                "example": "Extremely Likely",
                "maxLength": 50,
                "description": "The high score label used for the `rating_max_value` field, up to 50 characters. \n\n This field only applies to the `rating_scale` survey."
              },
              "rating_max_value": {
                "type": "integer",
                "example": 4,
                "maximum": 10,
                "description": "The rating scale's maximum value, up to a maximum value of 10. \n\n This field only applies to the `rating_scale` survey."
              },
              "rating_min_label": {
                "type": "string",
                "example": "Not likely",
                "maxLength": 50,
                "description": "The low score label used for the `rating_min_value` field, up to 50 characters. \n\n This field only applies to the `rating_scale` survey."
              },
              "rating_min_value": {
                "type": "integer",
                "example": 1,
                "minimum": 0,
                "description": "The rating scale's minimum value. This value cannot be less than zero. \n\n This field only applies to the `rating_scale` survey."
              },
              "show_as_dropdown": {
                "type": "boolean",
                "default": false,
                "example": false,
                "description": "Whether to display the radio selection as a drop-down box. \n* `true` - Show as a drop-down box. \n* `false` - Do not show as a drop-down box. \n\n This value defaults to `false`."
              },
              "answer_max_character": {
                "type": "integer",
                "example": 200,
                "description": "The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` questions. \n* For `short_answer` question, a maximum of 500 characters. \n* For `long_answer` question, a maximum of 2,000 characters."
              },
              "answer_min_character": {
                "type": "integer",
                "example": 1,
                "minimum": 1,
                "description": "The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` questions. You must provide at least a **one** character minimum value."
              }
            }
          },
          "maxItems": 100,
          "minItems": 1,
          "description": "Information about the webinar survey's questions."
        },
        "numbered_questions": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to display the number in the question name. \n\n This value defaults to `true`."
        },
        "show_question_type": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to display the question type in the question name. \n\n This value defaults to `false`."
        }
      },
      "description": "Information about the customized webinar survey."
    },
    "third_party_survey": {
      "type": "string",
      "example": "https://example.com",
      "maxLength": 64,
      "description": "The link to the third party webinar survey."
    },
    "show_in_the_browser": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Whether the **Show in the browser when the webinar ends** option is enabled. \n* `true` - Enabled. \n* `false` - Disabled. \n\n This value defaults to `true`."
    },
    "show_in_the_follow_up_email": {
      "type": "boolean",
      "default": false,
      "example": false,
      "description": "Whether the **Show the link on the follow-up email** option is enabled. \n* `true` - Enabled. \n* `false` - Disabled. \n\n This value defaults to `false`."
    }
  },
  "description": "Information about the webinar survey."
}

object WebinarsGetWebinarTokenResponse

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "example": "https://example.com/closedcaption?id=200610693&ns=GZHkEA==&expire=86400&spparams=id%2Cns%2Cexpire&signature=nYtXJqRKCW",
      "description": "The generated webinar token."
    }
  },
  "description": "Information about the webinar token."
}

object WebinarsJoinTokenLiveStreamingResponse

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "example": "2njt50mj",
      "description": "The join token."
    },
    "expire_in": {
      "enum": [
        120
      ],
      "type": "integer",
      "format": "int64",
      "example": 120,
      "description": "The number of seconds the join token is valid for before it expires. This value always returns `120`."
    }
  },
  "description": "Information about the webinar's join token."
}

object WebinarsListAbsenteesResponse

{
  "type": "object",
  "title": "Registration List",
  "properties": {
    "page_size": {
      "type": "integer",
      "default": 30,
      "example": 30,
      "maximum": 300,
      "description": "The number of records returned with a single API call."
    },
    "page_count": {
      "type": "integer",
      "example": 1,
      "description": "The number of pages returned for the request made."
    },
    "page_number": {
      "type": "integer",
      "default": 1,
      "example": 1,
      "deprecated": true,
      "description": "**Deprecated.** This field is deprecated. We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination."
    },
    "registrants": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "email",
          "first_name"
        ],
        "properties": {
          "id": {
            "type": "string",
            "example": "9tboDiHUQAeOnbmudzWa5g",
            "description": "Registrant ID."
          },
          "org": {
            "type": "string",
            "example": "Cooking Org",
            "description": "The registrant's organization."
          },
          "zip": {
            "type": "string",
            "example": "94045",
            "description": "The registrant's ZIP or postal code."
          },
          "city": {
            "type": "string",
            "example": "Mountain View",
            "description": "The registrant's city."
          },
          "email": {
            "type": "string",
            "format": "email",
            "example": "jchill@example.com",
            "maxLength": 128,
            "description": "The registrant's email address. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for return value details."
          },
          "phone": {
            "type": "string",
            "example": "5550100",
            "description": "The registrant's phone number."
          },
          "state": {
            "type": "string",
            "example": "CA",
            "description": "The registrant's state or province."
          },
          "status": {
            "enum": [
              "approved",
              "denied",
              "pending"
            ],
            "type": "string",
            "example": "approved",
            "description": "The status of the registrant's registration.\n  `approved` - User has been successfully approved for the webinar.  \n  `pending` -  The registration is still pending.  \n  `denied` - User has been denied from joining the webinar."
          },
          "address": {
            "type": "string",
            "example": "1800 Amphibious Blvd.",
            "description": "The registrant's address."
          },
          "country": {
            "type": "string",
            "example": "US",
            "description": "The registrant's two-letter ISO [country code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries)."
          },
          "comments": {
            "type": "string",
            "example": "Looking forward to the discussion.",
            "description": "The registrant's questions and comments."
          },
          "industry": {
            "type": "string",
            "example": "Food",
            "description": "The registrant's industry."
          },
          "join_url": {
            "type": "string",
            "format": "string",
            "example": "https://example.com/j/11111",
            "description": "The URL that an approved registrant can use to join the meeting or webinar."
          },
          "job_title": {
            "type": "string",
            "example": "Chef",
            "description": "The registrant's job title."
          },
          "last_name": {
            "type": "string",
            "example": "Chill",
            "maxLength": 64,
            "description": "The registrant's last name."
          },
          "first_name": {
            "type": "string",
            "example": "Jill",
            "maxLength": 64,
            "description": "The registrant's first name."
          },
          "create_time": {
            "type": "string",
            "format": "date-time",
            "example": "2022-03-22T05:59:09Z",
            "description": "The time when the registrant registered."
          },
          "no_of_employees": {
            "enum": [
              "",
              "1-20",
              "21-50",
              "51-100",
              "101-250",
              "251-500",
              "501-1,000",
              "1,001-5,000",
              "5,001-10,000",
              "More than 10,000"
            ],
            "type": "string",
            "example": "1-20",
            "description": "The registrant's number of employees. \n* `1-20` \n* `21-50` \n* `51-100` \n* `101-250` \n* `251-500` \n* `501-1,000` \n* `1,001-5,000` \n* `5,001-10,000` \n* `More than 10,000`"
          },
          "custom_questions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "title": {
                  "type": "string",
                  "example": "What do you hope to learn from this?",
                  "description": "The title of the custom question."
                },
                "value": {
                  "type": "string",
                  "example": "Look forward to learning how you come up with new recipes and what other services you offer.",
                  "maxLength": 128,
                  "description": "The custom question's response value. This has a limit of 128 characters."
                }
              },
              "description": "Information about custom questions."
            },
            "description": "Information about custom questions."
          },
          "purchasing_time_frame": {
            "enum": [
              "",
              "Within a month",
              "1-3 months",
              "4-6 months",
              "More than 6 months",
              "No timeframe"
            ],
            "type": "string",
            "example": "1-3 months",
            "description": "The registrant's purchasing time frame. \n* `Within a month` \n* `1-3 months` \n* `4-6 months` \n* `More than 6 months` \n* `No timeframe`"
          },
          "role_in_purchase_process": {
            "enum": [
              "",
              "Decision Maker",
              "Evaluator/Recommender",
              "Influencer",
              "Not involved"
            ],
            "type": "string",
            "example": "Influencer",
            "description": "The registrant's role in the purchase process. \n* `Decision Maker` \n* `Evaluator/Recommender` \n* `Influencer` \n* `Not involved`"
          }
        },
        "description": " Registrant."
      },
      "description": "List of registrant objects."
    },
    "total_records": {
      "type": "integer",
      "example": 20,
      "description": "The total number of all the records available across pages."
    },
    "next_page_token": {
      "type": "string",
      "example": "w7587w4eiyfsudgf",
      "description": "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."
    }
  },
  "description": "List of users."
}

object WebinarsListPanelistsResponse

{
  "type": "object",
  "title": "Panelist List",
  "properties": {
    "panelists": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "Tg2b6GhcQKKbV7nSCbDKug",
            "description": "Panelist's ID."
          },
          "name": {
            "type": "string",
            "example": "Jill Chill",
            "description": "The panelist's full name.\n\n**Note** This value cannot exceed more than 12 Chinese characters."
          },
          "email": {
            "type": "string",
            "format": "email",
            "example": "jchill@example.com",
            "description": "Panelist's email. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for return value details."
          },
          "join_url": {
            "type": "string",
            "example": "https://example.com/j/11111",
            "description": "Join URL."
          },
          "name_tag_id": {
            "type": "string",
            "example": "xHhPyb8ERMCmiC5njPjFdQ",
            "description": "The name tag ID to bind."
          },
          "name_tag_name": {
            "type": "string",
            "example": "name",
            "description": "The panelist's name to display in the name tag."
          },
          "name_tag_pronouns": {
            "type": "string",
            "example": "pronouns",
            "description": "The pronouns to display in the name tag."
          },
          "name_tag_description": {
            "type": "string",
            "example": "description",
            "description": "The description for the name tag, such as the person's title)."
          },
          "virtual_background_id": {
            "type": "string",
            "example": "xHhPyb8ERMCmiC5njPjFdQ",
            "description": "The virtual background's ID."
          }
        },
        "description": "Panelist base object."
      },
      "description": "List of panelist objects."
    },
    "total_records": {
      "type": "integer",
      "example": 1,
      "description": "Total records."
    }
  },
  "description": "Webinar panelist."
}

object WebinarsListParticipantsResponse

{
  "type": "object",
  "properties": {
    "page_size": {
      "type": "integer",
      "default": 30,
      "example": 30,
      "maximum": 300,
      "description": "The total number of records returned from a single API call."
    },
    "page_count": {
      "type": "integer",
      "example": 1,
      "description": "The number of pages returned for this request."
    },
    "participants": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "30R7kT7bTIKSNUFEuH_Qlg",
            "description": "The participant's unique identifier."
          },
          "name": {
            "type": "string",
            "example": "Jill Chill",
            "description": "The participant's name."
          },
          "status": {
            "enum": [
              "in_meeting",
              "in_waiting_room"
            ],
            "type": "string",
            "example": "in_meeting",
            "description": "The participant's status. \n* `in_meeting` - In a meeting. \n* `in_waiting_room` - In a waiting room."
          },
          "user_id": {
            "type": "string",
            "example": "ABCDEF123456",
            "description": "The participant's ID. This ID is assigned to the participant upon joining the webinar and is only valid for that webinar."
          },
          "duration": {
            "type": "integer",
            "example": 20,
            "description": "The participant's attendance duration."
          },
          "failover": {
            "type": "boolean",
            "example": false,
            "description": "Whether failover occurred during the webinar."
          },
          "join_time": {
            "type": "string",
            "format": "date-time",
            "example": "2019-02-01T12:34:12.660Z",
            "description": "The participant's join time."
          },
          "leave_time": {
            "type": "string",
            "format": "date-time",
            "example": "2019-02-01T12:54:12.660Z",
            "description": "The participant's leave time."
          },
          "user_email": {
            "type": "string",
            "format": "email",
            "example": "jchill@example.com",
            "description": "Email address of the participant. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details."
          },
          "registrant_id": {
            "type": "string",
            "example": "_f08HhPJS82MIVLuuFaJPg",
            "description": "The participant's unique registrant ID. This field only returns if you pass the `registrant_id` value for the `include_fields` query parameter. \n\nThis field does not return if the `type` query parameter is the `live` value."
          }
        }
      }
    },
    "total_records": {
      "type": "integer",
      "example": 1,
      "description": "The total number of records available across all pages."
    },
    "next_page_token": {
      "type": "string",
      "example": "Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3",
      "description": "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."
    }
  }
}

object WebinarsListPastInstancesResponse

{
  "type": "object",
  "title": "Webinar instances",
  "properties": {
    "webinars": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string",
            "example": "Bznyg8KZTdCVbQxvS/oZ7w==",
            "description": "Webinar UUID."
          },
          "start_time": {
            "type": "string",
            "format": "date-time",
            "example": "2022-03-26T06:44:14Z",
            "description": "Start time."
          }
        }
      },
      "description": "List of ended webinar instances."
    }
  },
  "description": "List of webinars."
}

object WebinarsListPastWebinarQaResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 95204914252,
      "description": "Webinar ID in **long** format, represented as int64 data type in JSON, also known as the webinar number."
    },
    "uuid": {
      "type": "string",
      "example": "Bznyg8KZTdCVbQxvS/oZ7w==",
      "description": "Webinar UUID."
    },
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "Jill Chill",
            "description": "Name of the user. If `anonymous` option is enabled for the Q&amp;A, the participant's information will be kept anonymous and the value of `name` field will be `Anonymous Attendee`."
          },
          "email": {
            "type": "string",
            "example": "jchill@example.com",
            "description": "Email address of the user. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details."
          },
          "question_details": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "answer": {
                  "type": "string",
                  "example": "Good",
                  "description": "Answer submitted for the question. The value will be 'live answered' if this is a live answer."
                },
                "question": {
                  "type": "string",
                  "example": "How are you?",
                  "description": "Question asked during the Q&amp;A."
                }
              }
            }
          }
        }
      }
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-26T06:44:14Z",
      "description": "The webinar's start time."
    }
  }
}

object WebinarsListPollResultsResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 95204914252,
      "description": "Webinar ID in **long** format, represented as int64 data type in JSON, also known as the webinar number."
    },
    "uuid": {
      "type": "string",
      "example": "Bznyg8KZTdCVbQxvS/oZ7w==",
      "description": "Webinar UUID."
    },
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "Jill Chill",
            "description": "Name of the user who submitted answers to the poll. If the `anonymous` option is enabled for a poll, the participant's polling information will be kept anonymous and the value of `name` field will be `Anonymous Attendee`."
          },
          "email": {
            "type": "string",
            "example": "jchill@example.com",
            "description": "Email address of the user who submitted answers to the poll. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details."
          },
          "question_details": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "answer": {
                  "type": "string",
                  "example": "Good",
                  "description": "Answer submitted by the user."
                },
                "question": {
                  "type": "string",
                  "example": "How are you?",
                  "description": "Question asked during the poll."
                },
                "date_time": {
                  "type": "string",
                  "format": "date-time",
                  "example": "2022-03-26T05:37:59Z",
                  "description": "Date and time when the answer to the poll was submitted."
                },
                "polling_id": {
                  "type": "string",
                  "example": "QalIoKWLTJehBJ8e1xRrbQ",
                  "description": "Unique identifier of the poll."
                }
              }
            }
          }
        }
      }
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-26T05:37:59Z",
      "description": "The webinar's start time."
    }
  }
}

object WebinarsListPollsResponse

{
  "type": "object",
  "title": "Poll List",
  "properties": {
    "polls": {
      "type": "array",
      "items": {
        "type": "object",
        "title": "Meeting and Webinar Polling Object",
        "properties": {
          "id": {
            "type": "string",
            "example": "QalIoKWLTJehBJ8e1xRrbQ",
            "description": "ID of Poll"
          },
          "title": {
            "type": "string",
            "example": "Learn something new",
            "maxLength": 64,
            "description": "The poll's title, up to 64 characters."
          },
          "status": {
            "enum": [
              "notstart",
              "started",
              "ended",
              "sharing"
            ],
            "type": "string",
            "example": "notstart",
            "extensions": {
              "x-enum-descriptions": [
                "Poll not start",
                "Poll started",
                "Poll ended",
                "Poll is sharing"
              ]
            },
            "description": "Status of Poll:  \n `notstart` - Poll not started  \n `started` - Poll started  \n `ended` - Poll ended  \n `sharing` - Sharing poll results"
          },
          "anonymous": {
            "type": "boolean",
            "default": false,
            "example": true,
            "description": "Allow meeting participants to answer poll questions anonymously. \n\nThis value defaults to `false`."
          },
          "poll_type": {
            "enum": [
              1,
              2,
              3
            ],
            "type": "integer",
            "example": 2,
            "description": "The type of poll: \n* `1` &mdash; Poll. \n* `2` &mdash; Advanced Poll. This feature must be enabled in your Zoom account. \n* `3` &mdash; Quiz. This feature must be enabled in your Zoom account. \n\n This value defaults to `1`."
          },
          "questions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "example": "How useful was this meeting?",
                  "maxLength": 255,
                  "description": "The poll question, up to 255 characters. \n\nFor `fill_in_the_blank` polls, this field is the poll's question. For each value that the user must fill in, ensure that there are the same number of `right_answers` values."
                },
                "type": {
                  "enum": [
                    "single",
                    "multiple",
                    "matching",
                    "rank_order",
                    "short_answer",
                    "long_answer",
                    "fill_in_the_blank",
                    "rating_scale"
                  ],
                  "type": "string",
                  "example": "single",
                  "extensions": {
                    "x-enum-descriptions": [
                      "Single choice",
                      "Multiple choice",
                      "Matching",
                      "Rank order",
                      "Short answer",
                      "Long answer",
                      "Fill in the blank",
                      "Rating scale"
                    ]
                  },
                  "description": "The poll's question and answer type: \n* `single` &mdash; Single choice. \n* `multiple` &mdash; Multiple choice. \n* `matching` &mdash; Matching. \n* `rank_order` &mdash; Rank order. \n* `short_answer` &mdash; Short answer. \n* `long_answer` &mdash; Long answer. \n* `fill_in_the_blank` &mdash; Fill in the blank. \n* `rating_scale` &mdash; Rating scale."
                },
                "answers": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "Extremely useful"
                  },
                  "minItems": 2,
                  "description": "The poll question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` polls, you can only provide a maximum of 10 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers."
                },
                "prompts": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "prompt_question": {
                        "type": "string",
                        "example": "How are you?",
                        "description": "The question prompt's title."
                      },
                      "prompt_right_answers": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "example": "Good"
                        },
                        "description": "The question prompt's correct answers: \n* For `matching` polls, you must provide a minimum of two correct answers, up to a maximum of 10 correct answers. \n* For `rank_order` polls, you can only provide one correct answer."
                      }
                    }
                  },
                  "description": "Information about the prompt questions. This field only applies to `matching` and `rank_order` polls. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts."
                },
                "right_answers": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "Good"
                  },
                  "minItems": 1,
                  "description": "The poll question's correct answer(s). This field is **required** if the poll's `type` value is `3` (Quiz). \n\n For `single` and `matching` polls, this field only accepts one answer."
                },
                "case_sensitive": {
                  "type": "boolean",
                  "default": false,
                  "example": false,
                  "description": "Whether the correct answer is case sensitive. This field only applies to `fill_in_the_blank` polls: \n* `true` &mdash; The answer is case-sensitive. \n* `false` &mdash; The answer is not case-sensitive. \n\nThis value defaults to `false`."
                },
                "answer_required": {
                  "type": "boolean",
                  "default": false,
                  "example": false,
                  "description": "Whether participants must answer the question: \n* `true` &mdash; The participant must answer the question. \n* `false` &mdash; The participant does not need to answer the question. \n\n**Note:** \n* When the poll's `type` value is `1` (Poll), this value defaults to `true`. \n* When the poll's `type` value is the `2` (Advanced Poll) or `3` (Quiz) values, this value defaults to `false`."
                },
                "rating_max_label": {
                  "type": "string",
                  "example": "Extremely Likely",
                  "description": "The high score label used for the `rating_max_value` field. \n\nThis field only applies to the `rating_scale` poll."
                },
                "rating_max_value": {
                  "type": "integer",
                  "example": 4,
                  "maximum": 10,
                  "description": "The rating scale's maximum value, up to a maximum value of 10. \n\nThis field only applies to the `rating_scale` poll."
                },
                "rating_min_label": {
                  "type": "string",
                  "example": "Not likely",
                  "description": "The low score label used for the `rating_min_value` field. \n\nThis field only applies to the `rating_scale` poll."
                },
                "rating_min_value": {
                  "type": "integer",
                  "example": 0,
                  "minimum": 0,
                  "description": "The rating scale's minimum value. This value cannot be less than zero. \n\nThis field only applies to the `rating_scale` poll."
                },
                "show_as_dropdown": {
                  "type": "boolean",
                  "default": false,
                  "example": false,
                  "description": "Whether to display the radio selection as a drop-down box: \n* `true` &mdash; Show as a drop-down box. \n* `false` &mdash; Do not show as a drop-down box. \n\nThis value defaults to `false`."
                },
                "answer_max_character": {
                  "type": "integer",
                  "example": 200,
                  "description": "The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` polls: \n* For `short_answer` polls, a maximum of 500 characters. \n* For `long_answer` polls, a maximum of 2,000 characters."
                },
                "answer_min_character": {
                  "type": "integer",
                  "example": 1,
                  "minimum": 1,
                  "description": "The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` polls. You must provide at least a **one** character minimum value."
                }
              }
            },
            "description": "Information about the poll's questions."
          }
        },
        "description": "Information about meeting and webinar polling."
      },
      "description": "Array of Polls"
    },
    "total_records": {
      "type": "integer",
      "example": 1,
      "description": "The number of all records available across pages"
    }
  },
  "description": "Poll List"
}

object WebinarsListRegistrantsResponse

{
  "type": "object",
  "title": "Registration list",
  "properties": {
    "page_size": {
      "type": "integer",
      "default": 30,
      "example": 30,
      "maximum": 300,
      "description": "The number of records returned with a single API call."
    },
    "page_count": {
      "type": "integer",
      "example": 1,
      "description": "The number of pages returned for the request made."
    },
    "page_number": {
      "type": "integer",
      "default": 1,
      "example": 1,
      "deprecated": true,
      "description": "**Deprecated** This field will be deprecated. We will no longer support this field in a future release. Instead, use `next_page_token` for pagination."
    },
    "registrants": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "email",
          "first_name"
        ],
        "properties": {
          "id": {
            "type": "string",
            "example": "9tboDiHUQAeOnbmudzWa5g",
            "description": "Registrant ID."
          },
          "org": {
            "type": "string",
            "example": "Cooking Org",
            "description": "The registrant's organization."
          },
          "zip": {
            "type": "string",
            "example": "94045",
            "description": "The registrant's ZIP or postal code."
          },
          "city": {
            "type": "string",
            "example": "Mountain View",
            "description": "The registrant's city."
          },
          "email": {
            "type": "string",
            "format": "email",
            "example": "jchill@example.com",
            "maxLength": 128,
            "description": "The registrant's email address. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for return value details."
          },
          "phone": {
            "type": "string",
            "example": "5550100",
            "description": "The registrant's phone number."
          },
          "state": {
            "type": "string",
            "example": "CA",
            "description": "The registrant's state or province."
          },
          "status": {
            "enum": [
              "approved",
              "denied",
              "pending"
            ],
            "type": "string",
            "example": "approved",
            "description": "The status of the registrant's registration.   \n  `approved` - User has been successfully approved for the webinar.  \n  `pending` -  The registration is still pending.  \n  `denied` - User has been denied from joining the webinar."
          },
          "address": {
            "type": "string",
            "example": "1800 Amphibious Blvd.",
            "description": "The registrant's address."
          },
          "country": {
            "type": "string",
            "example": "US",
            "description": "The registrant's two-letter ISO [country code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries)."
          },
          "comments": {
            "type": "string",
            "example": "Looking forward to the discussion.",
            "description": "The registrant's questions and comments."
          },
          "industry": {
            "type": "string",
            "example": "Food",
            "description": "The registrant's industry."
          },
          "join_url": {
            "type": "string",
            "format": "string",
            "example": "https://example.com/j/11111",
            "description": "The URL that an approved registrant can use to join the meeting or webinar."
          },
          "job_title": {
            "type": "string",
            "example": "Chef",
            "description": "The registrant's job title."
          },
          "last_name": {
            "type": "string",
            "example": "Chill",
            "maxLength": 64,
            "description": "The registrant's last name."
          },
          "first_name": {
            "type": "string",
            "example": "Jill",
            "maxLength": 64,
            "description": "The registrant's first name."
          },
          "create_time": {
            "type": "string",
            "format": "date-time",
            "example": "2022-03-22T05:59:09Z",
            "description": "The time when the registrant registered."
          },
          "no_of_employees": {
            "enum": [
              "",
              "1-20",
              "21-50",
              "51-100",
              "101-250",
              "251-500",
              "501-1,000",
              "1,001-5,000",
              "5,001-10,000",
              "More than 10,000"
            ],
            "type": "string",
            "example": "1-20",
            "description": "The registrant's number of employees. \n* `1-20` \n* `21-50` \n* `51-100` \n* `101-250` \n* `251-500` \n* `501-1,000` \n* `1,001-5,000` \n* `5,001-10,000` \n* `More than 10,000`"
          },
          "custom_questions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "title": {
                  "type": "string",
                  "example": "What do you hope to learn from this?",
                  "description": "The title of the custom question."
                },
                "value": {
                  "type": "string",
                  "example": "Look forward to learning how you come up with new recipes and what other services you offer.",
                  "maxLength": 128,
                  "description": "The custom question's response value. This has a limit of 128 characters."
                }
              },
              "description": "Information about custom questions."
            },
            "description": "Information about custom questions."
          },
          "purchasing_time_frame": {
            "enum": [
              "",
              "Within a month",
              "1-3 months",
              "4-6 months",
              "More than 6 months",
              "No timeframe"
            ],
            "type": "string",
            "example": "1-3 months",
            "description": "The registrant's purchasing time frame. \n* `Within a month.` \n* `1-3 months.` \n* `4-6 months.` \n* `More than 6 months.` \n* `No timeframe.`"
          },
          "role_in_purchase_process": {
            "enum": [
              "",
              "Decision Maker",
              "Evaluator/Recommender",
              "Influencer",
              "Not involved"
            ],
            "type": "string",
            "example": "Influencer",
            "description": "The registrant's role in the purchase process. \n* `Decision maker` \n* `Evaluator/Recommender.` \n* `Influencer.` \n* `Not involved.`"
          }
        },
        "description": " Registrant."
      },
      "description": "List of registrant objects."
    },
    "total_records": {
      "type": "integer",
      "example": 20,
      "description": "The total number of all the records available across pages."
    },
    "next_page_token": {
      "type": "string",
      "example": "w7587w4eiyfsudgf",
      "description": "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."
    }
  },
  "description": "List of users."
}

object WebinarsListRegistrationQuestionsResponse

{
  "type": "object",
  "title": "Webinar Registrant Questions",
  "properties": {
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "required": {
            "type": "boolean",
            "example": true,
            "description": "State whether the selected fields are required or optional."
          },
          "field_name": {
            "enum": [
              "last_name",
              "address",
              "city",
              "country",
              "zip",
              "state",
              "phone",
              "industry",
              "org",
              "job_title",
              "purchasing_time_frame",
              "role_in_purchase_process",
              "no_of_employees",
              "comments"
            ],
            "type": "string",
            "example": "last_name",
            "extensions": {
              "x-enum-descriptions": [
                "Last Name",
                "Address",
                "City",
                "Country/Region",
                "Zip/Postal Code",
                "State/Province",
                "Phone",
                "Industry",
                "Organization",
                "Job Title",
                "Purchasing Time Frame",
                "Role in Purchase Process",
                "Number of Employees",
                "Questions & Comments"
              ]
            },
            "description": "Field name"
          }
        }
      },
      "description": "Array of registration fields whose values should be provided by registrants during registration."
    },
    "custom_questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "enum": [
              "short",
              "single_radio",
              "single_dropdown",
              "multiple"
            ],
            "type": "string",
            "example": "short",
            "extensions": {
              "x-enum-descriptions": [
                "Short Answer",
                "Single Radio Answer",
                "Single Dropdown Answer",
                "Multiple Answer"
              ]
            },
            "description": "The question-answer type."
          },
          "title": {
            "type": "string",
            "example": "How are you?",
            "description": "Custom question."
          },
          "answers": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "Good"
            },
            "description": "An array of answer choices. Can't be used for short answer type."
          },
          "required": {
            "type": "boolean",
            "example": true,
            "description": "State whether or not the custom question is required to be answered by a registrant."
          }
        }
      },
      "description": "Array of Registrant Custom Questions."
    }
  },
  "description": "Webinar Registrant Questions"
}

object WebinarsListTrackingSourcesResponse

{
  "type": "object",
  "properties": {
    "total_records": {
      "type": "integer",
      "example": 1,
      "description": "The total number of registration records for this Webinar."
    },
    "tracking_sources": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "5516482804110",
            "description": "Unique Identifier of the tracking source."
          },
          "source_name": {
            "type": "string",
            "example": "https://example.com",
            "description": "Name of the source (platform) where the registration URL was shared."
          },
          "tracking_url": {
            "type": "string",
            "example": "https://example.com/webinar/register/5516482804110/WN_juM2BGyLQMyQ_ZrqiGRhLg",
            "description": "Tracking URL. The URL that was shared for the registration."
          },
          "visitor_count": {
            "type": "integer",
            "example": 1,
            "description": "Number of visitors who visited the registration page from this source."
          },
          "registration_count": {
            "type": "integer",
            "example": 1,
            "description": "Number of registrations made from this source."
          }
        }
      },
      "description": "Tracking Sources object."
    }
  }
}

object WebinarsListWebinarTemplatesResponse

{
  "type": "object",
  "properties": {
    "templates": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "ull6574eur",
            "description": "The webinar template's ID."
          },
          "name": {
            "type": "string",
            "example": "Weekly Meeting Template",
            "description": "The webinar template's name."
          },
          "type": {
            "type": "integer",
            "example": 1,
            "description": "The webinar template type.  `1`: Webinar template    `2`: Admin webinar template"
          }
        }
      },
      "description": "Information about the webinar templates."
    },
    "total_records": {
      "type": "integer",
      "example": 1,
      "description": "The total number of records returned."
    }
  }
}

object WebinarsListWebinarsResponse

{
  "type": "object",
  "properties": {
    "webinars": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64",
            "example": 1234567890,
            "description": "The webinar ID."
          },
          "type": {
            "enum": [
              5,
              6,
              9
            ],
            "type": "integer",
            "default": 5,
            "example": 9,
            "description": "The webinar type. \n* `5` - A webinar. \n* `6` - A recurring webinar without a fixed time. \n* `9` - A recurring webinar with a fixed time."
          },
          "uuid": {
            "type": "string",
            "example": "4444AAAiAAAAAiAiAiiAii==",
            "description": "The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."
          },
          "topic": {
            "type": "string",
            "example": "My Webinar",
            "description": "The webinar's topic."
          },
          "agenda": {
            "type": "string",
            "example": "Learn more about Zoom APIs",
            "description": "Webinar description. The agenda length gets truncated to 250 characters when you list all webinars for a user. To view the complete agenda, retrieve details for a single webinar, use the [**Get a webinar**](https://developers.zoom.us) API."
          },
          "host_id": {
            "type": "string",
            "example": "x1yCzABCDEfg23HiJKl4mN",
            "description": "The host's ID."
          },
          "duration": {
            "type": "integer",
            "example": 60,
            "description": "The webinar's duration, in minutes."
          },
          "join_url": {
            "type": "string",
            "example": "https://example.com/j/11111",
            "description": "The URL to join the webinar."
          },
          "timezone": {
            "type": "string",
            "example": "America/Los_Angeles",
            "description": "The webinar's [timezone](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones)."
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "example": "2021-07-01T22:00:00Z",
            "description": "The webinar's creation time."
          },
          "start_time": {
            "type": "string",
            "format": "date-time",
            "example": "2021-07-13T21:00:00Z",
            "description": "The webinar's start time."
          },
          "is_simulive": {
            "type": "boolean",
            "example": true,
            "description": "Whether the webinar is `simulive`."
          }
        }
      },
      "description": "List of webinar objects."
    },
    "page_size": {
      "type": "integer",
      "default": 30,
      "example": 30,
      "maximum": 300,
      "description": "The number of records returned with a single API call."
    },
    "page_count": {
      "type": "integer",
      "example": 1,
      "description": "The number of pages returned for the request made."
    },
    "page_number": {
      "type": "integer",
      "default": 1,
      "example": 1,
      "deprecated": true,
      "description": "**Deprecated** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination."
    },
    "total_records": {
      "type": "integer",
      "example": 20,
      "description": "The total number of all the records available across pages."
    },
    "next_page_token": {
      "type": "string",
      "example": "w7587w4eiyfsudgf",
      "description": "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."
    }
  },
  "description": "List of webinars."
}

object WebinarsRegistrantDetailsResponse

{
  "type": "object",
  "title": "Webinar Registrant",
  "required": [
    "email",
    "first_name"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "95204914252"
    },
    "org": {
      "type": "string",
      "example": "Cooking Org",
      "description": "The registrant's organization."
    },
    "zip": {
      "type": "string",
      "example": "94045",
      "description": "The registrant's ZIP or postal code."
    },
    "city": {
      "type": "string",
      "example": "Mountain View",
      "description": "The registrant's city."
    },
    "email": {
      "type": "string",
      "format": "email",
      "example": "jchill@example.com",
      "maxLength": 128,
      "description": "The registrant's email address. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for return value details."
    },
    "phone": {
      "type": "string",
      "example": "5550100",
      "description": "The registrant's phone number."
    },
    "state": {
      "type": "string",
      "example": "CA",
      "description": "The registrant's state or province."
    },
    "status": {
      "enum": [
        "approved",
        "denied",
        "pending"
      ],
      "type": "string",
      "example": "approved",
      "description": "The registrant's status: \n* `approved` &mdash; Registrant is approved. \n* `denied` &mdash; Registrant is denied. \n* `pending` &mdash; Registrant is waiting for approval."
    },
    "address": {
      "type": "string",
      "example": "1800 Amphibious Blvd.",
      "description": "The registrant's address."
    },
    "country": {
      "type": "string",
      "example": "US",
      "description": "The registrant's two-letter ISO [country code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries)."
    },
    "comments": {
      "type": "string",
      "example": "Looking forward to the discussion.",
      "description": "The registrant's questions and comments."
    },
    "industry": {
      "type": "string",
      "example": "Food",
      "description": "The registrant's industry."
    },
    "join_url": {
      "type": "string",
      "format": "string",
      "example": "https://example.com/j/11111"
    },
    "language": {
      "enum": [
        "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"
      ],
      "type": "string",
      "example": "en-US",
      "description": "The registrant's language preference for confirmation emails: \n* `en-US` &mdash; English (US) \n* `de-DE` &mdash; German (Germany) \n* `es-ES` &mdash; Spanish (Spain) \n* `fr-FR` &mdash; French (France) \n* `jp-JP` &mdash; Japanese \n* `pt-PT` &mdash; Portuguese (Portugal) \n* `ru-RU` &mdash; Russian \n* `zh-CN` &mdash; Chinese (PRC) \n* `zh-TW` &mdash; Chinese (Taiwan) \n* `ko-KO` &mdash; Korean \n* `it-IT` &mdash; Italian (Italy) \n* `vi-VN` &mdash; Vietnamese \n* `pl-PL` &mdash; Polish \n* `Tr-TR` &mdash; Turkish"
    },
    "job_title": {
      "type": "string",
      "example": "Chef",
      "description": "The registrant's job title."
    },
    "last_name": {
      "type": "string",
      "example": "Chill",
      "maxLength": 64,
      "description": "The registrant's last name."
    },
    "first_name": {
      "type": "string",
      "example": "Jill",
      "maxLength": 64,
      "description": "The registrant's first name."
    },
    "create_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-26T06:44:14Z"
    },
    "no_of_employees": {
      "enum": [
        "",
        "1-20",
        "21-50",
        "51-100",
        "101-250",
        "251-500",
        "501-1,000",
        "1,001-5,000",
        "5,001-10,000",
        "More than 10,000"
      ],
      "type": "string",
      "example": "1-20",
      "description": "The registrant's number of employees: \n* `1-20` \n* `21-50` \n* `51-100` \n* `101-250` \n* `251-500` \n* `501-1,000` \n* `1,001-5,000` \n* `5,001-10,000` \n* `More than 10,000`"
    },
    "custom_questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "example": "What do you hope to learn from this?",
            "description": "The title of the custom question."
          },
          "value": {
            "type": "string",
            "example": "Look forward to learning how you come up with new recipes and what other services you offer.",
            "maxLength": 128,
            "description": "The custom question's response value. This has a limit of 128 characters."
          }
        },
        "description": "Information about custom questions."
      },
      "description": "Information about custom questions."
    },
    "purchasing_time_frame": {
      "enum": [
        "",
        "Within a month",
        "1-3 months",
        "4-6 months",
        "More than 6 months",
        "No timeframe"
      ],
      "type": "string",
      "example": "1-3 months",
      "description": "The registrant's purchasing time frame: \n* `Within a month` \n* `1-3 months` \n* `4-6 months` \n* `More than 6 months` \n* `No timeframe`"
    },
    "role_in_purchase_process": {
      "enum": [
        "",
        "Decision Maker",
        "Evaluator/Recommender",
        "Influencer",
        "Not involved"
      ],
      "type": "string",
      "example": "Influencer",
      "description": "The registrant's role in the purchase process: \n* `Decision Maker` \n* `Evaluator/Recommender` \n* `Influencer` \n* `Not involved`"
    }
  },
  "description": "Webinar registrant."
}

object WebinarsUpdateBrandingNameTagRequest

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "example": "name",
      "description": "The name tag's name.\n\n**Note:** This value cannot exceed more than 50 characters."
    },
    "is_default": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Whether set the name tag as the default name tag or not."
    },
    "text_color": {
      "type": "string",
      "format": "Hex color code",
      "example": "0e72ed",
      "description": "The name tag's text color."
    },
    "accent_color": {
      "type": "string",
      "format": "Hex color code",
      "example": "0e72ed",
      "description": "The name tag's accent color."
    },
    "background_color": {
      "type": "string",
      "format": "Hex color code",
      "example": "0e72ed",
      "description": "The name tag's background color."
    },
    "set_default_for_all_panelists": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Whether to set the name tag as the new default for all panelists or not. This includes panelists not currently assigned a default name tag."
    }
  },
  "description": "Name tag information"
}

object WebinarsUpdateLiveStreamRequest

{
  "type": "object",
  "required": [
    "page_url",
    "stream_key",
    "stream_url"
  ],
  "properties": {
    "page_url": {
      "type": "string",
      "format": "uri",
      "example": "https://example.com/livestream/123",
      "maxLength": 1024,
      "description": "The webinar live stream page's URL."
    },
    "resolution": {
      "type": "string",
      "example": "720p",
      "description": "The number of pixels in each dimension that the video camera can display, required when a user enables 1080p. Use a value of `720p` or `1080p`"
    },
    "stream_key": {
      "type": "string",
      "example": "contact-it@example.com",
      "maxLength": 512,
      "description": "The webinar live stream name and key."
    },
    "stream_url": {
      "type": "string",
      "example": "https://example.com/livestream",
      "maxLength": 1024,
      "description": "The webinar live stream URL."
    }
  },
  "description": "Webinar live stream."
}

object WebinarsUpdateLiveStreamStatusRequest

{
  "type": "object",
  "properties": {
    "action": {
      "enum": [
        "start",
        "stop"
      ],
      "type": "string",
      "example": "start",
      "extensions": {
        "x-enum-descriptions": [
          "Start a webinar live stream.",
          "Stop a webinar live stream."
        ]
      },
      "description": "Update the live stream's status. \n\n* `start` - Start a webinar live stream.\n\n* `stop`- Stop an ongoing webinar live stream."
    },
    "settings": {
      "type": "object",
      "properties": {
        "display_name": {
          "type": "string",
          "example": "Jill Chill",
          "maxLength": 50,
          "minLength": 1,
          "description": "Display the live stream's name."
        },
        "active_speaker_name": {
          "type": "boolean",
          "example": true,
          "description": "Display the name of the active speaker during a live stream."
        }
      },
      "description": "Update the live stream session's settings.  **Only** settings for a stopped live stream can be updated."
    }
  },
  "description": "Webinar live stream status."
}

object WebinarsUpdatePollRequest

{
  "type": "object",
  "title": "Meeting and Webinar Polling Object",
  "properties": {
    "title": {
      "type": "string",
      "example": "Learn something new",
      "maxLength": 64,
      "description": "The poll's title, up to 64 characters."
    },
    "anonymous": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Allow meeting participants to answer poll questions anonymously. \n\nThis value defaults to `false`."
    },
    "poll_type": {
      "enum": [
        1,
        2,
        3
      ],
      "type": "integer",
      "example": 2,
      "description": "The type of poll: \n* `1` &mdash; Poll. \n* `2` &mdash; Advanced Poll. This feature must be enabled in your Zoom account. \n* `3` &mdash; Quiz. This feature must be enabled in your Zoom account. \n\n This value defaults to `1`."
    },
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "How useful was this meeting?",
            "maxLength": 255,
            "description": "The poll question, up to 255 characters. \n\nFor `fill_in_the_blank` polls, this field is the poll's question. For each value that the user must fill in, ensure that there are the same number of `right_answers` values."
          },
          "type": {
            "enum": [
              "single",
              "multiple",
              "matching",
              "rank_order",
              "short_answer",
              "long_answer",
              "fill_in_the_blank",
              "rating_scale"
            ],
            "type": "string",
            "example": "single",
            "extensions": {
              "x-enum-descriptions": [
                "Single choice",
                "Multiple choice",
                "Matching",
                "Rank order",
                "Short answer",
                "Long answer",
                "Fill in the blank",
                "Rating scale"
              ]
            },
            "description": "The poll's question and answer type: \n* `single` &mdash; Single choice. \n* `multiple` &mdash; Multiple choice. \n* `matching` &mdash; Matching. \n* `rank_order` &mdash; Rank order. \n* `short_answer` &mdash; Short answer. \n* `long_answer` &mdash; Long answer. \n* `fill_in_the_blank` &mdash; Fill in the blank. \n* `rating_scale` &mdash; Rating scale."
          },
          "answers": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "Extremely useful"
            },
            "minItems": 2,
            "description": "The poll question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` polls, you can only provide a maximum of 10 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers."
          },
          "prompts": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "prompt_question": {
                  "type": "string",
                  "example": "How are you?",
                  "description": "The question prompt's title."
                },
                "prompt_right_answers": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "Good"
                  },
                  "description": "The question prompt's correct answers: \n* For `matching` polls, you must provide a minimum of two correct answers, up to a maximum of 10 correct answers. \n* For `rank_order` polls, you can only provide one correct answer."
                }
              }
            },
            "description": "Information about the prompt questions. This field only applies to `matching` and `rank_order` polls. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts."
          },
          "right_answers": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "Good"
            },
            "minItems": 1,
            "description": "The poll question's correct answer(s). This field is **required** if the poll's `type` value is `3` (Quiz). \n\n For `single` and `matching` polls, this field only accepts one answer."
          },
          "case_sensitive": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether the correct answer is case sensitive. This field only applies to `fill_in_the_blank` polls: \n* `true` &mdash; The answer is case-sensitive. \n* `false` &mdash; The answer is not case-sensitive. \n\nThis value defaults to `false`."
          },
          "answer_required": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether participants must answer the question: \n* `true` &mdash; The participant must answer the question. \n* `false` &mdash; The participant does not need to answer the question. \n\n**Note:** \n* When the poll's `type` value is `1` (Poll), this value defaults to `true`. \n* When the poll's `type` value is the `2` (Advanced Poll) or `3` (Quiz) values, this value defaults to `false`."
          },
          "rating_max_label": {
            "type": "string",
            "example": "Extremely Likely",
            "description": "The high score label used for the `rating_max_value` field. \n\nThis field only applies to the `rating_scale` poll."
          },
          "rating_max_value": {
            "type": "integer",
            "example": 4,
            "maximum": 10,
            "description": "The rating scale's maximum value, up to a maximum value of 10. \n\nThis field only applies to the `rating_scale` poll."
          },
          "rating_min_label": {
            "type": "string",
            "example": "Not likely",
            "description": "The low score label used for the `rating_min_value` field. \n\nThis field only applies to the `rating_scale` poll."
          },
          "rating_min_value": {
            "type": "integer",
            "example": 0,
            "minimum": 0,
            "description": "The rating scale's minimum value. This value cannot be less than zero. \n\nThis field only applies to the `rating_scale` poll."
          },
          "show_as_dropdown": {
            "type": "boolean",
            "default": false,
            "example": false,
            "description": "Whether to display the radio selection as a drop-down box: \n* `true` &mdash; Show as a drop-down box. \n* `false` &mdash; Do not show as a drop-down box. \n\nThis value defaults to `false`."
          },
          "answer_max_character": {
            "type": "integer",
            "example": 200,
            "description": "The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` polls: \n* For `short_answer` polls, a maximum of 500 characters. \n* For `long_answer` polls, a maximum of 2,000 characters."
          },
          "answer_min_character": {
            "type": "integer",
            "example": 1,
            "minimum": 1,
            "description": "The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` polls. You must provide at least a **one** character minimum value."
          }
        }
      },
      "description": "Information about the poll's questions."
    }
  },
  "description": "Information about meeting and webinar polling."
}

object WebinarsUpdateRegistrantStatusRequest

{
  "type": "object",
  "required": [
    "action"
  ],
  "properties": {
    "action": {
      "enum": [
        "approve",
        "deny",
        "cancel"
      ],
      "type": "string",
      "example": "approve",
      "extensions": {
        "x-enum-descriptions": [
          "Approve",
          "Deny",
          "Cancel"
        ]
      },
      "description": "The registration action to perform. \n* `approve` - Approve the registrant. \n* `deny` - Reject the registrant. \n* `cancel` - Cancel the registrant's approval."
    },
    "registrants": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "9tboDiHUQAeOnbmudzWa5g",
            "description": "The registrant's ID."
          },
          "email": {
            "type": "string",
            "format": "email",
            "example": "jchill@example.com",
            "description": "The registrant's email address."
          }
        }
      },
      "maximum": 30,
      "description": "The registrant information."
    }
  }
}

object WebinarsUpdateRegistrationQuestionsRequest

{
  "type": "object",
  "title": "Webinar registrant questions",
  "properties": {
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "required": {
            "type": "boolean",
            "example": true,
            "description": "State whether the selected fields are required or optional."
          },
          "field_name": {
            "enum": [
              "last_name",
              "address",
              "city",
              "country",
              "zip",
              "state",
              "phone",
              "industry",
              "org",
              "job_title",
              "purchasing_time_frame",
              "role_in_purchase_process",
              "no_of_employees",
              "comments"
            ],
            "type": "string",
            "example": "last_name",
            "extensions": {
              "x-enum-descriptions": [
                "Last name",
                "Address",
                "City",
                "Country/Region",
                "Zip/Postal code",
                "State/Province",
                "Phone",
                "Industry",
                "Organization",
                "Job title",
                "Purchasing time frame",
                "Role in purchase process",
                "Number of employees",
                "Questions & comments"
              ]
            },
            "description": "Field name"
          }
        }
      },
      "description": "Array of registration fields whose values should be provided by registrants."
    },
    "custom_questions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "enum": [
              "short",
              "single_radio",
              "single_dropdown",
              "multiple"
            ],
            "type": "string",
            "example": "short",
            "extensions": {
              "x-enum-descriptions": [
                "Short Answer",
                "Single Radio Answer",
                "Single Dropdown Answer",
                "Multiple Answer"
              ]
            },
            "description": "The question-answer type."
          },
          "title": {
            "type": "string",
            "example": "How are you?",
            "description": "Custom question."
          },
          "answers": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "Good"
            },
            "description": "An array of answer choices. Can't be used for short answer type."
          },
          "required": {
            "type": "boolean",
            "example": true,
            "description": "State whether or not a registrant is required to answer the custom question."
          }
        }
      },
      "description": "Array of custom questions for registrants."
    }
  },
  "description": "Webinar registrant questions."
}

object WebinarsUpdateScheduledWebinarRequest

{
  "type": "object",
  "properties": {
    "type": {
      "enum": [
        5,
        6,
        9
      ],
      "type": "integer",
      "default": 5,
      "example": 5,
      "extensions": {
        "x-enum-descriptions": [
          "Webinar",
          "Recurring Webinar with no fixed time",
          "Recurring Webinar with fixed time"
        ]
      },
      "description": "Webinar types. \n `5` - webinar.  \n `6` - Recurring webinar with no fixed time.  \n `9` - Recurring webinar with a fixed time."
    },
    "topic": {
      "type": "string",
      "example": "My webinar",
      "description": "The webinar topic."
    },
    "agenda": {
      "type": "string",
      "example": "My Webinar",
      "description": "Webinar description."
    },
    "duration": {
      "type": "integer",
      "example": 60,
      "description": "Webinar duration, in minutes. Used for scheduled webinar only."
    },
    "password": {
      "type": "string",
      "example": "123456",
      "maxLength": 10,
      "description": "[Webinar passcode](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords). By default, passcode may only contain the following characters: [a-z A-Z 0-9 @ - _ * !] and can have a maximum of 10 characters.\n\n**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.   \n   \n If the requirements are enabled, you can 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. \n\nIf **Require a passcode when scheduling new meetings** setting has been **enabled** **and** [locked](https://support.zoom.us/hc/en-us/articles/115005269866-Using-Tiered-Settings#locked) for the user, the passcode field will be autogenerated for the webinar in the response even if it is not provided in the API request."
    },
    "settings": {
      "type": "object",
      "properties": {
        "audio": {
          "enum": [
            "both",
            "telephony",
            "voip",
            "thirdParty"
          ],
          "type": "string",
          "default": "both",
          "example": "telephony",
          "extensions": {
            "x-enum-descriptions": [
              "Both Telephony and VoIP",
              "Telephony only",
              "VoIP only",
              "Third party audio conference"
            ]
          },
          "description": "Determine how participants can join the audio portion of the webinar."
        },
        "hd_video": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Default to HD video."
        },
        "on_demand": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Make the webinar on-demand."
        },
        "host_video": {
          "type": "boolean",
          "example": true,
          "description": "Start video when host joins the webinar."
        },
        "survey_url": {
          "type": "string",
          "example": "https://example.com",
          "description": "Survey url for post webinar survey"
        },
        "contact_name": {
          "type": "string",
          "example": "Jill Chill",
          "description": "Contact name for registration"
        },
        "add_watermark": {
          "type": "boolean",
          "example": true,
          "description": "Add watermark that identifies the viewing participant."
        },
        "approval_type": {
          "enum": [
            0,
            1,
            2
          ],
          "type": "integer",
          "default": 2,
          "example": 0,
          "extensions": {
            "x-enum-descriptions": [
              "Automatically Approve",
              "Manually Approve",
              "No Registration Required"
            ]
          },
          "description": "`0` - Automatically approve.  \n `1` - Manually approve.  \n `2` - No registration required."
        },
        "contact_email": {
          "type": "string",
          "example": "jchill@example.com",
          "description": "Contact email for registration"
        },
        "enforce_login": {
          "type": "boolean",
          "example": true,
          "deprecated": true,
          "description": "Only signed in users can join this meeting.\n\n**This field is deprecated and will not be supported in the future.** \n\n 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 webinar."
        },
        "auto_recording": {
          "enum": [
            "local",
            "cloud",
            "none"
          ],
          "type": "string",
          "default": "none",
          "example": "cloud",
          "extensions": {
            "x-enum-descriptions": [
              "Record to local device",
              "Record to cloud",
              "No Recording"
            ]
          },
          "description": "Automatic recording. \n `local` - Record on local.  \n `cloud` -  Record on cloud.  \n `none` - Disabled."
        },
        "email_language": {
          "type": "string",
          "example": "en-US",
          "description": "Set the email language to one of the following.\n`en-US`,`de-DE`,`es-ES`,`fr-FR`,`jp-JP`,`pt-PT`,`ru-RU`,`zh-CN`, `zh-TW`, `ko-KO`, `it-IT`, `vi-VN`."
        },
        "panelists_video": {
          "type": "boolean",
          "example": true,
          "description": "Start video when panelists join the webinar."
        },
        "practice_session": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Enable practice session."
        },
        "alternative_hosts": {
          "type": "string",
          "example": "jchill@example.com",
          "description": "Alternative host emails or IDs. Separate multiple values by commas."
        },
        "registration_type": {
          "enum": [
            1,
            2,
            3
          ],
          "type": "integer",
          "default": 1,
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Attendees register once and can attend any of the occurrences",
              "Attendees need to register for each occurrence to attend",
              "Attendees register once and can choose one or more occurrences to attend"
            ]
          },
          "description": "Registration types. Only used for recurring webinars with a fixed time.  \n `1` - Attendees register once and can attend any of the webinar sessions.  \n `2` - Attendees need to register for each session in order to attend.  \n `3` - Attendees register once and can choose one or more sessions to attend."
        },
        "show_share_button": {
          "type": "boolean",
          "example": true,
          "description": "Show social share buttons on the registration page."
        },
        "close_registration": {
          "type": "boolean",
          "example": true,
          "deprecated": true,
          "description": "Close registration after event date."
        },
        "notify_registrants": {
          "type": "boolean",
          "example": true,
          "description": "Send notification email to registrants when the host updates a webinar."
        },
        "add_audio_watermark": {
          "type": "boolean",
          "example": true,
          "description": "Add audio watermark that identifies the participants."
        },
        "authentication_name": {
          "type": "string",
          "example": "Sign in to Zoom",
          "description": "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)."
        },
        "post_webinar_survey": {
          "type": "boolean",
          "example": true,
          "description": "Zoom will open a survey page in attendees' browsers after leaving the webinar."
        },
        "question_and_answer": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Enable [Q&amp;A](https://support.zoom.us/hc/en-us/articles/203686015-Using-Q-A-as-the-webinar-host#:~:text=Overview,and%20upvote%20each%20other's%20questions.) for webinar.\n\n* `false` - Disable Q&amp;A for webinar."
            },
            "auto_reply_text": {
              "type": "string",
              "example": "Thank you for your question. We will get back to you shortly.",
              "description": "If `allow_auto_reply` = true, the text to be included in the automatic response. "
            },
            "allow_auto_reply": {
              "type": "boolean",
              "example": true,
              "description": "If simulive webinar, \n\n* `true` - allow auto-reply to attendees. \n\n* `false` - don't allow auto-reply to the attendees."
            },
            "answer_questions": {
              "enum": [
                "only",
                "all"
              ],
              "type": "string",
              "example": "all",
              "description": "Indicate whether you want attendees to be able to view answered questions only or view all questions.\n\n* `only` - Attendees are able to view answered questions only.\n\n*  `all` - Attendees are able to view all questions submitted in the Q&amp;A."
            },
            "attendees_can_upvote": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Attendees can click the thumbs up button to bring popular questions to the top of the Q&amp;A window.\n\n* `false` - Attendees can't click the thumbs up button on questions."
            },
            "attendees_can_comment": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Attendees can answer questions or leave a comment in the question thread.\n\n* `false` - Attendees can't answer questions or leave a comment in the question thread."
            },
            "allow_submit_questions": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Allow participants to submit questions.\n\n* `false` - Do not allow submit questions."
            },
            "allow_anonymous_questions": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Allow participants to send questions without providing their name to the host, co-host, and panelists..\n\n* `false` - Do not allow anonymous questions."
            }
          },
          "description": "[Q&amp;A](https://support.zoom.us/hc/en-us/articles/203686015-Using-Q-A-as-the-webinar-host#:~:text=Overview,and%20upvote%20each%20other's%20questions.) for webinar."
        },
        "audio_conference_info": {
          "type": "string",
          "example": "test",
          "maxLength": 2048,
          "description": "Third party audio conference info."
        },
        "authentication_option": {
          "type": "string",
          "example": "signIn_D8cJuqWVQ623CI4Q8yQK0Q",
          "description": "Webinar authentication option ID."
        },
        "enforce_login_domains": {
          "type": "string",
          "example": "example.com",
          "deprecated": true,
          "description": "Only signed in users with specified domains can join meetings.\n\n**This field is deprecated and will not be supported in the future.**\n\n 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 webinar."
        },
        "allow_multiple_devices": {
          "type": "boolean",
          "example": true,
          "description": "Allow attendees to join from multiple devices."
        },
        "authentication_domains": {
          "type": "string",
          "example": "example.com",
          "description": "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."
        },
        "hd_video_for_attendees": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether HD video for attendees is enabled."
        },
        "meeting_authentication": {
          "type": "boolean",
          "example": true,
          "description": "Only authenticated users can join the webinar."
        },
        "enable_session_branding": {
          "type": "boolean",
          "example": true,
          "description": "Whether the **Webinar Session Branding** setting is enabled. This setting lets hosts visually customize a webinar by setting a session background. This also lets hosts use [Webinar Session Branding](https://support.zoom.us/hc/en-us/articles/4836268732045-Using-Webinar-Session-Branding) to set the virtual background for and apply name tags to hosts, alternative hosts, panelists, interpreters, and speakers."
        },
        "language_interpretation": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "Enable [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars) for the webinar."
            },
            "interpreters": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "format": "email",
                    "example": "interpreter@example.com",
                    "description": "The interpreter's email address."
                  },
                  "languages": {
                    "type": "string",
                    "example": "US,CN",
                    "description": "A comma-separated list of the interpreter's languages. The string must contain two letter [country codes](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries). \n\nIf the interpreter will translate from English to Chinese, then this value will be `US,CN`."
                  }
                }
              },
              "description": "Information about the webinar's language interpreters."
            }
          },
          "description": "The webinar's [language interpretation settings](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note** This feature is only available for certain webinar add-ons, and for Education, and Business, and higher plans. If this feature is not enabled on the host's account, this setting will **not** be applied to the webinar."
        },
        "panelist_authentication": {
          "type": "boolean",
          "example": true,
          "description": "Require panelists to authenticate to join."
        },
        "global_dial_in_countries": {
          "type": "array",
          "items": {
            "type": "string",
            "example": "US"
          },
          "description": "List of global dial-in countries"
        },
        "registrants_restrict_number": {
          "type": "integer",
          "default": 0,
          "example": 100,
          "maximum": 20000,
          "minimum": 0,
          "description": "Restrict number of registrants for a webinar. By default, it is set to `0`. A `0` value means that the restriction option is disabled. Provide a number higher than 0 to restrict the webinar registrants by the that number."
        },
        "sign_language_interpretation": {
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "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 webinar."
            },
            "interpreters": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "format": "email",
                    "example": "interpreter@example.com",
                    "description": "The interpreter's email address."
                  },
                  "sign_language": {
                    "type": "string",
                    "example": "American",
                    "description": "The interpreter's sign language. \n\n To get this value, use the `sign_language_interpretation` object's `languages` and `custom_languages` values in the [**Get user settings**](/api-reference/zoom-api/methods#operation/userSettings) API response."
                  }
                }
              },
              "maximum": 20,
              "description": "Information about the webinar's sign language interpreters."
            }
          },
          "description": "The webinar's [sign language interpretation settings](https://support.zoom.us/hc/en-us/articles/9644962487309-Using-sign-language-interpretation-in-a-meeting-or-webinar). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** If this feature is not enabled on the host's account, this setting will **not** be applied to the webinar."
        },
        "alternative_host_update_polls": {
          "type": "boolean",
          "example": true,
          "description": "Whether the **Allow alternative hosts to add or edit polls** feature is enabled. This requires Zoom version 5.8.0 or higher."
        },
        "send_1080p_video_to_attendees": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Always send 1080p video to attendees."
        },
        "registrants_confirmation_email": {
          "type": "boolean",
          "example": true,
          "description": "Send confirmation email to registrants"
        },
        "registrants_email_notification": {
          "type": "boolean",
          "example": true,
          "description": "Send email notifications to registrants about approval, cancellation, denial of the registration. The value of this field must be set to true in order to use the `registrants_confirmation_email` field."
        },
        "follow_up_absentees_email_notification": {
          "type": "object",
          "properties": {
            "type": {
              "enum": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7
              ],
              "type": "integer",
              "example": 0,
              "extensions": {
                "x-enum-descriptions": [
                  "Send 1 days after the scheduled end date.",
                  "Send 2 days after the scheduled end date.",
                  "Send 3 days after the scheduled end date.",
                  "Send 4 days after the scheduled end date.",
                  "Send 5 days after the scheduled end date.",
                  "Send 6 days after the scheduled end date.",
                  "Send 7 days after the scheduled end date."
                ]
              },
              "description": "`0` - No plan.  \n `1` - Send 1 days after the scheduled end date.  \n `2` - Send 2 days after the scheduled end date.  \n `3` - Send 3 days after the scheduled end date.  \n `4` - Send 4 days after the scheduled end date.  \n `5` - Send 5 days after the scheduled end date.  \n `6` - Send 6 days after the scheduled end date.  \n `7` - Send 7 days after the scheduled end date."
            },
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Send follow-up email to absentees.\n\n* `false` - Do not send follow-up email to absentees."
            }
          },
          "description": "Send follow-up email to absentees."
        },
        "follow_up_attendees_email_notification": {
          "type": "object",
          "properties": {
            "type": {
              "enum": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7
              ],
              "type": "integer",
              "example": 0,
              "extensions": {
                "x-enum-descriptions": [
                  "Send 1 day after the scheduled end date.",
                  "Send 2 days after the scheduled end date.",
                  "Send 3 days after the scheduled end date.",
                  "Send 4 days after the scheduled end date.",
                  "Send 5 days after the scheduled end date.",
                  "Send 6 days after the scheduled end date.",
                  "Send 7 days after the scheduled end date."
                ]
              },
              "description": "`0` - No plan.  \n `1` - Send 1 day after the scheduled end date.  \n `2` - Send 2 days after the scheduled end date.  \n `3` - Send 3 days after the scheduled end date.  \n `4` - Send 4 days after the scheduled end date.  \n `5` - Send 5 days after the scheduled end date.  \n `6` - Send 6 days after the scheduled end date.  \n `7` - Send 7 days after the scheduled end date."
            },
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Send follow-up email to attendees.\n\n* `false` - Do not send follow-up email to attendees."
            }
          },
          "description": "Send follow-up email to attendees."
        },
        "panelists_invitation_email_notification": {
          "type": "boolean",
          "example": true,
          "description": "Send invitation email to panelists. If `false`, do not send invitation email to panelists."
        },
        "attendees_and_panelists_reminder_email_notification": {
          "type": "object",
          "properties": {
            "type": {
              "enum": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7
              ],
              "type": "integer",
              "example": 0,
              "extensions": {
                "x-enum-descriptions": [
                  "Send 1 hour before webinar.",
                  "Send 1 day before webinar.",
                  "Send 1 hour and 1 day before webinar.",
                  "Send 1 week before webinar.",
                  "Send 1 hour and 1 week before webinar.",
                  "Send 1 day and 1 week before webinar.",
                  "Send 1 hour, 1 day and 1 week before webinar."
                ]
              },
              "description": "`0` - No plan.  \n `1` - Send 1 hour before webinar.  \n `2` - Send 1 day before webinar.  \n `3` - Send 1 hour and 1 day before webinar.  \n `4` - Send 1 week before webinar.  \n `5` - Send 1 hour and 1 week before webinar.  \n `6` - Send 1 day and 1 week before webinar.  \n `7` - Send 1 hour, 1 day and 1 week before webinar."
            },
            "enable": {
              "type": "boolean",
              "example": true,
              "description": "* `true` - Send reminder email to attendees and panelists.\n\n* `false` - Do not send reminder email to attendees and panelists."
            }
          },
          "description": "Send reminder email to attendees and panelists."
        }
      },
      "description": "Webinar settings."
    },
    "timezone": {
      "type": "string",
      "example": "America/Los_Angeles",
      "description": "The timezone to assign to the `start_time` value. This field is only used for scheduled or recurring webinars with a fixed time.\n\nFor a list of supported timezones and their formats, see our [timezone list](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones)."
    },
    "recurrence": {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "enum": [
            1,
            2,
            3
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Daily",
              "Weekly",
              "Monthly"
            ]
          },
          "description": "Recurrence meeting types. \n `1` - Daily.  \n `2` - Weekly.  \n `3` - Monthly."
        },
        "end_times": {
          "type": "integer",
          "default": 1,
          "example": 7,
          "maximum": 60,
          "description": "Select how many times the webinar will recur before it is canceled. The maximum number of recurring is 60. Cannot be used with `end_date_time`."
        },
        "monthly_day": {
          "type": "integer",
          "default": 1,
          "example": 1,
          "description": "Use this field **only if you're scheduling a recurring meeting of type** `3` to state which day in a month, the meeting should recur. The value range is from 1 to 31.\n\nIf you would like the meeting to recur on 23rd of each month, provide `23` as the value of this field and `1` as the value of the `repeat_interval` field. 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`."
        },
        "weekly_days": {
          "enum": [
            "1",
            "2",
            "3",
            "4",
            "5",
            "6",
            "7"
          ],
          "type": "string",
          "default": "1",
          "example": "1",
          "description": "This field is required **if you're scheduling a recurring meeting of type** `2` to state which day(s) of the week the meeting should repeat.   \n    \n  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 the value of this field.  \n   \n  **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 the value of this field.\n\n   \n `1`  - Sunday.   \n `2` - Monday.  \n `3` - Tuesday.  \n `4` -  Wednesday.  \n `5` -  Thursday.  \n `6` - Friday.  \n `7` - Saturday."
        },
        "monthly_week": {
          "enum": [
            -1,
            1,
            2,
            3,
            4
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Last week",
              "First week",
              "Second week",
              "Third week",
              "Fourth week"
            ]
          },
          "description": "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.**   \n `-1` - Last week of the month.  \n `1` - First week of the month.  \n `2` - Second week of the month.  \n `3` - Third week of the month.  \n `4` - Fourth week of the month."
        },
        "end_date_time": {
          "type": "string",
          "format": "date-time",
          "example": "2022-04-02T15:59:00Z",
          "description": "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`."
        },
        "repeat_interval": {
          "type": "integer",
          "example": 1,
          "description": "Define the interval when the meeting should recur. If you would like to schedule a meeting that recurs every two months, set the value of this field as `2` and the value of the `type` parameter as `3`. \n\nFor 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.\n\n"
        },
        "monthly_week_day": {
          "enum": [
            1,
            2,
            3,
            4,
            5,
            6,
            7
          ],
          "type": "integer",
          "example": 1,
          "extensions": {
            "x-enum-descriptions": [
              "Sunday",
              "Monday",
              "Tuesday",
              "Wednesday",
              "Thursday",
              "Friday",
              "Saturday"
            ]
          },
          "description": "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. \n\n  \n `1` - Sunday.  \n `2` - Monday.  \n `3` - Tuesday.  \n `4` -  Wednesday.  \n `5` - Thursday.  \n `6` - Friday.  \n `7` - Saturday."
        }
      },
      "description": "Recurrence object. Use this object only for a meeting with type `8`, a recurring meeting with fixed time. "
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2022-03-26T07:18:32Z",
      "description": "Webinar start time, in the format `yyyy-MM-dd'T'HH:mm:ss'Z'`. Should be in GMT time. In the format `yyyy-MM-dd'T'HH:mm:ss`. This should be in local time and the timezone should be specified. Only used for scheduled webinars and recurring webinars with a fixed time."
    },
    "is_simulive": {
      "type": "boolean",
      "example": true,
      "description": "Whether to set the webinar simulive."
    },
    "schedule_for": {
      "type": "string",
      "example": "jchill@example.com",
      "description": "The user's email address or `userId` to schedule a webinar for."
    },
    "record_file_id": {
      "type": "string",
      "example": "f09340e1-cdc3-4eae-9a74-98f9777ed908",
      "description": "The previously recorded file's ID for `simulive`."
    },
    "tracking_fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "example": "field1",
            "description": "Tracking fields type."
          },
          "value": {
            "type": "string",
            "example": "value1",
            "description": "Tracking fields value."
          }
        }
      },
      "description": "Tracking fields."
    }
  },
  "description": "Webinar object."
}

object WebinarsUpdateStatusRequest

{
  "type": "object",
  "properties": {
    "action": {
      "enum": [
        "end"
      ],
      "type": "string",
      "example": "end",
      "extensions": {
        "x-enum-descriptions": [
          "end a webinar"
        ]
      }
    }
  }
}

object WebinarsUpdateStatusResponse

{
  "type": "object",
  "properties": {}
}

object WebinarsUpdateSurveyRequest

{
  "type": "object",
  "title": "Webinar survey object",
  "properties": {
    "custom_survey": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "example": "Learn something new",
          "maxLength": 64,
          "description": "The survey's title, up to 64 characters."
        },
        "feedback": {
          "type": "string",
          "example": "Thank you so much for taking the time to complete the survey. Your feedback really makes a difference.",
          "maxLength": 320,
          "description": "The survey's feedback, up to 320 characters. \n\n This value defaults to `Thank you so much for taking the time to complete the survey, your feedback really makes a difference.`."
        },
        "anonymous": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Allow participants to anonymously answer survey questions. \n* `true` - Anonymous survey enabled. \n* `false` - Participants cannot answer survey questions anonymously. \n\n This value defaults to `true`."
        },
        "questions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "example": "How useful was this webinar?",
                "description": "The survey question, up to 420 characters."
              },
              "type": {
                "enum": [
                  "single",
                  "multiple",
                  "matching",
                  "rank_order",
                  "short_answer",
                  "long_answer",
                  "fill_in_the_blank",
                  "rating_scale"
                ],
                "type": "string",
                "example": "single",
                "extensions": {
                  "x-enum-descriptions": [
                    "Single choice",
                    "Multiple choice",
                    "Matching",
                    "Rank order",
                    "Short answer",
                    "Long answer",
                    "Fill in the blank",
                    "Rating scale"
                  ]
                },
                "description": "The survey's question and answer type. \n* `single` - Single choice. \n* `multiple` - Multiple choice. \n* `matching` - Matching. \n* `rank_order` - Rank order \n* `short_answer` - Short answer \n* `long_answer` - Long answer. \n* `fill_in_the_blank` - Fill in the blank \n* `rating_scale` - Rating scale."
              },
              "answers": {
                "type": "array",
                "items": {
                  "type": "string",
                  "example": "Extremely useful",
                  "maxLength": 200
                },
                "minItems": 2,
                "description": "The survey question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` questions, you can only provide a maximum of 50 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers."
              },
              "prompts": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "prompt_question": {
                      "type": "string",
                      "example": "How are you?",
                      "maxLength": 200,
                      "description": "The question prompt's title."
                    }
                  }
                },
                "maxItems": 10,
                "minItems": 2,
                "description": "Information about the prompt questions. This field only applies to `matching` and `rank_order` questions. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts."
              },
              "answer_required": {
                "type": "boolean",
                "default": false,
                "example": false,
                "description": "Whether participants must answer the question. \n* `true` - The participant must answer the question. \n* `false` - The participant does not need to answer the question. \n\n This value defaults to `false`."
              },
              "rating_max_label": {
                "type": "string",
                "example": "Extremely Likely",
                "maxLength": 50,
                "description": "The high score label used for the `rating_max_value` field, up to 50 characters. \n\n This field only applies to the `rating_scale` survey."
              },
              "rating_max_value": {
                "type": "integer",
                "example": 4,
                "maximum": 10,
                "description": "The rating scale's maximum value, up to a maximum value of 10. \n\n This field only applies to the `rating_scale` survey."
              },
              "rating_min_label": {
                "type": "string",
                "example": "Not likely",
                "maxLength": 50,
                "description": "The low score label used for the `rating_min_value` field, up to 50 characters. \n\n This field only applies to the `rating_scale` survey."
              },
              "rating_min_value": {
                "type": "integer",
                "example": 1,
                "minimum": 0,
                "description": "The rating scale's minimum value. This value can't be less than zero. \n\n This field only applies to the `rating_scale` survey."
              },
              "show_as_dropdown": {
                "type": "boolean",
                "default": false,
                "example": false,
                "description": "Whether to display the radio selection as a drop-down box. \n* `true` - Show as a drop-down box. \n* `false` - Do not show as a drop-down box. \n\n This value defaults to `false`."
              },
              "answer_max_character": {
                "type": "integer",
                "example": 200,
                "description": "The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` questions. \n* For `short_answer` question, a maximum of 500 characters. \n* For `long_answer` question, a maximum of 2,000 characters."
              },
              "answer_min_character": {
                "type": "integer",
                "example": 1,
                "minimum": 1,
                "description": "The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` questions. You must provide at least a **one** character minimum value."
              }
            }
          },
          "maxItems": 100,
          "minItems": 1,
          "description": "Information about the webinar survey's questions."
        },
        "numbered_questions": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to display the number in the question name. \n\n This value defaults to `true`."
        },
        "show_question_type": {
          "type": "boolean",
          "default": false,
          "example": false,
          "description": "Whether to display the question type in the question name. \n\n This value defaults to `false`."
        }
      },
      "description": "Information about the customized webinar survey."
    },
    "third_party_survey": {
      "type": "string",
      "example": "https://example.com",
      "maxLength": 64,
      "description": "The link to the third party webinar survey."
    },
    "show_in_the_browser": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Whether the **Show in the browser when the webinar ends** option is enabled. \n* `true` - Enabled. \n* `false` - Disabled. \n\n This value defaults to `true`."
    },
    "show_in_the_follow_up_email": {
      "type": "boolean",
      "default": false,
      "example": false,
      "description": "Whether the **Show the link on the follow-up email** option is enabled. \n* `true` - Enabled. \n* `false` - Disabled. \n\n This value defaults to `false`."
    }
  },
  "description": "Information about the webinar survey."
}

object WebinarsUploadBrandingVirtualBackgroundRequest

{
  "type": "object",
  "required": [
    "file"
  ],
  "properties": {
    "file": {
      "type": "string",
      "format": "binary",
      "example": "WVVoU01HTklUVFpNZVRsc1pVZEdkR05IZUd4TWJVNTJZbEU5UFE9PQ==",
      "description": "The Virtual Background's file path, in binary format."
    },
    "default": {
      "type": "boolean",
      "default": false,
      "example": true,
      "description": "Whether set the file as the default Virtual Background file."
    },
    "set_default_for_all_panelists": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Whether to set the Virtual Background file as the new default for all panelists. This includes panelists not currently assigned a default Virtual Background."
    }
  }
}

object WebinarsUploadBrandingVirtualBackgroundResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "J0sFXN2PSOCGrqTqLRwgAQ",
      "description": "The Virtual Background file's ID."
    },
    "name": {
      "type": "string",
      "example": "beach.jpg",
      "description": "The Virtual Background file's name."
    },
    "size": {
      "type": "integer",
      "example": 524288,
      "description": "The Virtual Background file's size, in bytes."
    },
    "type": {
      "enum": [
        "image"
      ],
      "type": "string",
      "example": "image",
      "description": "The Virtual Background file's file type: \n* `image` &mdash; An image file."
    },
    "is_default": {
      "type": "boolean",
      "example": true,
      "description": "Whether the file is the default Virtual Background file."
    }
  }
}

object WebinarsUploadBrandingWallpaperRequest

{
  "type": "object",
  "required": [
    "file"
  ],
  "properties": {
    "file": {
      "type": "string",
      "format": "binary",
      "description": "The wallpaper's file path, in binary format."
    }
  }
}

object WebinarsUploadBrandingWallpaperResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "zazQjwDuQkS3Q2EprNd7jQ",
      "description": "The wallpaper file's ID."
    },
    "name": {
      "type": "string",
      "example": "logo.jpg",
      "description": "The wallpaper file's name."
    },
    "size": {
      "type": "integer",
      "example": 262144,
      "description": "The wallpaper file's size, in bytes."
    },
    "type": {
      "enum": [
        "image"
      ],
      "type": "string",
      "example": "image",
      "description": "The wallpaper file's file type: \n* `image` &mdash; An image file."
    }
  }
}