Zoom
Overview
Zoom is an all-in-one intelligent collaboration platform that makes connecting easier, more immersive, and more dynamic for businesses and individuals. Connect with Zoom to develop custom video conferencing solutions, automate meeting-related tasks, create a webinar manager, and synchronize data across Zoom applications in Superblocks effectively.
Setting up Zoom
Create an access token
To begin using Zoom in Superblocks, follow these steps:
- Navigate to the Zoom App Marketplace
- Sign in to your Zoom account
- Navigate to Develop then Build App in the navigation bar
- Create a new Zoom App
- Grab the Callback URL from the configuration form in Superblocks and paste this in as the Redirect URL in your Zoom App. You also need to add this URL to your Zoom App's OAuth Allow List
- Configure the scopes available to your Zoom App. This is the superset of all scopes your app can access - you will select the scopes for the specific integration in Superblocks
- Grab the Client ID and Client Secret from the App Credentials tab in Zoom and paste these into the configuration form in Superblocks
- Populate the scopes for the integration in the configuration form in Superblocks
Learn more about Zoom API Authentication
Add integration
Once you have an access token, you're ready to set up your Superblocks integration.
- In the web app, navigate to the Integrations page
- Click on the Zoom tile
- Name the integration
- Paste your credentials into the relevant fields
- Optionally, add more configurations to set credentials for different environments
- Click Create
tip
Zoom connected Now you can use Zoom in any Application, Workflow, or Scheduled Job.
Use Zoom in APIs
Once your Zoom integration is created, you can start calling Zoom actions in Superblocks APIs.
Zoom actions are REST requests. To learn more about REST requests in Superblocks, see the Building REST requests guide.
Supported actions
Get locked settings
Retrieve an account's locked settings. Account admins and account owners can use [Account Locked Settings](https://support.zoom.us/hc/en-us/articles/115005269866) to toggle settings on or off for all users in their account. **Note:** You can use Account Locked Settings with accounts that have master and sub accounts enabled. **Prerequisites:** * Pro or a higher paid account. **Scopes:** `account:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`Update locked settings
Update an account's locked settings. [Account Locked Settings](https://support.zoom.us/hc/en-us/articles/115005269866) allows account admins and account owners to toggle settings on or off for all users in your account. **Note:** Yout must have a Pro or a higher plan and enabled master and sub accounts options. **Prerequisites:** * Pro or a higher paid account. **Scopes:** `account:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`Get account's managed domains
Retrieve a list of an account's [managed domains](https://support.zoom.us/hc/en-us/articles/203395207). To get the master account's managed domains, pass the `me` value for the `accountId` path parameter. **Prerequisites:** * A Pro or a higher paid account with the Master account option enabled. **Scopes:** `account:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`Update the account owner
Use this API to change an account's owner. An account's current owner can [change the account's owner](https://support.zoom.us/hc/en-us/articles/115005686983-Change-Account-Owner) to another user on the same account. **Prerequisites:** * An account owner or admin permissions of an account * The account making this API request must be on a Pro or a higher account plan with [Master account](https://marketplace.zoom.us/docs/api-reference/master-account-apis) privileges **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`Get account settings
Get an account's settings. To get settings for a master account, use the `me` value for the `accountId` path parameter. **Prerequisites:** * The account must be a paid account. **Scopes:** `account:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`Update account settings
Update an account's settings. To update the settings for a master account, pass the `me` value for the `accountId` path parameter. **Prerequisites:** * The account must be a paid account. **Scopes:** `account:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`Get an account's webinar registration settings
Get an account's webinar registration settings. To get the master account's webinar registration settings, use the `me` value for the `accountId` path parameter. **Prerequisites:** * The account must be a paid account. **Scopes:** `account:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`Update an account's webinar registration settings
Update an account's webinar registration settings. To update the master account's webinar registration settings, pass the `me` value for the `accountId` path parameter. **Prerequisites:** * The account must be a paid account. **Scopes:** `account:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`Upload Virtual Background files
[Upload virtual background files](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_01EJF3YFEWGT8YA0ZJ079JEDQE) for all users on the account to use. **Prerequisites:** * The [Virtual Background feature](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_2ef28080-fce9-4ac2-b567-dc958afab1b7) must be enabled on the account. **Scopes:** `account:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`Delete virtual background files
Delete an account's existing virtual background files. **Prerequisites:** * The [Virtual Background feature](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_2ef28080-fce9-4ac2-b567-dc958afab1b7) must be enabled on the account. **Scopes:** `account:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`Get account's trusted domains
Retrieve an account's [trusted domains](https://support.zoom.us/hc/en-us/articles/203395207). To get the master account's trusted domains, use the `me` value for the `accountId` path parameter. **Prerequisites:** * The account must be a paid account. **Scopes:** `account:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`Send app notifications
Send app notifications to the Zoom "Activity Center". (Note: This API only supports OAuth 2.0.) **Scopes:** `app:notification:read`,`app:notification:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`Generate an app deeplink
Create an app deeplink. **Scopes:** `app:deeplink:write`,`app:deeplink:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`Get meeting recordings
Return all of a meeting's [recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording#h_7420acb5-1897-4061-87b4-5b76e99c03b4). Use the `download_url` property listed in the response to download the recording files. To access a password-protected cloud recording, send the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) as a Bearer token in the Authorization header. Example: `curl -H 'Authorization: Bearer <ACCESS_TOKEN>' https://{{base-domain}}/rec/archive/download/xyz` **Scopes:** `recording:read`,`phone_recording:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`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`Get Meeting Recording's Analytics Details
Use this API to return a meeting recording's [analytics details](https://support.zoom.us/hc/en-us/articles/205347605-Managing-cloud-recordings#h_0b665029-ce74-4849-9794-d1aa0320d163). **Maximum duration: 1 Month**. To access a password-protected cloud recording, send the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) as a Bearer token in the Authorization header. For example, `curl -H "Authorization: Bearer <ACCESS_TOKEN>" https://{{base-domain}}/rec/archive/download/xyz` **Scopes:** `recording:read:admin`,`recording:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`Get Meeting Recording's Analytics Summary
Use this API to return a meeting recording's [analytics summary](https://support.zoom.us/hc/en-us/articles/205347605-Managing-cloud-recordings#h_0b665029-ce74-4849-9794-d1aa0320d163). **Maximum duration: 1 Month**. To access a password-protected cloud recording, send the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) as a Bearer token in the Authorization header. For example, `curl -H "Authorization: Bearer <ACCESS_TOKEN>" https://{{base-domain}}/rec/archive/download/xyz` **Scopes:** `recording:read:admin`,`recording:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`List recording registrants
Use this API to list registrants of a past meeting's [on-demand cloud recordings](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-recordings). Users must [register](/docs/api-reference/zoom-api/methods#operation/meetingRecordingRegistrantCreate) to view the recordings. **Scopes:** `recording:read:admin`,`recording:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`Create a recording registrant
Cloud Recordings of past Zoom Meetings can be made [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings). Users should be [registered](/docs/api-reference/zoom-api/methods#operation/meetingRecordingRegistrantCreate) to view these recordings. Use this API to register a user to gain access to **On-demand Cloud Recordings** of a past meeting. **Scopes:** `recording:write:admin`,`recording:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Get registration questions
For [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) meeting recordings, you can include fields with questions that will be shown to registrants when they register to view the recording. Use this API to retrieve a list of questions that are displayed for users to complete when registering to view the recording of a specific meeting. **Scopes:** `recording:read:admin`,`recording:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Update registration questions
For [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) meeting recordings, you can include fields with questions that will be shown to registrants when they register to view the recording. Use this API to update registration questions that are to be answered by users while registering to view a recording. **Scopes:** `recording:write:admin`,`recording:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Update registrant's status
A registrant can either be approved or denied from viewing the [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) recording. Use this API to update a registrant's status. **Scopes:** `recording:write:admin`,`recording:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`Get meeting recording settings
Retrieve settings applied to a meeting's [Cloud Recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording). **Scopes:** `recording:read:admin`,`recording:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Update meeting recording settings
Update settings applied to a meeting's [Cloud Recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) **Scopes:** `recording:write:admin`,`recording:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Delete a meeting recording file
Delete a specific recording file from a meeting.<p style="background-color:#e1f5fe; color:#01579b; padding:8px"> <b>Note:</b> To use this API, you must enable the <b>The host can delete cloud recordings</b> setting. You can find this setting in the <b>Recording</b> tab of the <b>Settings</b> interface in the [Zoom web portal](https://zoom.us/).</p> **Scopes:** `recording:write:admin`,`recording:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Recover a single recording
Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use this API to recover a single recording file from the meeting. **Scopes:** `recording:write:admin`,`recording:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Recover meeting recordings
Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use this API to recover all deleted [Cloud Recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) of a specific meeting. **Prerequisites**: * A Pro user with Cloud Recording enabled. **Scopes:** `recording:write:admin`,`recording:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`List all recordings
List all [cloud recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) for a user. For user-level apps, pass the [`me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter. To access a user's password protected cloud recording, send the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) as a bearer token in the authorization header. Example: `curl -H "Authorization: Bearer <ACCESS_TOKEN>" https://{{base-domain}}/rec/archive/download/xyz` **Prerequisites:** * Must have a Pro or a higher plan. * Must enable Cloud Recording on the user's account. **Scopes:** `recording:read:admin`,`recording:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`List Users
List users on your accountRetrieve a user
Retrieve a user on your accountCheck a user's email
Check if the user email existsCheck a user's personal meeting room name
Check if the user's personal meeting room name existsList groups
List [groups](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account. **Prerequisite**: Pro or higher account. **Scopes:** `group:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`Create a group
Use this API to create a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management). You can add a **maximum** of 100 groups in one account per day, and a maximum of 5000 groups in one account. If you enabled a new group via the user interface, you can also choose whether to display the group and set its privacy level. **Prerequisites**: * A Pro or higher account **Scopes:** `group:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Get a group
Get a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account. **Prerequisite**: Pro, Business, or Education account **Scopes:** `group:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Update a group
Update a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. **Prerequisite**: Pro, Business, or Education account **Scopes:** `group:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Delete a group
Delete an entire [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-). **Prerequisites:** * A Pro, Business, or Education account. **Scopes:** `group:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`List group admins
Use this API to return a list of [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) administrators under your account. **Prerequisites:** * A Pro, Business, or Education account **Scopes:** `group:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`Add group admins
Use this API to add administrators to a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. **Prerequisites:** * A Pro, Business, or Education account **Scopes:** `group:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`Delete a group admin
Use this API to remove a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) administrator in a Zoom account. **Prerequisites:** * A Pro, Business, or Education account **Scopes:** `group:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Get locked settings
Retrieve a [group's](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) locked settings. If you lock a setting, the group members will not be able to modify it individually. **Note:** The `force_pmi_jbh_password` field under meeting settings is to be deprecated on September 22, 2019. This field is replaced by another field that will provide the same functionality. **Prerequisite**: Pro, Business, or Education account **Scopes:** `group:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`Update locked settings
Update a [group's](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) locked settings. If you lock a setting, the group members cannot modify it individually. **Note:** The `force_pmi_jbh_password` field under meeting settings is deprecated as of September 22, 2019. This field will be replaced by another field that will provide the same functionality.</p> **Prerequisite**: Pro, Business, or Education account **Scopes:** `group:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`List group members
List the members of a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. **Prerequisite**: Pro, Business, or Education account **Scopes:** `group:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`Add group members
Use this API to add users to a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) in your account. **Prerequisites:** * A Pro, Business, or Education account **Scopes:** `group:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`Update a group member
Use this API to perform either of the following tasks: * Remove a group member from one group and move them to a different group. * Set a user's primary group. By default, the primary group is the first group that user is added to. If a user is a member of multiple groups, you can [assign the user a primary group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-#h_d07c7dcd-4fd8-485a-b5fe-a322e8d21c09). The user will use the primary group's settings by default. However, if the user is a member of a group with locked settings, those group settings will remain locked to the user. **Prerequisites:** * A Pro or higher account **Scopes:** `group:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`Delete a group member
Use this API to remove a user from a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) in an account. **Prerequisites:** * A Pro, Business, or Education account **Scopes:** `group:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Get a group's settings
Get settings for a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-). **Prerequisite**: Pro, Business, or Education account **Scopes:** `group:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`Update a group's settings
Update settings for a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-). **Note:**The `force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality **Prerequisite**: Pro, Business, or Education account **Scopes:** `group:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`Get a group's webinar registration settings
Get webinar registration settings for a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-). **Prerequisite**: Pro, Business, or Education account **Scopes:** `group:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`Update a group's webinar registration settings
Update webinar registration settings for a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-).<p style="background-color:#FEEFB3; color:#9F6000"> Note:</b> The `force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.</p> **Prerequisite**: Pro, Business, or Education account **Scopes:** `group:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`Upload Virtual Background files
Use this API to [upload Virtual Background files](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_01EJF3YFEWGT8YA0ZJ079JEDQE) for all users in a group to use. **Prerequisites:** * The [Virtual Background feature](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_2ef28080-fce9-4ac2-b567-dc958afab1b7) must be enabled on the account. **Scopes:** `group:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`Delete Virtual Background files
Use this API to delete a group's [Virtual Background files](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_01EJF3YFEWGT8YA0ZJ079JEDQE). **Prerequisites:** * The [Virtual Background feature](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_2ef28080-fce9-4ac2-b567-dc958afab1b7) must be enabled on the account. **Scopes:** `group:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`List information Barrier policies
Return a list of all [Information Barriers](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers) policies and their information. **Prerequisites:** * [Contact Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) to enable Information Barriers for your account. **Scopes:** `information_barriers:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`Create an Information Barrier policy
Create a new Information Barrier policy. [Information Barriers](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers) help customers control communication policies and meet regulatory requirements at scale. Use information barriers to prevent specific groups of users who possess sensitive information from communicating with others who should not know this information. **Prerequisites:** * [Contact Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) to enable Information Barriers for your account. **Scopes:** `information_barriers:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`Get an Information Barrier policy by ID
Return an [Information Barriers](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers) policy by its ID. **Prerequisites:** * [Contact Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) to enable Information Barriers for your account. **Scopes:** `information_barriers:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`Update an Information Barriers policy
Update an [Information Barriers](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers) policy. **Prerequisites:** * [Contact Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) to enable Information Barriers for your account. **Scopes:** `information_barriers:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`Remove an Information Barrier policy
Remove an [Information Barrier](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers) policy. **Prerequisites:** * [Contact Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) to enable Information Barriers for your account. **Scopes:** `information_barriers:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`Delete a live meeting message
Deletes a message in a live meeting based on ID. **Prerequisites:** * Have Zoom enable the DLP for 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`Use in-meeting controls
Control [in-meeting](https://support.zoom.us/hc/en-us/articles/360021921032-In-Meeting-Controls) features. In-meeting controls include starting and stopping a recording, pausing and resuming a recording, and inviting participants. **Note:** This API's recording control only works for cloud recordings. It does **not** work for local recordings. **Prerequisites:** * The meeting **must** be a live meeting **except** inviting participants to the meeting through [call out (phone)/(room system)]. * Recording control: [Cloud recording](https://support.zoom.us/hc/en-us/articles/360060231472-Enabling-cloud-recording) must be enabled on the account. * The user calling this API must be the host or an alternative meeting host. **Scopes:** `meeting:write`,`meeting:write:admin`,`meeting:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`Get a meeting
Retrieve the details of a meeting. **Scopes:** `meeting:read`,`meeting:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`Update a meeting
Update a meeting's details. **Note:** * This API has a rate limit of **100 requests per day**. Because of this, a meeting can only be updated for a maximum of **100 times within a 24-hour period**. * The `start_time` value **must** be a future date. If the value is omitted or a date in the past, the API ignores this value and will **not** update any recurring meetings. * If the `start_time` value is a future date, the `recurrence` object is **required**. **Scopes:** `meeting:write:admin`,`meeting:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`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`Perform batch poll creation
Polls allow the meeting host to survey attendees. Create batch [polls](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) for a meeting. **Prerequisites**: * Host user type must be **Pro** or higher plan. * Polling feature must 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`Perform batch registration
Register up to 30 registrants at once for a meeting that requires [registration](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings). **Prerequisites:** * The meeting host must be a Licensed user. * The meeting must require registration and should be of type `2`, i.e., they should be scheduled meetings. Instant meetings and Recurring meetings are not supported by this API. **Scopes:** `meeting:write`,`meeting:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`Get meeting invitation
Retrieve the meeting invitation note for a specific meeting. **Scopes:** `meeting:read`,`meeting:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`Create meeting's invite links
Create a batch of invitation links for a meeting. **Scopes:** `meeting:write:admin`,`meeting:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Get a meeting's join token for live streaming
Get a meeting's join token to allow live streaming. The join token allows a recording bot implemented using Zoom meeting SDK to connect to a Zoom meeting "hosted by the issuer of the token", and can call the streaming method automatically. It supports both regular live streaming, and raw streaming. **Prerequisites:** * A Pro or higher plan for the meeting host. * The **Allow livestreaming of meetings** user setting enabled in the Zoom web portal. **Scopes:** `meeting_token:read:admin:live_streaming`,`meeting_token:read:live_streaming` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Get a meeting's archive token for local archiving
Get a meeting's archive token to allow local archiving. The archive token allows a meeting SDK app or bot to get archive permission to access the meeting's raw audio and video media stream in real-time. **Prerequisites:** * A Pro or higher plan for the meeting host. * The **Archive meetings and webinars** account setting enabled in the Zoom web portal. **Scopes:** `meeting_token:read:admin:local_archiving` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Get a meeting's join token for local recording
Get a meeting's join token to allow for local recording. The join token lets a recording bot implemented using Zoom Meeting SDK to connect to a Zoom meeting. The recording bot can then automatically start locally recording. This supports both regular and raw local recording types. **Prerequisites:** * The **Local recording** user setting enabled in the Zoom web portal. **Scopes:** `meeting_token:read:admin:local_recording`,`meeting_token:read:local_recording` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Get livestream details
Zoom allows users to [livestream a meeting](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. Get a meeting's livestream configuration details such as Stream URL, Stream Key and Page URL. **Prerequisites:** * Meeting host must be a licensed user with a Pro or higher plan. * Live streaming details must have been [configured](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service#h_01589a6f-a40a-4e18-a448-cb746e52ebc5) for the meeting. **Scopes:** `meeting:read:admin`,`meeting:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Update a livestream
Update a meeting's livestream information. Zoom allows users to [livestream a meeting](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. **Prerequisites:** * Meeting host must have a Pro license. **Scopes:** `meeting:write:admin`,`meeting:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Update Live Stream Status
Zoom allows users to [livestream a meeting](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. Update the status of a meeting's livestream. **Prerequisites:** * Meeting host must have a Pro license. **Scopes:** `meeting:write:admin`,`meeting:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`List meeting polls
Polls allow the meeting host to survey attendees. List all [polls](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) of a meeting. **Prerequisites**: * Host user type must be **Pro** or higher plan. * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled. **Scopes:** `meeting:read:admin`,`meeting:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Create a meeting poll
Polls allow the meeting host to survey attendees. Create a [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) for a meeting. **Prerequisites**: * Host user type must be **Pro** or higher plan. * Polling feature must 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`Get a meeting poll
Polls allow the meeting host to survey attendees. Retrieve information about a specific meeting [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings). **Scopes:** `meeting:read:admin`,`meeting:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Update a meeting poll
Polls allow the meeting host to survey attendees. Update information of a specific meeting [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) **Scopes:** `meeting:write:admin`,`meeting:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`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`List meeting registrants
A host or a user with admin permission can require [registration for a Zoom meeting](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings). List users that have registered for a meeting. **Scopes:** `meeting:read:admin`,`meeting:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`Add a meeting registrant
Create and submit a user's registration to a meeting. See [Customizing webinar registration](https://support.zoom.us/hc/en-us/articles/202835649-Customizing-webinar-registration) for details on how to set the requirements for these fields. Note that there is a maximum limit of 4,999 registrants per meeting and users will see an error if the meeting's capacity is reached. **Prerequisites:** * The host must be a **Licensed** user type. **Scopes:** `meeting:write:admin`,`meeting:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`List registration questions
List registration questions that will be displayed to users while [registering for a meeting](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings). **Scopes:** `meeting:read`,`meeting:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Update registration questions
Update registration questions that will be displayed to users while [registering for a meeting](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings). **Scopes:** `meeting:write`,`meeting:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Update registrant's status
Update a meeting registrant's status by either approving, cancelling or denying a registrant from joining the meeting. **Scopes:** `meeting:write:admin`,`meeting:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`Get a meeting registrant
Retrieve details on a specific user who has registered for the meeting. A host or a user with administrative permissions can require [registration for Zoom meetings](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings). **Prerequisites:** * The account must have a Meeting plan **Scopes:** `meeting:read:admin`,`meeting:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`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`Get a meeting SIP URI with Passcode
Get a meeting's SIP URI. The URI consists of the meeting ID, (optional, user-supplied) passcode and participant identifier code. The API return data also includes additional fields to indicate whether the API caller has a valid Cloud Room Connector subscription, the participant identifier code from the URI, and the SIP URI validity period (in seconds). **Scopes:** `meeting:write:sip_dialing`,`meeting:write:admin:sip_dialing` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`Update meeting status
Update the status of a meeting. **Scopes:** `meeting:write:admin`,`meeting:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Get a meeting survey
Display information about a [meeting survey](https://support.zoom.us/hc/en-us/articles/4404969060621-Post-meeting-survey-and-reporting). **Prerequisites:** * The host has a **Pro** license. * The [**Meeting Survey**](https://support.zoom.us/hc/en-us/articles/4404939095053-Enabling-meeting-surveys) feature is enabled on the host's account. * The meeting must be a scheduled meeting. Instant meetings do not have survey features enabled. **Scopes:** `meeting:read`,`meeting:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`Update a meeting survey
Update 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 is enabled in the host's account. * The meeting must be a scheduled meeting. Instant meetings do not have survey features enabled. **Scopes:** `meeting:write:admin`,`meeting:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`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`Get meeting's token
Get a meeting's [closed caption token (caption URL)](https://support.zoom.us/hc/en-us/articles/115002212983-Using-a-third-party-closed-captioning-service). This token lets you use a third-party service to stream text to their closed captioning software to the Zoom meeting. **Prerequisites:** * The **Closed captioning** setting enabled in the Zoom web portal. * The **Allow use of caption API Token to integrate with 3rd-party Closed Captioning services** setting enabled. **Scopes:** `meeting:read`,`meeting:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Get past meeting details
Get information about a past meeting. **Scopes:** `meeting:read:admin`,`meeting:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`List past meeting instances
Return a list of past meeting instances. **Scopes:** `meeting:read:admin`,`meeting:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`Get past meeting participants
Retrieve information on participants from a past meeting. Note the API doesn't return results if there's only one participant in a meeting. **Prerequisites:** * Paid account on a Pro or higher plan. **Note**: [Double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) your UUID when using this API if the UUID begins with a '/'or contains '//' in it. **Scopes:** `meeting:read:admin`,`meeting:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`List past meeting's poll results
[Polls](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) allow the meeting host to survey attendees. List poll results of a meeting. **Prerequisites**: * Host user type must be **Pro**. * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled. **Scopes:** `meeting:read:admin`,`meeting:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`List Q&A of past meeting
The question & answer (Q&A) feature for Zoom Meetings lets attendees ask questions during a meeting and lets the other attendees answer those questions. List Q&A of a specific meeting. **Prerequisites:** * **Scopes:** `meeting:read:admin`,`meeting:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`List meeting templates
List available [meeting templates](https://support.zoom.us/hc/en-us/articles/360036559151-Meeting-templates) for a user. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. **Scopes:** `meeting:read`,`meeting:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`Create a meeting template from an existing meeting
Create a meeting template from an existing meeting. **Scopes:** `meeting:write:admin`,`meeting:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`List meetings
List a user's (meeting host) scheduled meetings. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. **Note:** * This API **only** supports scheduled meetings. This API does not return information about instant meetings. * This API only returns a user's [unexpired meetings](https://support.zoom.us/hc/en-us/articles/201362373-Meeting-ID#h_c73f9b08-c1c0-4a1a-b538-e01ebb98e844). **Scopes:** `meeting:read:admin`,`meeting:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`Create a meeting
[Create a meeting](https://support.zoom.us/hc/en-us/articles/201362413-Scheduling-meetings) for a user. For user-level apps, pass [the `me` value](/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter. * A meeting's `start_url` value is the URL a host or an alternative host can use to start a meeting. The expiration time for the `start_url` value is **two hours** for all regular users. * For `custCreate` meeting hosts (users created with the `custCreate` parameter via the [**Create users**](/api-reference/zoom-api/methods#operation/userCreate) API), the expiration time of the `start_url` parameter is **90 days** from the generation of the `start_url`. **Note:** For security reasons, the recommended way to programmatically (after expiry) get the updated `start_url` value is to call the [**Get a meeting**](/api-reference/zoom-api/methods#operation/meeting) API. Refer to the `start_url` value in the response. **100 requests per day**. The rate limit is applied against the `userId` of the **meeting host** used to make the request. **Scopes:** `meeting:write:admin`,`meeting:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`List a user's PAC accounts
Use this API to list a user's [Personal Audio Conference (PAC)](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) accounts. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. PAC allows Pro or higher account holders to host meetings through PSTN (phone dial-in) only. **Prerequisites:** * A Pro or higher plan with an [Audio Conferencing](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) subscription. * The [**Personal Audio Conference**](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference#h_01F5BPM447M6QDJXX50RSFXKJ3) setting enabled in the user's profile. **Scopes:** `pac:read:admin`,`pac:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Delete a live webinar message
Deletes a message in a live webinar based on ID. **Prerequisites:** * Have Zoom enable the DLP for 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`Get webinar absentees
List absentees of a webinar. **Scopes:** `webinar:read:admin`,`webinar:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`List past webinar instances
List past webinar instances. **Scopes:** `webinar:read:admin`,`webinar:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`List webinar participants
Use this API to list all the participants who attended a webinar hosted in the past. **Prerequisites:** * A Pro or higher plan with a Webinar add-on. **Scopes:** `webinar:read:admin`,`webinar:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`List past webinar poll results
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:** * [Webinar license](https://zoom.us/webinar) **Scopes:** `webinar:read:admin`,`webinar:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`List Q&A of past webinar
The [Question & Answer (Q&A)](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. Use this API to list Q&A of a specific Webinar. **Prerequisites:** * [Webinar license](https://zoom.us/webinar) **Scopes:** `webinar:read:admin`,`webinar:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`List webinar templates
Display a list of a user's [webinar templates](https://support.zoom.us/hc/en-us/articles/115001079746-Webinar-Templates). For user-level apps, pass [the `me` value](/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. When you schedule a webinar, save the settings for that webinar as a template for scheduling future webinars. To use a template when scheduling a webinar, use the `id` value in this API response in the `template_id` field of the [**Create a webinar**](/docs/api-reference/zoom-api/methods#operation/webinarCreate) API. **Prerequisites:** * A Pro or a higher account with the [Zoom Webinar plan](https://zoom.us/pricing/webinar). **Scopes:** `webinar:read:admin`,`webinar:read`Create a webinar template
Use this API to create a webinar template from an existing webinar. **Scopes:** `webinar:write:admin`,`webinar:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`List webinars
Use this API to list all the webinars scheduled by or on-behalf a user (webinar host). For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. Zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing webinars. Webinars allow a host to broadcast a Zoom meeting to up to 10,000 attendees. **Note:** This API only returns a user's [unexpired webinars](https://support.zoom.us/hc/en-us/articles/201362373-Meeting-ID#h_c73f9b08-c1c0-4a1a-b538-e01ebb98e844). **Prerequisites:** * A Pro or higher plan with the Webinar add-on. **Scopes:** `webinar:read:admin`,`webinar:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`Create a webinar
Schedule a webinar for a user (webinar host). For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter. Zoom users with a [Webinar plan](https://zoom.us/webinar) have access to creating and managing webinars. Webinars allow a host to broadcast a Zoom meeting to up to 10,000 attendees. **100 requests per day**. The rate limit is applied to the `userId` of the **webinar host** used to make the request. **Prerequisites:** * A Pro or higher plan with a Webinar add-on. **Scopes:** `webinar:write`,`webinar:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`Get a webinar
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. Use this API to get details of a scheduled webinar. **Prerequisites:** * Pro or higher plan with a Webinar Add-on. **Scopes:** `webinar:read:admin`,`webinar:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`Update a webinar
Use this API to make updates to a scheduled webinar. **100 requests per day**. The rate limit is applied to the `userId` of the **webinar host** used to make the request. **Prerequisites:** * A Pro or higher plan with a Webinar add-on. **Scopes:** `webinar:write`,`webinar:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`Delete a webinar
Delete a Webinar. **Prerequisites:** * Pro or higher plan with a Webinar Add-on. **Scopes:** `webinar:write:admin`,`webinar:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Perform batch registration
Use this API to register up to 30 registrants at once for a scheduled webinar that requires [registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-webinar-with-registration). **Prerequisites:** * The webinar host must be a Licensed user. * The webinar should be of type `5`, i.e., it should be a scheduled webinar. Other types of webinars are not supported by this API. **Scopes:** `webinar:write`,`webinar:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`Get webinar's session branding
Use this API to get the webinar's [Session Branding](https://support.zoom.us/hc/en-us/articles/4836268732045-Using-Webinar-Session-Branding) information. Session branding lets hosts visually customize a webinar by setting a webinar wallpaper that displays behind video tiles. Session branding also lets hosts set the Virtual Background for and apply name tags to hosts, alternative hosts, panelists, interpreters, and speakers. **Prerequisites:** * A Pro or higher plan with the Webinar add-on. * The **Webinar Session Branding** setting enabled. **Scopes:** `webinar:read`,`webinar:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Create a webinar's branding name tag
Use this API to create a webinar's [Session Branding](https://support.zoom.us/hc/en-us/articles/4836268732045-Using-Webinar-Session-Branding) name tag. There's a limit of 20 name tags per webinar. **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):** `Medium`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`Update a webinar's branding name tag
Use this API to update 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):** `Medium`Upload a webinar's branding Virtual Background
Use this API to upload a webinar's session branding [Virtual Background](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background). Hosts and panelists can select and use these Virtual Backgrounds during the webinar. Branding Virtual Background files have the following restrictions: * A webinar cannot exceed more than 10 Virtual Background files. * You can only upload image files that are in JPG/JPEG, GIF or PNG format. * The Virtual Background file size cannot exceed 15 megabytes (MB). **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):** `Medium`Set webinar's default branding Virtual Background
Use this API to set a webinar's default 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`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`Upload a webinar's branding wallpaper
Use this API to upload a webinar's session branding wallpaper file. Webinar branding wallpaper files have the following requirements: * A webinar can only have one wallpaper file. * You can only upload image files that are in JPG/JPEG, GIF, or PNG format. * Image files must be 16:9 ratio. The recommended image size is 1920 x 1080 pixels (px). * The wallpaper file size cannot exceed 15 megabytes (MB). **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):** `Medium`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`Create webinar's invite links
Use this API to create a batch of invitation links for a webinar. **Prerequisites:** * Business, Education or API Plan with Webinar add-on. **Scopes:** `webinar:write:admin`,`webinar:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Get a webinar's join token for live streaming
Use this API to get a webinar's archive token to allow live streaming. The join token allows a recording bot implemented using Zoom meeting SDK to connect to a Zoom meeting "hosted by the issuer of the token", and can call the streaming method automatically. It supports both regular live streaming, and raw streaming. **Prerequisites:** * A Pro or higher plan with a Webinar Add-on. * The **Allow livestreaming of webinars** user setting enabled in the Zoom web portal. **Scopes:** `webinar_token:read:admin:live_streaming`,`webinar_token:read:live_streaming` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Get a webinar's archive token for local archiving
Use this API to get a webinar's archive token to allow local archiving. The archive token allows a meeting SDK app or bot to get archive permission to access the webinar's raw audio and video media stream in real-time. **Prerequisites:** * A Pro or higher plan with a Webinar Add-on. * The **Archive meetings and webinars** account setting enabled in the Zoom web portal. **Scopes:** `webinar_token:read:admin:local_archiving` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Get a webinar's join token for local recording
Use this API to get a webinar's join token to allow for local recording. The join token lets a recording bot implemented using Zoom Meeting SDK to connect to a Zoom webinar. The recording bot can then automatically start locally recording. This supports both regular and raw local recording types. **Prerequisites:** * A Pro or higher plan with a Webinar Add-on. * The **Local recording** user setting enabled in the Zoom web portal. **Scopes:** `webinar_token:read:admin:local_recording`,`webinar_token:read:local_recording` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Get live stream details
Zoom allows users to [live stream a webinar](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. Use this API to get a webinar's live stream configuration details such as Stream URL, Stream Key and Page URL. **Prerequisites:** * Pro or higher plan with a Webinar Add-on. * Live streaming details must have been [configured](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service#h_01589a6f-a40a-4e18-a448-cb746e52ebc5) for the webinar. **Scopes:** `webinar:read:admin`,`webinar:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Update a live stream
Zoom allows users to [live stream a webinar](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. Use this API to update a webinar's live stream information. **Prerequisites:** * Pro or higher plan with a Webinar Add-on. * Live streaming details must have been [configured](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service#h_01589a6f-a40a-4e18-a448-cb746e52ebc5) for the webinar. **Scopes:** `webinar:write:admin`,`webinar:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Update Live Stream Status
Zoom allows users to [live stream a webinar](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. Use this API to update the status of a webinar's live stream. **Prerequisites:** * Pro or higher plan with a Webinar Add-on. * Live streaming details must have been [configured](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service#h_01589a6f-a40a-4e18-a448-cb746e52ebc5) for the webinar. **Scopes:** `webinar:write:admin`,`webinar:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`List panelists
Panelists in a Webinar can view and send video, screen share, annotate, etc and do much more compared to attendees in a Webinar. Use this API to list all the panelists of a Webinar. **Prerequisites:** * Pro or a higher plan with [Webinar Add-on](https://zoom.us/webinar). **Scopes:** `webinar:read:admin`,`webinar:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`Add panelists
Panelists in a Webinar can view and send video, screen share, annotate, etc and do much more compared to attendees in a webinar. Use 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. **Prerequisites:** * Pro or a higher plan with [Webinar Add-on](https://zoom.us/webinar). **Scopes:** `webinar:write:admin`,`webinar:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`Remove panelists
Remove all the panelists from a Webinar. **Prerequisites:** * Pro or a higher plan with [Webinar Add-on](https://zoom.us/webinar). **Scopes:** `webinar:write:admin`,`webinar:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`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. You can retrieve the `panelistId` by calling **List Panelists API**. **Prerequisites:** * Pro or a higher plan with [Webinar Add-on](https://zoom.us/webinar). **Scopes:** `webinar:write:admin`,`webinar:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`List a webinar's polls
List all the [polls](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) of a Webinar. **Scopes:** `webinar:read:admin`,`webinar:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Create a webinar's poll
Create a [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) for a webinar. **Scopes:** `webinar:write:admin`,`webinar:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Get a webinar poll
Get a webinar's [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) details. **Scopes:** `webinar:read:admin`,`webinar:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Update a webinar poll
Update a webinar's [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars). **Scopes:** `webinar:write:admin`,`webinar:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Delete a webinar poll
Delete a webinar's [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars). **Scopes:** `webinar:write:admin`,`webinar:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`List webinar registrants
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. Use this API to list all the users that have registered for a webinar. **Prerequisites:** * Pro or higher plan with a Webinar Add-on. **Scopes:** `webinar:read:admin`,`webinar:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`Add a webinar registrant
Use this API to create and submit a user's registration for a webinar. Zoom users with a [Webinar plan](https://zoom.us/webinar) have access to creating and managing webinars. Webinars allow hosts 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. **Prerequisites:** * A Pro or higher plan with the Webinar add-on. **Scopes:** `webinar:write:admin`,`webinar:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`List registration questions
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 with fields and questions before they can receive the link to join the Webinar. Use this API to list registration questions and fields that are to be answered by users while registering for a Webinar. **Prerequisites:** * Pro or higher plan with a Webinar Add-on. **Scopes:** `webinar:read:admin`,`webinar:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Update registration questions
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 with fields and questions before they can receive the link to join the Webinar. Use this API to update registration questions and fields of a scheduled Webinar that are to be answered by users while registering for a Webinar. **Prerequisites:** * Pro or higher plan with a Webinar Add-on. * Registration option for Webinar should be set as required to use this API. **Scopes:** `webinar:write:admin`,`webinar:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Update registrant's status
Use this API to update webinar registrants' registration status. You can approve or deny a registrant, or revoke a registrant's approval. **Scopes:** `webinar:write:admin`,`webinar:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`Get a webinar registrant
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. Use this API to get details on a specific user who has registered for the Webinar. **Prerequisites:** * The account must have a Webinar plan. **Scopes:** `webinar:read:admin`,`webinar:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Delete a webinar registrant
Delete a webinar registrant. **Scopes:** `webinar:write:admin`,`webinar:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Update webinar status
Update a webinar's status. Use this API to end an ongoing webinar. **Prerequisites:** * The account must hold a valid [Webinar plan](https://zoom.us/webinar). **Scopes:** `webinar:write:admin`,`webinar:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Get a webinar survey
Return information about 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:read:admin`,`webinar:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`Update a webinar survey
Update a [webinar survey](https://support.zoom.us/hc/en-us/articles/360048745651). **Prerequisites:** * A Pro or higher plan with the Webinar add-on. * Enable the [**Webinar Survey**](https://support.zoom.us/hc/en-us/articles/360061293191-Enabling-webinar-survey) feature in the host's account. **Scopes:** `webinar:write`,`webinar:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`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` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Get webinar's token
Use this API to get a webinar's [closed caption token (caption URL)](https://support.zoom.us/hc/en-us/articles/115002212983-Using-a-third-party-closed-captioning-service). This token lets you use a third-party service to stream text to their closed captioning software to the Zoom webinar. **Prerequisites:** * A Pro or higher plan with the Webinar add-on. * The **Closed captioning** setting enabled in the Zoom web portal. * * The **Allow use of caption API Token to integrate with 3rd-party Closed Captioning services** setting enabled. **Scopes:** `webinar:read`,`webinar:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`Get webinar tracking sources
[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. Use this API to list information on all the tracking sources of a Webinar. **Prerequisites**: * [Webinar license](https://zoom.us/webinar). * Registration must be required for the Webinar. **Scopes:** `webinar:read:admin`,`webinar:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`Generic HTTP Request
Every SaaS integration in Superblocks comes with a built in Generic HTTP Request Action. This is a powerful action you can use to call Zoom API endpoints not in the Superblocks supported actions.
To use this action simply add the method, path, required query parameters, and body for the desired endpoint.
info
Learn more about REST requests in Superblocks in our Building REST requests guide.
Generic HTTP Requests use the authentication set up and base URL you've configured for your integration, making it an easy for your team to extend Superblocks Integrations to meet their needs.