mcp_config_webinar_management_operations.json•16.7 kB
{
"server": {
"url": "https://api.zoom.us/v2"
},
"authentication": [
{
"schema_parameters": {
"in": "header"
},
"type": "apiKey",
"value": "API_KEY"
}
],
"operations": [
{
"description": "List all the live or past webinars from a specified period of time. \u003cbr\u003e\u003cbr\u003e **Scopes:** `dashboard_webinars:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Resource-intensive`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Business, Education or API Plan with Webinar add-on.",
"name": "dashboard_webinars"
},
{
"description": "Retrieve details from live or past webinars.\u003cbr\u003e\u003cbr\u003e **Scopes:** `dashboard_webinars:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Business, Education or API Plan with Webinar add-on.",
"name": "dashboard_webinar_detail"
},
{
"description": "Retrieve details on participants from live or past webinars.\u003cbr\u003e\u003cbr\u003e **Scopes:** `dashboard_webinars:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Business, Education or API Plan with Webinar add-on.",
"name": "dashboard_webinar_participants"
},
{
"description": "Retrieve a list of participants from live or past webinars and the quality of service they received.\u003cbr\u003eThis data indicates the connection quality for sending/receiving video, audio, and shared content. If nothing is being sent or received at that time, no information will be shown in the fields.\u003cbr\u003e **Scopes:** `dashboard_webinars:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:** * Business, Education or API Plan with Webinar add-on.",
"name": "dashboard_webinar_participants_q_o_s"
},
{
"description": "When a Webinar ends, each attendee will be prompted to share their Webinar experience by clicking either thumbs up or thumbs down. Use this API to retrieve the feedback submitted for a specific webinar. Note that this API only works for meetings scheduled after December 20, 2020. **Prerequisites:** * [Feedback to Zoom](https://support.zoom.us/hc/en-us/articles/115005838023) setting must be enabled by the participant prior to the meeting. * The user making the API request must be enrolled in a Business or a higher plan. \u003cbr\u003e **Scope:** `dashboard_webinars:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e",
"name": "participant_webinar_feedback"
},
{
"description": "Retrieve the sharing and recording details of participants from live or past webinars. \u003cbr\u003e\u003cbr\u003e **Scopes:** `dashboard_webinars:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy` \u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Business, Education or API Plan with Webinar add-on.",
"name": "dashboard_webinar_participant_share"
},
{
"description": "Retrieve details on the quality of service that participants from live or past webinars recieved.\u003cbr\u003eThis data indicates the connection quality for sending/receiving video, audio, and shared content. If nothing is being sent or received at that time, no information will be shown in the fields.\u003cbr\u003e **Scopes:** `dashboard_webinars:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy` \u003cbr\u003e **Prerequisites:** \u003cbr\u003e * Business, Education or API Plan with Zoom Rooms set up.",
"name": "dashboard_webinar_participant_q_o_s"
},
{
"description": "List absentees of a webinar.\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:read:admin` `webinar:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
"name": "webinar_absentees"
},
{
"description": "**Note: This API has been deprecated and is no longer supported due to GCM encryption updates for security purposes.** List files sent via in-meeting chat during a meeting. The in-meeting files are deleted after 24 hours of the meeting completion time. \u003cbr\u003e\u003cbr\u003e **Scope:** `webinar:read`, `webinar:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e",
"name": "list_past_webinar_files"
},
{
"description": "List past webinar instances.\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:read:admin` `webinar:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e",
"name": "past_webinars"
},
{
"description": "Use this API to list all the participants who attended a webinar hosted in the past. \u003cbr\u003e **Prerequisites:** * Pro or higher plan with a Webinar Add-on.\u003cbr\u003e **Scopes:** `webinar:read:admin` `webinar:read`\u003cbr\u003e \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e",
"name": "list_webinar_participants"
},
{
"description": "The polling feature for webinar allows you to create single choice or multiple choice polling questions for your webinars. Use this API to retrieve the results for Webinar Polls of a specific Webinar. **Prerequisites:**\u003cbr\u003e * [Webinar license](https://zoom.us/webinar)\u003cbr\u003e **Scopes**: `webinar:read:admin`, `webinar:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "list_past_webinar_poll_results"
},
{
"description": "The [Question \u0026 Answer (Q\u0026A)](https://support.zoom.us/hc/en-us/articles/203686015-Getting-Started-with-Question-Answer) feature for Webinars allows attendees to ask questions during the Webinar and for the panelists, co-hosts and host to answer their questions.\u003cbr\u003e Use this API to list Q\u0026A of a specific Webinar. **Prerequisites:**\u003cbr\u003e * [Webinar license](https://zoom.us/webinar)\u003cbr\u003e **Scopes**: `webinar:read:admin`, `webinar:read`\u003cbr\u003e \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "list_past_webinar_q_a"
},
{
"description": "Retrieve a [report](https://support.zoom.us/hc/en-us/articles/201393719-Webinar-Reporting) containing past webinar details. \u003cbr\u003e\u003cbr\u003e **Scopes:** `report:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or higher plan with Webinar add-on.",
"name": "report_webinar_details"
},
{
"description": "Get detailed report on each attendee of a webinar.\u003cbr\u003e\u003cbr\u003e **Scopes:** `report:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher plan with Webinar add-on enabled.",
"name": "report_webinar_participants"
},
{
"description": "Retrieve a report on past [webinar polls](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars).\u003cbr\u003e\u003cbr\u003e **Scopes:** `report:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher plan with Webinar add-on enabled.",
"name": "report_webinar_polls"
},
{
"description": "The Question \u0026 Answer (Q\u0026A) feature for webinars allows attendees to ask questions during the webinar and for the panelists, co-hosts and host to answer their questions. Use this API to retrieve a report on question and answers from past webinars. \u003cbr\u003e\u003cbr\u003e **Scopes:** `report:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher plan with Webinar add-on enabled.",
"name": "report_webinar_q_a"
},
{
"description": "When you schedule a webinar, you can save the settings for that webinar as a template for scheduling future webinars. \u003cbr\u003e\u003cbr\u003eUse this API to list a user\u0027s existing [Webinar templates\u0027](https://support.zoom.us/hc/en-us/articles/115001079746-Webinar-Templates) information. **Prerequisites:** * Pro or a higher account with Webinar plan enabled.",
"name": "list_webinar_templates"
},
{
"description": "Zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.\u003cbr\u003e Use this API to list all the webinars that are scheduled by or on-behalf a user (Webinar host).\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:read:admin` `webinar:read`\u003cbr\u003e \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` **Prerequisites:** * Pro or higher plan with a Webinar Add-on.",
"name": "webinars"
},
{
"description": "Zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.\u003cbr\u003eUse this API to schedule a Webinar for a user (host).\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:write:admin` `webinar:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites:** * Pro or higher plan with a Webinar Add-on.",
"name": "webinar_create"
},
{
"description": "Delete a Webinar.\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:write:admin` `webinar:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or higher plan with a Webinar Add-on.",
"name": "webinar_delete"
},
{
"description": "Zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.\u003cbr\u003eUse this API to get details of a scheduled webinar.\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:read:admin` `webinar:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e**Prerequisites:** * Pro or higher plan with a Webinar Add-on.",
"name": "webinar"
},
{
"description": "Zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.\u003cbr\u003e Use this API to make updates to a scheduled Webinar.\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:write:admin` `webinar:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or higher plan with a Webinar Add-on.",
"name": "webinar_update"
},
{
"description": "Remove all the panelists from a Webinar.\u003cbr\u003e **Scopes:** `webinar:write:admin` `webinar:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher plan with [Webinar Add-on](https://zoom.us/webinar).\u003cbr\u003e",
"name": "webinar_panelists_delete"
},
{
"description": "Panelists in a Webinar can view and send video, screen share, annotate, etc and do much more compared to attendees in a webinar.\u003cbr\u003eUse this API to [add panelists](https://support.zoom.us/hc/en-us/articles/115005657826-Inviting-Panelists-to-a-Webinar#h_7550d59e-23f5-4703-9e22-e76bded1ed70) to a scheduled webinar.\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:write:admin` `webinar:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e **Prerequisites:** * Pro or a higher plan with [Webinar Add-on](https://zoom.us/webinar).\u003cbr\u003e",
"name": "webinar_panelist_create"
},
{
"description": "List all the [polls](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) of a Webinar.\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:read:admin` `webinar:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e",
"name": "webinar_polls"
},
{
"description": "Delete a webinar\u0027s [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars).\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:write:admin` `webinar:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e",
"name": "webinar_poll_delete"
},
{
"description": "Get a webinar\u0027s [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) details.\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:read:admin` `webinar:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e",
"name": "webinar_poll_get"
},
{
"description": "Zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a [Webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form before receiving the link to join the Webinar.\u003cbr\u003eUse this API to create and submit the registration of a user for a webinar.\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:write:admin` `webinar:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites:** * Pro or higher plan with a Webinar Add-on.",
"name": "webinar_registrant_create"
},
{
"description": "Delete a webinar registrant.\u003cbr\u003e\u003cbr\u003e **Scopes**: `webinar:write:admin` `webinar:write`\u003cbr\u003e \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "delete_webinar_registrant"
},
{
"description": "Update a webinar\u0027s status. Use this API to end an ongoing webinar.\u003cbr\u003e\u003cbr\u003e **Scopes:** `webinar:write:admin` `webinar:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * The account must hold a valid [Webinar plan](https://zoom.us/webinar).",
"name": "webinar_status"
},
{
"description": "[Webinar Registration Tracking Sources](https://support.zoom.us/hc/en-us/articles/360000315683-Webinar-Registration-Source-Tracking) allow you to see where your registrants are coming from if you share the webinar registration page in multiple platforms. You can then use the source tracking to see the number of registrants generated from each platform.\u003cbr\u003e Use this API to list information on all the tracking sources of a Webinar.\u003cbr\u003e **Scopes:** `webinar:read:admin`, `webinar:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e **Prerequisites**:\u003cbr\u003e * [Webinar license](https://zoom.us/webinar). * Registration must be required for the Webinar.",
"name": "get_tracking_sources"
}
]
}