Zoom integration: operations for AI agents
Zoom connects to Type.com as an integration. This page lists the 2027 operations documented for Claude and Codex in Type.com: 949 read, 627 write, 451 destructive.
About Zoom
Zoom is a video conferencing and online meeting platform featuring breakout rooms, screen sharing, and integrations with various enterprise tools
Categories: Communication & Meetings
How to connect Zoom to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
2027 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
2027 operations listed.
Accounts
- Read
Get locked settings
Retrieves 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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:read:lock_settings:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /accounts/{accountId}/lock_settings - Read
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:read:managed_domains:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /accounts/{accountId}/managed_domains - Read
Get account settings
Returns 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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:read:settings:admin`,`account:read:settings:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /accounts/{accountId}/settings - Read
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:read:registration_settings:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /accounts/{accountId}/settings/registration - Read
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:read:trusted_domains:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /accounts/{accountId}/trusted_domains - Read
List storage locations
List all available storage locations for this account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_account:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:account_storage_location:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/storage/locations - Read
Get indicators settings [Deprecated] (deprecated)
Get the account's indicators settings. **Prerequisites:** * The account must be a paid account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:read:admin`,`account:write:admin`,`iq_account:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:indicator`,`zra:read:indicator:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /iq/settings/indicators - Read
Get indicators settings
Get the account's indicators settings. **Prerequisites:** * The account must be a paid account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:read:admin`,`account:write:admin`,`iq_account:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:indicator`,`zra:read:indicator:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /zra/settings/indicators - Read
List an account's Zoom Phone settings
Returns an account's Zoom Phone settings. **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_account_settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/account_settings - Read
List an account's customized outbound caller ID phone numbers
Retrieves phone numbers that can be used as the `account-level` customized outbound caller ID. Note that when multiple sites policy is enabled, users cannot manage the `account-level` configuration. The system will throw an exception. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_customized_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
GET /phone/outbound_caller_id/customized_numbers - Write
Update meeting Waiting Room branding
Sets the meeting Waiting Room branding (logo, background image, video, welcome title/description, and layout) for the account. 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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:write:waiting_room_branding:admin`,`account:write:waiting_room_branding:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /accounts/{accountId}/settings/meeting_waiting_room_branding - Write
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:update:registration_settings:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /accounts/{accountId}/settings/registration - Write
Upload virtual background files
[Uploads 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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:write:virtual_background_files:master`,`account:write:virtual_background_files:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /accounts/{accountId}/settings/virtual_backgrounds - Write
Update webinar Waiting Room branding
Sets webinar Waiting Room branding (logo, background image, video, welcome title/description, and layout) for the account. 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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:write:waiting_room_branding:master`,`account:write:waiting_room_branding:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /accounts/{accountId}/settings/webinar_waiting_room_branding - Write
Add phone numbers for an account's customized outbound caller ID
Adds the `account-level` customized outbound caller ID phone numbers. Note that when multiple sites policy is enabled, users cannot manage the `account-level` configuration. The system will throw an exception. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:customized_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
POST /phone/outbound_caller_id/customized_numbers - Destructive
Update locked settings
Updates 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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:update:lock_settings:master`,`account:update:lock_settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /accounts/{accountId}/lock_settings - Destructive
Update the account owner
Changes 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://developers.zoom.us/docs/api/rest/master-account-apis/) privileges **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:update:owner:master`,`account:update:owner:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
PUT /accounts/{accountId}/owner - Destructive
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:update:settings:admin`,`account:update:settings:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /accounts/{accountId}/settings - Destructive
Delete virtual background files
Deletes 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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:delete:virtual_background_files:master`,`account:delete:virtual_background_files:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /accounts/{accountId}/settings/virtual_backgrounds - Destructive
Delete phone numbers for an account's customized outbound caller ID
Deletes the `account-level` customized outbound caller ID phone numbers. Note that when multiple sites policy is enabled, users cannot manage the `account-level` configuration. The system will throw an exception. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:customized_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/outbound_caller_id/customized_numbers
Dashboards
- Read
Get AI adoption
Get the AI adoption summary. **Prerequisites** * Business or a higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:admin`,`dashboard_aic:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:ai_adoption:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /metrics/ai/adoption - Read
Get AI KPIs
Get AI key performance indicators. **Prerequisites** * Business or a higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:admin`,`dashboard_aic:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:ai_kpi:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /metrics/ai/kpis - Read
Get AI usage details
Get AI usage and engagement details. **Prerequisites** * Business or a higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:admin`,`dashboard_aic:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:ai_usage_details:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /metrics/ai/usage/details - Read
Get AI usage trend
Get the AI usage and engagement trend. **Prerequisites** * Business or a higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:admin`,`dashboard_aic:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:ai_usage_trend:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /metrics/ai/usage/trend - Read
Get AIC ROI KPIs
Get AIC ROI KPI data. Specify a monthly date range for the dashboard data using the `from` and `to` query parameters. The month should fall within the last six months. **Prerequisites** * Business or a higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:admin`,`dashboard_aic:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:aic_roi_kpi:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /metrics/aic/roi/kpis - Read
Get AIC ROI meeting summary usage
Get AIC ROI meeting summary usage data. Specify a monthly date range for the dashboard data using the `from` and `to` query parameters. The month should fall within the last six months. **Prerequisites** * A Business plan or higher. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:admin`,`dashboard_aic:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:aic_roi_meeting_summary_usage:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /metrics/aic/roi/meeting_summary_usage - Read
Get chat metrics
Get [metrics](https://support.zoom.us/hc/en-us/articles/204654719-Dashboard#h_cc7e9749-1c70-4afb-a9a2-9680654821e4) for how users are utilizing Zoom Chat to send messages. Use the `from` and `to` query parameters to specify a monthly date range for the dashboard data. The monthly date range must be within the last six months. > **Note:** To query chat metrics from July 1, 2021 and later, use this endpoint instead of the [**Get IM metrics**](/docs/api-reference/zoom-api/methods#operation/dashboardIM) API. **Prerequisites:** * Business or a higher plan **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_im:read:admin`,`dashboard:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:chat:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Resource-intensive`
GET /metrics/chat - Read
List Zoom meetings client feedback
Use this API to return [Zoom meetings client feedback](https://support.zoom.us/hc/en-us/articles/115005855266-End-of-Meeting-Feedback-Survey#h_e30d552b-6d8e-4e0a-a588-9ca8180c4dbf) survey results. You can specify a monthly date range for the Dashboard data using the `from` and `to` query parameters. The month should fall within the last six months. **Prerequisites:** * A Business or higher account. * The "[**Feedback to Zoom**](https://support.zoom.us/hc/en-us/articles/115005838023)" option enabled. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_home:read:admin`,`dashboard:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:list_meetings_feedback:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
GET /metrics/client/feedback - Read
Get zoom meetings client feedback
Retrieve detailed information on a [Zoom meetings client feedback](https://support.zoom.us/hc/en-us/articles/115005855266-End-of-Meeting-Feedback-Survey#h_e30d552b-6d8e-4e0a-a588-9ca8180c4dbf). You can specify a monthly date range for the dashboard data using the `from` and `to` query parameters. The month should fall within the last six months. **Prerequisites:** * Business or higher account * [Feedback to Zoom](https://support.zoom.us/hc/en-us/articles/115005838023) enabled. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_home:read:admin`,`dashboard:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:meeting_feedback:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
GET /metrics/client/feedback/{feedbackId} - Read
List client meeting satisfaction
If the [End of Meeting Feedback Survey](https://support.zoom.us/hc/en-us/articles/115005855266) option is enabled, attendees will be prompted with a survey window where they can tap either the **Thumbs Up** or **Thumbs Down** button that indicates their Zoom meeting experience. With this API, you can get information on the attendees' meeting satisfaction. Specify a monthly date range for the query using the from and to query parameters. The month should fall within the last six months. To get information on the survey results with negative experiences (indicated by **Thumbs Down**), use the [**Get Zoom meetings client feedback**](/docs/api-reference/zoom-api/methods#operation/dashboardClientFeedbackDetail) API. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_home:read:admin`,`dashboard:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:meeting_survey:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
GET /metrics/client/satisfaction - Read
List the client versions
Use this API to list all the client versions and its count. **Prerequisites:** * A Business or a higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_home:read:admin`,`dashboard:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:client_versions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
GET /metrics/client_versions - Read
Get CRC port usage
A Cloud Room Connector allows H.323/SIP endpoints to connect to a Zoom meeting. Use this API to get the hour by hour CRC Port usage for a specified period of time. <aside class='notice'>We will provide the report for a maximum of one month. For example, if "from" is set to "2017-08-05" and "to" is set to "2017-10-10", we will adjust "from" to "2017-09-10".</aside> **Prerequisites:** * Business, Education or API Plan. * Room Connector must be enabled on the account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_crc:read:admin`,`dashboard:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:crc_port_usage:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
GET /metrics/crc - Read
Get top 25 Zoom Rooms with issues
Get information on top 25 Zoom Rooms with issues in a month. The month specified with the "from" and "to" range should fall within the last six months. **Prerequisites:** * Business or a higher plan. * Zoom Room must be enabled in the account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_home:read:admin`,`dashboard:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:list_zoomrooms:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
GET /metrics/issues/zoomrooms - Read
Get issues of Zoom Rooms
Use this API to return information about the Zoom Rooms in an account with issues, such as disconnected hardware or bandwidth issues. You can specify a monthly date range for the Dashboard data using the `from` and `to` query parameters. The month should fall within the last six months. **Prerequisites:** * A Business or a higher plan. * A Zoom Room must be enabled in the account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_home:read:admin`,`dashboard:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:issues_zoomroom:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
GET /metrics/issues/zoomrooms/{zoomroomId} - Read
List meetings
Lists the total live or past meetings that occurred during a specified period of time. This overview shows if features such as audio, video, screen sharing, and recording were being used in the meeting. You can also see the license types of each user on your account. Specify a monthly date range for the dashboard data using the `from` and `to` query parameters. The month should fall within the last six months. **Prerequisites** * Business or a higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_meetings:read:admin`,`dashboard:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:list_meetings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `RESOURCE-INTENSIVE`
GET /metrics/meetings - Read
Get meeting details
Get details on live or past meetings. This overview shows if features such as audio, video, screen sharing, and recording were being used in the meeting. You can also see the license types of each user on your account. Specify a monthly date range for the dashboard data using the `from` and `to` query parameters. The month should fall within the last six months. **Prerequisites** * Business or a higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_meetings:read:admin`,`dashboard:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:meeting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /metrics/meetings/{meetingId} - Read
List meeting participants
Return a list of participants from live or past meetings. If you don't provide the `type` query parameter, the default value is set to the `live` value. This API only returns metrics for participants in a live meeting, if any exist. You can specify a monthly date range for the dashboard data using the `from` and `to` query parameters. The month should fall within the last six months. **Note:** This API may return empty values for participants' `user_name`, `ip_address`, `location`, and `email` responses when the account calling this API: * Is a [**legacy** HIPAA BAA account](https://developers.zoom.us/docs/api/references/legacy-business-associate-agreements/). * Displays data for any users who are **not** part of the host's account (external users) unless they meet certain conditions. See [Email address display rules](https://developers.zoom.us/docs/api/using-zoom-apis/#email-address-display-rules) for details. **Prerequisites:** * A Business or higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_meetings:read:admin`,`dashboard:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:list_meeting_participants:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /metrics/meetings/{meetingId}/participants - Read
List meeting participants QoS
Show a list of meeting participants from live or past meetings, and their quality of service received during the meeting. The data returned indicates the connection quality for sending or receiving video, audio, and shared content. **Note:** This API may return empty values for participants' `user_name`, `ip_address`, `location`, and `email` responses when the account calling this API. * Does **not** have a signed HIPAA business associate agreement (BAA). * Is a [**legacy** HIPAA BAA account](https://developers.zoom.us/docs/api/rest/other-references/legacy-business-associate-agreements/). * Displays data for any users who are **not** part of the host's account (external users) unless they meet certain conditions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details. **Prerequisites:** * A Business or a higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_meetings:read:admin`,`dashboard:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:list_meeting_participants_qos:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /metrics/meetings/{meetingId}/participants/qos - Read
Get post meeting feedback
When a meeting ends, each attendee will be prompted to share their meeting experience by clicking either thumbs up or thumbs down. Use this API to retrieve the feedback submitted for a specific meeting. 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. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_meetings:read:admin`,`dashboard:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:post_meeting_feedback:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
GET /metrics/meetings/{meetingId}/participants/satisfaction - Read
Get meeting participant QoS
Return the quality of service (QoS) report for participants from live or past meetings. The data returned indicates the connection quality for sending/receiving video, audio, and shared content. The API returns this data for either the API request or when the API request was last received. When the sender sends data, a timestamp is attached to the sender's data packet. The receiver then returns this timestamp to the sender. This helps determine the upstream and downstream latency, which includes the application processing time. The latency data returned is the five second average and five second maximum. This API will **not** return data if there is no data being sent or received at the time of request. **Note:** This API may return empty values for participants' `user_name`, `ip_address`, `location`, and `email` responses when the account calling this API: * Does **not** have a signed HIPAA business associate agreement (BAA). * Is a [**legacy** HIPAA BAA account](https://developers.zoom.us/docs/api/rest/other-references/legacy-business-associate-agreements/). * Displays data for any users who are **not** part of the host's account (external users) unless they meet certain conditions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_meetings:read:admin`,`dashboard:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:meeting_participant_qos:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /metrics/meetings/{meetingId}/participants/{participantId}/qos - Read
Get meeting quality scores
Use this API to return [meeting quality score](https://support.zoom.us/hc/en-us/articles/360061244651-Meeting-quality-scores-and-network-alerts-on-Dashboard) information. Meeting quality scores are based on the mean opinion score (MOS). The MOS measures a meeting's quality on a scale of "Good" (5-4), "Fair" (4-3), "Poor" (3-2), or "Bad" (2-1). **Prerequisites:** * A Business or a higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_home:read:admin`,`dashboard:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:meeting_quality_score:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
GET /metrics/quality - Read
List webinars
Lists all the live or past webinars from a specified period of time. **Prerequisites** * Business, Education or API Plan with Webinar add-on. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_webinars:read:admin`,`dashboard:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:list_webinars:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `RESOURCE-INTENSIVE`
GET /metrics/webinars - Read
Get webinar details
Retrieve details from live or past webinars. **Prerequisites:** * Business, Education or API Plan with Webinar add-on. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_webinars:read:admin`,`dashboard:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:webinar:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /metrics/webinars/{webinarId} - Read
Get webinar participants
Get information about participants from live or past webinars. **Note:** This API endpoint displays only information for external users (users **not** part of the host's account) that meet the criteria of the [email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules), and returns empty values for participants who do not meet the criteria. **Prerequisites:** * A Business, Education, or API Plan with Webinar add-on. * Any [**legacy** HIPAA BAA account](/docs/api-reference/other-references/legacy-business-associate-agreements). * No signed HIPAA business associate agreement (BAA). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_webinars:read:admin`,`dashboard:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:list_webinar_participants:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /metrics/webinars/{webinarId}/participants - Read
List webinar participant QoS
Show a list of webinar participants from live or past webinars and the quality of service they received during the webinar. The data returned indicates the connection quality for sending/receiving video, audio, and shared content. **Note:** This API may return empty values for participants' `user_name`, `ip_address`, `location`, and `email` responses when the account calling this API: * Does **not** have a signed HIPAA business associate agreement (BAA). * Is a [**legacy** HIPAA BAA account](https://developers.zoom.us/docs/api/rest/other-references/legacy-business-associate-agreements/). * Displays data for any users who are **not** part of the host's account, such as external users, unless they meet certain conditions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details. **Prerequisites:** * A Business, Education, or API Plan with Webinar add-on. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_webinars:read:admin`,`dashboard:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:list_webinar_participants_qos:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /metrics/webinars/{webinarId}/participants/qos - Read
Get post webinar feedback
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. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_webinars:read:admin`,`dashboard:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:post_webinar_feedback:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
GET /metrics/webinars/{webinarId}/participants/satisfaction - Read
Get webinar participant QoS
Returns the quality of service (QoS) for participants during live or past webinars. This data returned indicates the connection quality for sending/receiving video, audio, and shared content. The API returns this data for either the API request or when the API request was last received. When the sender sends its data, a timestamp is attached to the sender's data packet. The receiver then returns this timestamp to the sender. This helps determine the upstream and downstream latency, which includes the application processing time. The latency data returned is the five second average and five second maximum. This API will **not** return data if there is no data being sent or received at the time of request. **Note:** This API may return empty values for participants' `user_name`, `ip_address`, `location`, and `email` responses when the account calling this API: * Does **not** have a signed HIPAA business associate agreement (BAA). * Is a [**legacy** HIPAA BAA account](https://developers.zoom.us/docs/api/rest/other-references/legacy-business-associate-agreements/). * Displays data for any users who are **not** part of the host's account, such as external users, unless they meet certain conditions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details. **Prerequisites:** * A Business, Education, or API Plan with Zoom Rooms set up. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_webinars:read:admin`,`dashboard:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:webinar_participant_qos:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /metrics/webinars/{webinarId}/participants/{participantId}/qos - Read
List Zoom Rooms
List information on all Zoom Rooms in an account. **Prerequisites:** * Business, Education or API Plan with Zoom Rooms set up. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_zr:read:admin`,`dashboard:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:list_zoomrooms:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Resource-intensive`
GET /metrics/zoomrooms - Read
Get top 25 issues of Zoom Rooms
Get top 25 issues of Zoom Rooms. **Prerequisites:** * Business, Education or API Plan with Zoom Rooms set up. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_zr:read:admin`,`dashboard:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:issues_zoomroom:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
GET /metrics/zoomrooms/issues - Read
Get Zoom Rooms details
The Zoom Rooms dashboard metrics lets you know the type of configuration a Zoom room has and details on the meetings held in that room. Use this API to retrieve information on a specific room. **Prerequisites:** * Business, Education or API Plan with Zoom Rooms set up. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_zr:read:admin`,`dashboard:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:zoomroom:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /metrics/zoomrooms/{zoomroomId} - Read
List meeting participants QoS Summary
Returns a list of meeting participants from past meetings and the summary of their quality of service received during the meeting. The data returned indicates the connection quality for sending or receiving video, audio, and shared content. **Note:** This API may return empty values for participants' `user_name` and `email` responses when the account calling this API: * Is a [**legacy** HIPAA BAA account](https://developers.zoom.us/docs/api/references/legacy-business-associate-agreements/). * Displays data for any users who are **not** part of the host's account (external users) unless they meet certain conditions. See [Email address display rules](https://developers.zoom.us/docs/api/using-zoom-apis/#email-address-display-rules) for details. **Prerequisites:** * A Business or a higher plan. * Developers must subscribe to the QSS summary event to receive data from this API. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_meetings:read:admin`,`dashboard:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:list_meeting_participants_qos:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /metrics/meetings/{meetingId}/participants/qos_summary - Read
List webinar participants QoS Summary
Use this API to return a list of webinar participants from live or past webinars and the quality of service they received during the webinar. The data returned indicates the connection quality for sending/receiving video, audio, and shared content. **Note:** This API may return empty values for participants' `user_name` and `email` responses when the account calling this API: * Does **not** have a signed HIPAA business associate agreement (BAA). * Is a [**legacy** HIPAA BAA account](https://marketplace.zoom.us/docs/api-reference/other-references/legacy-business-associate-agreements). * Displays data for any users who are **not** part of the host's account (external users) unless they meet certain conditions. See [Email address display rules](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#email-address) for details. **Prerequisites:** * A Business, Education, or API Plan with Webinar add-on. * Developers must subscribe to the QSS summary event to receive data from this API. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_webinars:read:admin`,`dashboard:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:list_webinar_participants_qos:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /metrics/webinars/{webinarId}/participants/qos_summary
Data Requests
- Read
Get download link for data access request file
Returns download link for given `fileId`. The download link expires after 5 minutes, and can only be used once. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `data_request:read:admin`,`data_request:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `data_request:read:download:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /data_requests/files/{fileId}/url - Read
List data request history
Lists all data requests for account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `data_request:read:admin`,`data_request:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `data_request:read:history:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /data_requests/requests - Read
List downloadable files for export data request
Fetches downloadable file information from an individual data request **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `data_request:read:admin`,`data_request:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `data_request:read:download:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /data_requests/requests/{requestId} - Destructive
Create data (export/deletion) request
Submit a request to: * Export data for a specified time period. * **Delete all data** associated with a user's email. **Note**: You can revoke deletion requests up to 30 minutes after submission. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `data_request:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `data_request:write:request:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /data_requests/requests - Destructive
Cancel data deletion request
Cancel a pending data request with ID `requestId`. Only Data Deletion requests can be canceled. The window to cancel Data Deletion requests expires after 30 minutes. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `data_request:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `data_request:delete:request:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /data_requests/requests/{requestId}
Information Barriers
- Read
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `information_barriers:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `information_barrier:read:list_policies:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /information_barriers/policies - Read
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `information_barriers:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `information_barrier:read:policy:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /information_barriers/policies/{policyId} - Write
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `information_barriers:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `information_barrier:write:policy:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /information_barriers/policies - Write
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `information_barriers:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `information_barrier:update:policy:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /information_barriers/policies/{policyId} - Destructive
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `information_barriers:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `information_barrier:delete:policy:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /information_barriers/policies/{policyId}
Roles
- Read
List roles
List [roles](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) on your account **Prerequisites** : * Pro or higher plan. * For setting the initial role, you must be the Account Owner. * For subsequent role management, you must be the Account Owner or user with role management permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:read:admin`,`role:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:read:list_roles`,`role:read:list_roles:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
GET /roles - Read
Get role information
Each Zoom user automatically has a role which can either be owner, administrator, or member. Account owners and users with edit privileges for role management can add customized roles with a list of privileges. Use this API to get information including specific privileges assigned to a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control). **Pre-requisites** * A Pro or higher plan. * For role management and updates, you must be either the account owner or a user with role management permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:read:admin`,`role:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:read:role`,`role:read:role:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /roles/{roleId} - Read
List members in a role
User [roles](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to list all the members that are assigned a specific role. **Prerequisites:** * A Pro or a higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:read:admin`,`role:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:read:list_members`,`role:read:list_members:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /roles/{roleId}/members - Read
List roles
Return a list of roles. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_role:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_roles:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/roles - Read
Get a role
Get information about a role. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_role:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:role:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/roles/{roleId} - Read
List users of a role
Retrieve a list of users assigned to a Contact Center role. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_role:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_role_users:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/roles/{roleId}/users - Write
Create a role
Each Zoom user automatically has a role which can either be owner, administrator, or member. **Pre-requisites** * Pro or higher plan. * To set the initial role, you must be the account owner. * For subsequent role management, you must be either the account owner or user with role management permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:write:role`,`role:write:role:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /roles - Write
Assign a role
User [roles](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to [assign a role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control#h_748b6fd8-5057-4cf4-bbfd-787909c09db0) to members. **Prerequisites:** * A Pro or a higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:write:member`,`role:write:member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
POST /roles/{roleId}/members - Write
Create a role
Create a new [role](https://support.zoom.us/hc/en-us/articles/4471054202253-Using-role-management). Admins can use the role management feature to control access to features and settings in the Zoom web portal. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_role:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:role:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/roles - Write
Duplicate a role
Duplicate the role specified by the original role name and assign it a new name. All settings, permissions, and configurations of the original role will be copied to the new role. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_role:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:role:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/roles/duplicate - Write
Update a role
Update a role. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_role:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:role:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/roles/{roleId} - Write
Assign a role
Assign users to a role. Roles have unique privileges that assigned users have access to. Examples include an Administrator or Agent role. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_role:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:role_user:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /contact_center/roles/{roleId}/users - Destructive
Delete a role
Each Zoom user automatically has a role which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list. Use this API to delete a role. **Pre-requisite:** * A Pro or higher plan. * For role management and updates, you must be the Account Owner or user with role management permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:delete:role`,`role:delete:role:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /roles/{roleId} - Destructive
Update role information
Each Zoom user automatically has a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list. Use this API to change the privileges, name and description of a specific role. **Pre-requisite:** * A Pro or higher plan. * For role management and updates, you must be the Account Owner or user with role management permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:update:role`,`role:update:role:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
PATCH /roles/{roleId} - Destructive
Unassign a role
User [roles](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to unassign a user's role. **Prerequisites:** * A Pro or a higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:delete:member`,`role:delete:member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /roles/{roleId}/members/{memberId} - Destructive
Delete a role
Delete a role. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_role:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:role:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/roles/{roleId} - Destructive
Delete role privileges
Removes the specified privileges from a role when given a valid role ID and privilege list. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_role:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:role:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/roles/{roleId}/privileges - Destructive
Unassign a user from a role
Remove a specific user from a Contact Center role. This operation removes the role-user assignment, meaning the user will no longer have the permissions and privileges associated with this role. The user must currently be assigned to the specified role. Both the role and user must exist in the account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_role:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:role_user:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/roles/{roleId}/users/{userId}
Single Sign-On
- Read
Get account SSO capabilities
Return the account's SSO capabilities so clients can shape requests. Accessible even while SSO is disabled. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:read:capabilities:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /sso/capabilities - Read
List SSO configurations
List the account's full filtered SSO configuration set. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:read:config:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /sso/configurations - Read
Get an SSO configuration
Retrieve a single SSO configuration by ID. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:read:config:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /sso/configurations/{config_id} - Read
List SP certificates
List the account's SP certificates (CA and self-signed). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:read:certificate:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /sso/configurations/{config_id}/certificates - Read
Get SSO mappings
Retrieve the SAML or OIDC attribute mapping configuration of a single SSO configuration. A mapping is returned only when it carries a non-default configuration: it is enabled, or it still holds an attribute name or a switch set to a non-default value. An absent mapping means it is not configured. `default_license` is always returned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:read:mapping:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /sso/configurations/{config_id}/mapping - Read
List SSO login logs
Returns SSO sign-in log summaries for the requesting account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:read:list_login_logs:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /sso/login_logs - Read
Get SSO login log detail
Returns the full detail of the SSO sign-in log recorded under a specific tracking ID, including the decoded SAML response or the OIDC login documents. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:read:login_log:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /sso/login_logs/{tracking_id} - Read
Get account SSO settings
Return account-level SSO settings (user_provisioning). Accessible even when SSO is disabled. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:read:settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /sso/settings - Read
Get account SSO status
Return whether account SSO is enabled. Accessible even when SSO is disabled. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:read:status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /sso/status - Write
Create an SSO configuration
Create a SAML, InCommon, or OIDC SSO configuration. The `saml`, `incommon`, and `oidc` fields are mutually exclusive. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:write:config:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /sso/configurations - Write
Update an SSO configuration
Partially update an SSO configuration. saml, incommon and oidc are mutually exclusive. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:update:config:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /sso/configurations/{config_id} - Write
Create an SP certificate
Create a self-signed SP certificate. Not supported for OIDC configurations. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:write:certificate:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /sso/configurations/{config_id}/certificates - Write
Update an SP certificate
Update the self-signed SP certificate name. The new name must differ from the current one. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:update:certificate:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /sso/configurations/{config_id}/certificates/{certificate_id} - Write
Update account SSO settings
Update account-level SSO settings (user_provisioning). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:update:settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /sso/settings - Destructive
Delete an SSO configuration
Delete a single SSO configuration (multiple-configuration accounts only). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:delete:config:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /sso/configurations/{config_id} - Destructive
Delete an SP certificate
Delete a self-signed SP certificate. CA certificates are system-managed and cannot be deleted. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:delete:certificate:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /sso/configurations/{config_id}/certificates/{certificate_id} - Destructive
Update SSO mapping
Partially update the SAML or OIDC attribute mapping configuration of a single SSO configuration. Send only the properties to change; any property omitted from the body is left unchanged. The request is validated in full before anything is written: if any part of the body is rejected, no change is persisted. On success, the complete updated document is returned, so no follow-up request is required. The response carries only the mappings that hold a non-default configuration, so a mapping just disabled and cleared is absent from it; because omitted properties are left unchanged, any subset of a previous response can be sent back safely. Read-only properties (`config_id`) must not be sent. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:update:mapping:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /sso/configurations/{config_id}/mapping - Destructive
Update an SSO configuration status
Enable or disable a single SSO configuration (multiple-configuration accounts only). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:update:config_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /sso/configurations/{config_id}/status - Destructive
Enable or disable account SSO
Update the account-level SSO status. Use `sso_enabled=true` to enable or `false` to disable. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sso:update:status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /sso/status
Survey Management
- Read
Get surveys
Queries all surveys in the current account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `survey:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `survey_management:read:list_surveys:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /surveys - Read
List channel survey instances
Query the channel survey instances based on `channelId`. The same survey can be used multiple times, each use constituting a separate instance. This API endpoint returns the historical information of each survey instance for each channel. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `survey:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `survey_management:read:list_survey_instances:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /surveys/channels/{channelId}/instances - Read
Get survey info
Queries the latest version of survey information from `surveyId`. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `survey:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `survey_management:read:survey:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /surveys/{surveyId} - Read
Get survey answers
Queries the answers of survey from `surveyId`. You can use the same survey cmultiple times in different products(Meeting/Webinar/Team Chat/Contact Center). We call it an instance each time we use it. This API returns the historical answers of each survey instance. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `survey:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `survey_management:read:list_survey_answers:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /surveys/{surveyId}/answers - Read
Get survey instances
Query the instances which used the survey, based on `surveyId`. The same survey can be used multiple times in different products(meeting/webinar/team chat/contact center). Each time it is used, we call it an instance. This API is used to return the historical information of each survey instance. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `survey:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `survey_management:read:list_survey_instances:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /surveys/{surveyId}/instances
Archived
- Read
Get AI Companion conversation archives
Retrieve the AI Companion conversation archives. Note: The AI Companion brand has been retired. AI-powered features are now more deeply integrated throughout Zoom Workplace. Existing APIs and SDKs that reference AI Companion will continue to function as before to ensure backward compatibility. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aic_archive:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aic:read:conversation_archives:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /aic/users/{userId}/conversation_archive
Asset
- Read
List Vocabularies
List the custom vocabularies created for the account. **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /aiservices/assets/vocabularies - Read
Get Vocabulary
Retrieves a specific custom vocabulary by ID for the account, including its language and complete list of phrases. This API cannot be used to retrieve ZAS-provided vocabulary. **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /aiservices/assets/vocabularies/{vocabularyId} - Write
Create Custom Vocabulary
Create a custom vocabulary. **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /aiservices/assets/vocabularies - Destructive
Delete Vocabulary
Delete a specified custom vocabulary. **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /aiservices/assets/vocabularies/{vocabularyId}
Decisions
- Write
Evaluate decision questions
Evaluates typed questions independently against the same input and returns one ordered answer per question. Dependent questions require separate requests. Authenticate with a Decisions-enabled API key in the `x-api-key` request header. A Zoom AI Services or Universal SDK entitlement is required. ZOAP authenticates requests, and backend services enforce authorization. Requests exceeding supported limits are rejected before inference. Account-level rate limits and workload quotas apply. Invalid model output is not returned as a valid decision result. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aiservices:write:decide:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
POST /aiservices/decisions/decide
Scribe
- Read
List Batch Jobs
Retrieves a paginated list of batch transcription jobs for the authenticated tenant. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aiservices:read:list_scribe_batch_jobs:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /aiservices/scribe/jobs - Read
Get Batch Job Status
Retrieves job-level summary for a batch transcription job. Returns overall job state and progress statistics. Use `GET /ai/scribe/jobs/{jobId}/files` to retrieve per-file status with pagination. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aiservices:read:scribe_batch_job:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /aiservices/scribe/jobs/{jobId} - Read
List Batch Job Files
Retrieves per-file processing status for a batch transcription job. Use `page_size` and `next_page_token` for pagination. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aiservices:read:list_scribe_batch_job_files:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /aiservices/scribe/jobs/{jobId}/files - Read
Get Batch Scribe Job File
Retrieves the processing result for a specific file within a batch Scribe transcription job. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aiservices:read:scribe_batch_job_file:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /aiservices/scribe/jobs/{jobId}/files/{fileId} - Read
Live Scribe WebSocket
The Live API converts speech to text in real time over a WebSocket connection. Your application streams audio to the service and receives transcription events as people speak, so you can show captions or transcripts without waiting for the recording to finish. **Key features** - **Real-time results:** Partial results appear while a speaker is still talking, and final results follow when each utterance ends. - **Timing and turn tracking:** Every event includes start and end times and an identifier for its utterance, so you can align partial and final results. - **Session configuration:** Set the language, voice activity detection, transcription options, and custom vocabulary when you start a session. - **Custom vocabulary:** Provide names, product terms, or other domain words to improve recognition accuracy. You can pass them inline for one session or reference a saved vocabulary by its ID. Use one or the other, not both. - **Optional text polishing:** Remove filler words, false starts, and mid-sentence cuts from the transcript. The original transcript is still available if you need it. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aiservices:write:live_transcribe:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /aiservices/scribe/live - Write
Submit Batch Scribe Job
Submits a batch transcription job for asynchronous processing. Supports three input modes: single file (mode inferred when uri points to single file), prefix/container enumeration (with optional filters), or explicit manifest (list of URIs). Maximum of 1000 files per manifest. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aiservices:write:scribe_batch_job:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /aiservices/scribe/jobs - Write
Scribe (Synchronous)
Uploads a single audio file and receive transcript inline. Synchronous operation response returns immediately after the transcription completes. Maximum file size: 100MB. Maximum duration: 2 hours. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aiservices:write:transcribe:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /aiservices/scribe/transcribe - Destructive
Cancel Batch Job
Cancels a batch transcription job. Only jobs in QUEUED or PROCESSING state can be canceled. Successfully canceled jobs transition to CANCELED state. Jobs that are already COMPLETED, FAILED, or CANCELED cannot be canceled. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aiservices:delete:scribe_batch_job:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /aiservices/scribe/jobs/{jobId}
Speech Summarization
- Write
Summarize (Synchronous)
Provides speech-to-text transcription and AI-powered summarization in a single streaming request using Server-Sent Events (SSE). **Flow:** 1. transcribe_started - Transcription begins. 2. transcribe_complete - Full transcript available. 3. summary_delta - Streaming summary output (multiple events). 4. done - Processing complete. 5. error - If any failure occurs. **Supported Formats:** WAV, MP3, M4A, FLAC, OGG, WebM, MP4, MOV **Max File Size:** 50 MB **Max Duration:** 2 hours **Response Events:** *transcribe_started:* ``` event: transcribe_started data: {"status":"transcribing"} ``` *transcribe_complete:* ``` event: transcribe_complete data: { "transcript": {...}, "latency_ms": 5234, "body_bytes": 12456, "status_code": 200 } ``` *summary_delta (multiple):* ``` event: summary_delta data: { "summary": "## Meeting Summary Content...", "metadata": {} } ``` Note: Each event contains the complete accumulated text. *done:* ``` event: done data: { "status": "complete", "total_latency_ms": 8500, "transcribe_ms": 5234, "summary_ms": 3266 } ``` *error:* ``` event: error data: { "error": "error message", "stage": "transcribe|summary|summary_preparation" } ``` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aiservices:write:transcribe-summarize:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /aiservices/speech-summarization/summarize
Summarizer
- Read
List Batch Summarizer Jobs
Retrieves a paginated list of batch summarization jobs for the authenticated tenant. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aiservices:read:list_summarizer_batch_jobs:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /aiservices/summarizer/jobs - Read
Get Batch Summarizer Job
Retrieves job-level status, configuration, and progress summary for a batch summarization job. To list individual file results, use the List Batch Job Files endpoint. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aiservices:read:summarizer_batch_job:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /aiservices/summarizer/jobs/{jobId} - Read
List Batch Summarizer Job Files
Retrieves a paginated list of individual file results for a batch summarization job. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aiservices:read:list_summarizer_batch_job_files:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /aiservices/summarizer/jobs/{jobId}/files - Read
Get Batch Summarizer Job File
Retrieves the processing result for a specific file within a batch summarization job. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aiservices:read:summarizer_batch_job_file:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /aiservices/summarizer/jobs/{jobId}/files/{fileId} - Write
Summarize (Synchronous)
Submit transcript text and receive a summary inline. This is a synchronous operation — the response is returned immediately after summarization completes. Supported task types: full summary (recap + section summary + action items, also returned combined as markdown), recap only, action items only, or section summary only. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aiservices:write:summarize:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /aiservices/summarizer/summarize - Destructive
Submit Batch Summarizer Job
Submits a batch summarization job for asynchronous processing. Supports three input modes: single file (mode inferred when the URI points to a single file), prefix or container enumeration (with optional filters), or explicit manifest (list of URIs). Maximum of 1,000 files per manifest. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aiservices:write:summarizer_batch_job:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /aiservices/summarizer/jobs - Destructive
Cancel Batch Summarizer Job
Cancels a batch summarization job. Only jobs in a `QUEUED` or `PROCESSING` state can be canceled. Successfully canceled jobs transition to the `CANCELED` state. Jobs that are already in a `SUCCEEDED`, `FAILED`, or `CANCELED` state cannot be canceled. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aiservices:delete:summarizer_batch_job:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /aiservices/summarizer/jobs/{jobId}
Translator
- Read
List Batch Translator Jobs
Retrieves a paginated list of batch translation jobs for the authenticated tenant. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aiservices:read:list_translator_batch_jobs:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /aiservices/translator/jobs - Read
Get Batch Translator Job
Retrieves job-level status, configuration, and progress summary for a batch translation job. To list individual file results, use the List Batch Job Files endpoint. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aiservices:read:translator_batch_job:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /aiservices/translator/jobs/{jobId} - Read
List Batch Translator Job Files
Retrieves a paginated list of individual file results for a batch translation job. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aiservices:read:list_translator_batch_job_files:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /aiservices/translator/jobs/{jobId}/files - Read
Get Batch Translator Job File
Retrieves the processing result for a specific file within a batch translation job. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aiservices:read:translator_batch_job_file:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /aiservices/translator/jobs/{jobId}/files/{fileId} - Write
Translate (Synchronous)
Submits text and receives translations inline. This is a synchronous operation — the response returns immediately after translation completes. Supports auto-detection of the source language and translation into a target language. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aiservices:write:translate:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /aiservices/translator/translate - Destructive
Submit Batch Translator Job
Submits a batch translation job for asynchronous processing. Supports three input modes: single file (mode inferred when the URI points to a single file), prefix/container enumeration (with optional filters), or explicit manifest (list of URIs). Maximum of 1,000 files per manifest. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aiservices:write:translator_batch_job:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /aiservices/translator/jobs - Destructive
Cancel Batch Translator Job
Cancels a batch translation job. Only jobs in `QUEUED` or `PROCESSING` state can be canceled. Successfully canceled jobs transition to the `CANCELED` state. Jobs that are already in the `SUCCEEDED`, `FAILED`, or `CANCELED` state cannot be canceled. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aiservices:delete:translator_batch_job:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /aiservices/translator/jobs/{jobId}
VoiceAgent
- Read
Live Voice Agent WebSocket
The Voice Agent Live API enables real-time spoken conversations with an AI assistant over a WebSocket connection. Your application streams audio to the service and receives assistant speech, transcripts, and function-call events on the same connection. **Key features** - **Real-time responses:** Assistant speech streams as it is generated, so playback can begin before the complete response is ready. - **Conversation transcripts:** Receive final user transcripts and streamed assistant transcripts to display the conversation alongside audio. - **Natural conversation flow:** Automatic turn detection identifies when the user has finished speaking, and users can interrupt an assistant response by speaking. - **Session configuration:** Set the assistant's instructions and choose a supported voice when you start a session. - **Function calling:** Define functions that run in your application and return their results to the session so the assistant can use them in the conversation. - **Bring your own key:** Use your own API key to connect to supported OpenAI- or Anthropic-hosted models as the LLM provider. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aiservices:read:voice-agent:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /aiservices/voice-agent/live
Call History & Reporting
- Read
Get call history by ID
Retrieve call history for a call history ID. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dialer:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_auto_dialer:read:call_history:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /dialer/call-histories/{callHistoryId} - Read
Get Call History
Retrieve call history with pagination and various filtering options. Supports filtering by user, call list ID, or call ID, but not all three simultaneously. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dialer:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_auto_dialer:read:call_history:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /dialer/call-history - Read
Get Report Call History
Returns the synchronous, page-based call history report for the resolved reporting scope and date window. This endpoint uses cursor pagination via `next_page_token` and `page_size`, and returns the filters actually applied to the page. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dialer:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_auto_dialer:read:list_seller_productivity:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /dialer/reports/call-history - Read
Get Seller Productivity Report
Returns seller productivity metrics for the resolved reporting scope and date window. The response may include aggregate totals, per-rep rows, or both, depending on the `include` parameter. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dialer:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_auto_dialer:read:user_seller_productivity:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /dialer/reports/seller-productivity
Call List Management
- Read
List Call Lists
Retrieve all call lists in the account. Optionally filter by user IDs/emails and source. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dialer:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_auto_dialer:read:call_lists:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /dialer/call-lists - Read
Get Call List by ID
Retrieve details of a specific call list by its ID Error Conditions: Invalid callListId User is not Zoom Owner or Admin **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dialer:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_auto_dialer:read:call_lists:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /dialer/call-lists/{callListId} - Write
Create Call List
Create a new call list **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dialer:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_auto_dialer:write:call_lists:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /dialer/call-lists - Write
Update Call List
Update an existing call list. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dialer:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_auto_dialer:update:call_lists:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /dialer/call-lists/{callListId} - Destructive
Delete Call List
Delete a call list and all its associated prospects. **Limitation:** Currently, deletion is supported only for call lists created through Open APIs. Future updates will expand support to all call lists. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dialer:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_auto_dialer:delete:call_lists:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /dialer/call-lists/{callListId}
Prospect Management
- Read
List All Prospects in Call List
Retrieve all prospects in a specific call list. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dialer:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_auto_dialer:read:prospects:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /dialer/call-lists/{callListId}/prospects - Read
Get Prospect by ID
Retrieve details of a specific prospect. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dialer:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_auto_dialer:read:prospects:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /dialer/prospects/{prospectId} - Write
Create Prospect
Create and add a prospect to a call list **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dialer:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_auto_dialer:write:prospects:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /dialer/call-lists/{callListId}/prospects - Write
Update Prospects batch
Batch update existing prospects. Can also reassign prospects to a different call list. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dialer:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_auto_dialer:update:prospects:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /dialer/call-lists/{callListId}/prospects - Write
Create Prospects batch
Batch call to add prospects to a call list. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dialer:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_auto_dialer:write:prospects:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /dialer/call-lists/{callListId}/prospects/batch - Write
Update Prospect
Update an existing prospect. Can also reassign prospect to a different call list. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dialer:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_auto_dialer:update:prospects:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /dialer/call-lists/{callListId}/prospects/{prospectId} - Destructive
Delete Prospect
Delete a single prospect from a call list by its ID. **Limitation:** Currently, deletion is supported only for prospects belonging to call lists created through Open APIs. A future update will expand support to all call lists. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dialer:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_auto_dialer:delete:prospects:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /dialer/call-lists/{callListId}/prospects/{prospectId}
acl
- Read
List ACL rules of specified calendar
Returns the rules in the access control list for the calendar. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:read`,`calendar:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:read:list_acl`,`calendar:read:list_acl:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /calendars/{calId}/acl - Read
Get the specified ACL rule
Returns an access control list (ACL) rule. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:read`,`calendar:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:read:acl`,`calendar:read:acl:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /calendars/{calId}/acl/{aclId} - Write
Create a new ACL rule
Creates an access control list rule. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:write`,`calendar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:write:acl`,`calendar:write:acl:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
POST /calendars/{calId}/acl - Write
Update the specified ACL rule
Updates an access control list rule. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:write`,`calendar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:update:acl`,`calendar:update:acl:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
PATCH /calendars/{calId}/acl/{aclId} - Destructive
Delete an existing ACL rule
Deletes an access control list (ACL) rule. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:write`,`calendar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:delete:acl`,`calendar:delete:acl:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
DELETE /calendars/{calId}/acl/{aclId}
calendar list
- Read
List the calendars in the user's own calendarList
Returns the calendars in the user's calendar list. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:read`,`calendar:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:read:list_calendar_lists` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /calendars/users/{userIdentifier}/calendarList - Read
Get a specified calendar from the user's own calendarList
Returns a calendar from the user's calendar list. The user can be `me` or a given calendar ID. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:read`,`calendar:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:read:calendar_list` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /calendars/users/{userIdentifier}/calendarList/{calendarId} - Write
Insert an existing calendar to the user's own calendarList
Inserts an existing calendar into the user's calendar list. The user can be `me` or a given calendar ID. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:write`,`calendar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:write:calendar_list` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /calendars/users/{userIdentifier}/calendarList - Write
Update an existing calendar in the user's own calendarList
Updates an existing calendar on the user's calendar list. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:write`,`calendar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:update:calendar_list` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /calendars/users/{userIdentifier}/calendarList/{calendarId} - Destructive
Delete an existing calendar from the user's own calendarList
Removes a calendar from the user's calendar list. The user can be `me` or a given calendar ID. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:write`,`calendar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:delete:calendar_list` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /calendars/users/{userIdentifier}/calendarList/{calendarId}
calendars
- Read
Get the specified calendar
Returns metadata for a calendar. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:read`,`calendar:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:read:calendar`,`calendar:read:calendar:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /calendars/{calId} - Write
Create a new secondary calendar
Creates a secondary calendar. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:write`,`calendar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:write:calendar`,`calendar:write:calendar:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
POST /calendars - Write
Update the specified calendar
Updates metadata for a calendar. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:write`,`calendar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:update:calendar`,`calendar:update:calendar:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
PATCH /calendars/{calId} - Destructive
Delete a calendar owned by a user
Deletes a calendar **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:write`,`calendar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:delete:calendar`,`calendar:delete:calendar:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /calendars/{calId}
colors
- Read
Get the color definitions for calendars and events
Returns the color definitions for calendars and events. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:read`,`calendar:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:read:color`,`calendar:read:color:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /calendars/colors
events
- Read
List events on the specified calendar
Returns events on the specified calendar. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:read:admin`,`calendar:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:read:list_events`,`calendar:read:list_events:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /calendars/{calId}/events - Read
Get the specified event on the specified calendar
Returns a Zcalendar event. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:read`,`calendar:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:read:event`,`calendar:read:event:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /calendars/{calId}/events/{eventId} - Read
List all instances of the specified recurring event
Returns instances of the specified recurring event. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:read`,`calendar:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:read:instance_event`,`calendar:read:instance_event:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /calendars/{calId}/events/{eventId}/instances - Write
Insert a new event to the specified calendar
Creates an event. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:write`,`calendar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:write:event`,`calendar:write:event:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
POST /calendars/{calId}/events - Write
Import event to the specified calendar
Imports an event. This operation adds a private copy of an existing event to a calendar. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:write`,`calendar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:write:import_event`,`calendar:write:import_event:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
POST /calendars/{calId}/events/import - Write
Quick add an event to the specified calendar
Creates an event based on a simple text string. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:write`,`calendar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:write:quick_add_event`,`calendar:write:quick_add_event:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
POST /calendars/{calId}/events/quickAdd - Write
Update the specified event on the specified calendar
Updates an event. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:write`,`calendar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:update:event`,`calendar:update:event:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
PATCH /calendars/{calId}/events/{eventId} - Write
Move the specified event from a calendar to another specified calendar
Moves an event to another calendar, such as changing an event's organizer. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:write`,`calendar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:write:move_event`,`calendar:write:move_event:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
POST /calendars/{calId}/events/{eventId}/move - Destructive
Delete an existing event from the specified calendar
Deletes an event. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:write`,`calendar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:delete:event`,`calendar:delete:event:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
DELETE /calendars/{calId}/events/{eventId}
freebusy
- Read
Query freebusy information for a set of calendars
Returns free or busy information for a set of calendars. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:read`,`calendar:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:read:list_events`,`calendar:read:list_events:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /calendars/freeBusy
settings
- Read
List all user calendar settings of the authenticated user
Returns all user settings for the authenticated user. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:read`,`calendar:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:read:list_settings` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /calendars/users/{userIdentifier}/settings - Read
Get the specified user calendar settings of the authenticated user
Returns a single setting. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:read`,`calendar:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:read:setting` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /calendars/users/{userIdentifier}/settings/{settingId} - Write
Patch the specified user calendar settings of the authenticated user
Patches a single setting. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:write`,`calendar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `calendar:update:setting`,`calendar:update:setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /calendars/users/{userIdentifier}/settings/{settingId}
Archiving
- Read
Download archive attachments
Batch retrieve download URLs for attachments in archived files. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_archiving:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read:archive:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
GET /docs/archive_attachments - Read
List doc archive data
List archived documents for a given account within a specified time range. Each archive record includes a `download_url` for downloading the complete archived content as a **JSON** file. See the `download_url` field description for the full JSON schema definition. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_archiving:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read:archive:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
GET /docs/archives - Read
List archived files
Get an account's archived meeting or webinar files. Zoom's [archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-indicators) lets account administrators set up an automated mechanism to record, collect, and archive meeting data to a third-party platform of their choice to satisfy FINRA or other compliance requirements. **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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `archiving:read:list_archived_files:admin`,`archiving:read:list_archived_files:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /archive_files - Read
List archived file download audit logs
Get an account's archived meeting or webinar file download audit logs. The response groups audit records by meeting or webinar instance, archive file, and source IP address. Zoom's [archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-indicators) lets account administrators set up an automated mechanism to record, collect, and archive meeting data to a third-party platform of their choice to satisfy FINRA or other compliance requirements. **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). * A paid account. **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /archive_files/download_audit - Read
Get archived file statistics
Get statistics about an account's archived meeting or webinar files. Zoom's [archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-indicators) lets account administrators set up an automated mechanism to record, collect, and archive meeting data to a third-party platform of their choice to satisfy FINRA and other compliance requirements. **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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `archiving:read:archived_file_statistics:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /archive_files/statistics - Read
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting_token:read:admin:local_archiving` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:local_archiving_token:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /meetings/{meetingId}/jointoken/local_archiving - Read
Get a meeting's archived files
Return a specific meeting instance's [archived files](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-indicators). See [Archived JSON schemas](/docs/api/references/archived-json-schema/) for in-meeting chat message and subgroup archiving activity JSON schemas. **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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `archiving:read:archived_files:admin`,`archiving:read:archived_files` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /past_meetings/{meetingUUID}/archive_files - Read
List whiteboards sessions
Creates a list of archived sessions under current account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_content:read`,`whiteboard_content:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:list_sessions`,`whiteboard:read:list_sessions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /whiteboards/sessions - Read
Download Whiteboards activity file
Use this API to download the Whiteboard archival file. For obtaining the download URL, please consult the [List whiteboard sessions activities](https://developers.zoom.us/docs/api/rest/reference/whiteboard/methods/#operation/Listwhiteboardsessionsarchivedfiles) documentation. Scroll down under field on schema to documentation URL string. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_content:read`,`whiteboard_content:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:archived_file`,`whiteboard:read:archived_file:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /whiteboards/sessions/activity/download/{path} - Read
List whiteboard sessions activities
Lists a session's activity information. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_content:read`,`whiteboard_content:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:session`,`whiteboard:read:session:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /whiteboards/sessions/{seesionId} - Destructive
Update an archived file's auto-delete status
Update an archived file's auto-delete status. **Prerequisites:** * [Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) must enable the [**Meeting and Webinar Archiving** feature](https://support.zoom.us/hc/en-us/articles/4405656451213--Archiving-for-meetings-and-webinars) for your account. * Open the disabling auto-delete feature in OP. Contact [Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) to open. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write`,`recording:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `archiving:update:archived_file_auto_delete_status`,`archiving:update:archived_file_auto_delete_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /archive_files/{fileId} - Destructive
Delete a meeting's archived files
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `archiving:delete:archived_files:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /past_meetings/{meetingUUID}/archive_files
Collaborator
- Read
List collaborators of a file
List collaborators of a file. Only `doc` or `data table` files are supported. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_collaborator:read`,`docs_collaborator:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read:list_file_collaborators`,`docs:read:list_file_collaborators:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /docs/files/{fileId}/collaborators - Read
Get collaborators of a task
Retrieves all collaborators of a specified task. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks_collaborator:read:admin`,`tasks_collaborator:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks:read:list_collaborators`,`tasks:read:list_collaborators:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /tasks/items/{taskId}/collaborators - Read
Get collaborators of a whiteboard
Returns a list of a whiteboard collaborators. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_collaborator:read:admin`,`whiteboard_collaborator:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:list_collaborators:admin`,`whiteboard:read:list_collaborators` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /whiteboards/{whiteboardId}/collaborator - Write
Add collaborators for a file
Share a file with newly added Zoom users or Zoom Team Chat channels. Only `doc` or `data table` files are supported. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_collaborator:write`,`docs_collaborator:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:write:collaborator`,`docs:write:collaborator:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /docs/files/{fileId}/collaborators - Write
Modify a collaborator’s role on a file
Modify a collaborator’s role on a file. Only `doc` or `data table` files are supported. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_collaborator:write`,`docs_collaborator:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:update:collaborator`,`docs:update:collaborator:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
PATCH /docs/files/{fileId}/collaborators/{collaboratorId} - Write
Share a clip with new users
Create collaborators for a clip. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:write`,`clips:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:write:collaborators`,`clips:write:collaborators:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
POST /clips/{clipId}/collaborators - Write
Add collaborators to a task
Add one or more collaborators to a specified task. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks_collaborator:write`,`tasks_collaborator:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks:write:collaborators`,`tasks:write:collaborators:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /tasks/items/{taskId}/collaborators - Write
Share a whiteboard to new users or team chat channels.
Add collaborators to a whiteboard. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_collaborator:write:admin`,`whiteboard_collaborator:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write:collaborator:admin`,`whiteboard:write:collaborator` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /whiteboards/{whiteboardId}/collaborator - Write
Update whiteboard collaborators
Use this API to update whiteboard collaborators. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_collaborator:write:admin`,`whiteboard_collaborator:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:update:collaborator:admin`,`whiteboard:update:collaborator` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /whiteboards/{whiteboardId}/collaborator - Destructive
Remove a collaborator from a file
Remove a collaborator from a file. Only `doc` or `data table` files are supported. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_collaborator:delete`,`docs_collaborator:delete:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:delete:collaborator`,`docs:delete:collaborator:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
DELETE /docs/files/{fileId}/collaborators/{collaboratorId} - Destructive
Remove the collaborator from a clip
Removes a collaborator from a clip. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:write`,`clips:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:delete:collaborators`,`clips:delete:collaborators:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /clips/{clipId}/collaborators - Destructive
Remove collaborator from task
Removes a specific collaborator from a task. This operation will completely remove the user's access to the task. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks_collaborator:write`,`tasks_collaborator:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks:delete:collaborator:admin`,`tasks:delete:collaborator` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /tasks/items/{taskId}/collaborators/{userId} - Destructive
Remove the collaborator from a whiteboard
Removes a collaborator from a whiteboard. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_collaborator:write:admin`,`whiteboard_collaborator:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:delete:collaborator:admin`,`whiteboard:delete:collaborator` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /whiteboards/{whiteboardId}/collaborator/{collaboratorId}
Comment
- Read
List comments
Lists comments in the specified Zoom Canvas file as a flat, cursor-paginated collection. Results are ordered by `created_time` in ascending order. Comments with the same `created_time` are ordered by `comment_id` in ascending order. The `thread_type` and `thread_id` query filters are applied by the server. Open and resolved threads are both returned. Use each item's `thread_status` to exclude resolved threads. `page_size` sets the maximum number of comments returned in one page. A page may contain fewer comments than `page_size`. A shorter page does not indicate the end of the collection; use `next_page_token` to determine whether another page is available. Permanently deleted comments are not returned. Every returned comment includes `parent`. A reply to a deleted comment retains `parent.parent_comment_id`; retrieving that parent returns `404`. You must have Commenter or higher access to the file. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_comment:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:read:comment` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster** **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_comment:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:read:comment` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /docs/files/{fileId}/comments - Read
Get a comment
Gets the specified comment from a Zoom Canvas file. Deleted comments are not readable. You must have Commenter or higher access to the file. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_comment:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:read:comment` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster** **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_comment:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:read:comment` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /docs/files/{fileId}/comments/{commentId} - Read
List clip comments
Returns the list of comments for a clip. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:read`,`clips:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:read:list_comments`,`clips:read:list_comments:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /clips/{clipId}/comments - Read
Get a task's comments
Retrieves all comments associated with a specific task. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks_comment:read`,`tasks_comment:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks:read:comments`,`tasks:read:comments:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /tasks/items/{taskId}/comments - Write
Create a comment
Creates a root comment or reply in the specified Zoom Canvas file. Use `thread_type` only when creating a root comment. It determines the type of the new thread: - `discussion` creates a discussion thread. - `full_page` creates a full-page thread. This endpoint does not create `inline` threads. To create a reply: - To reply directly to a thread, send `parent.type=thread` with `parent.thread_id`. - To reply to a specific comment, send `parent.type=comment` with `parent.parent_comment_id`. Send exactly one of `thread_type` or `parent`. You must have Commenter or higher access to the file. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_comment:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:write:comment` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster** **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_comment:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:write:comment` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
POST /docs/files/{fileId}/comments - Write
Add a comment to a task
Adds a comment to a specific task. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks_comment:write`,`tasks_comment:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks:write:comment:admin`,`tasks:write:comment` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /tasks/items/{taskId}/comments - Destructive
Delete a comment
Permanently deletes the specified comment from a Zoom Canvas file. A root comment has `parent.type=thread`. Deleting a root comment or reply deletes only that comment. Existing child replies remain readable and retain their original `parent.parent_comment_id`. A `404` response when retrieving the parent comment indicates that the parent was permanently deleted. A thread is permanently deleted only when its last comment is deleted. Comments in resolved threads can be deleted. Users with Commenter or higher access can delete comments they created. Owners and co-owners can also delete comments created by other users. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_comment:delete` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:delete:comment` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster** **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_comment:delete` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:delete:comment` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
DELETE /docs/files/{fileId}/comments/{commentId} - Destructive
Update a comment
Updates the content of the specified comment in a Zoom Canvas file. The replacement text is processed as plain text. You must have Commenter or higher access to the file and be the comment author. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_comment:update` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:update:comment` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster** **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_comment:update` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:update:comment` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
PATCH /docs/files/{fileId}/comments/{commentId} - Destructive
Delete a comment
Removes a comment from a clip. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:write`,`clips:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:delete:comment`,`clips:delete:comment:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /clips/{clipId}/comments/{commentId} - Destructive
Delete a task's comment
Deletes a specific comment from a task by its ID. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks_comment:write`,`tasks_comment:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks:delete:comment:admin`,`tasks:delete:comment` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /tasks/items/{taskId}/comments/{commentId}
DataTable Content
- Read
List data tables in a file
Returns a list of data tables. There are two scenarios when listing data tables of the specified file: 1. If the file type is `doc`, this API returns all the inline data tables in the file. 2. If the file type is `data_table`, this API returns all the tables. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_data_table:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:read:data_table` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /docs/files/{fileId}/data_tables - Read
List columns
List the columns of a table. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_data_table:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:read:data_table` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /docs/files/{fileId}/data_tables/{tableId}/columns - Read
Search rows
Retrieve rows from a table with pagination, sorting, field selection, and filtering. A maximum of 100 rows are returned at a time. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_data_table:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:read:data_table` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
POST /docs/files/{fileId}/data_tables/{tableId}/rows/query - Write
Create data table
Creates a new table inside an existing file. This API does not create a new `data table` file. To create a `data table` file, use the `Create a new file` endpoint with the `data_table` file type. This API supports two host file types: - In a **doc** file, the inserted table is referred to as a **data table**. - In a **data table** file, the inserted table is referred to as a **table**. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_data_table:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:write:data_table` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
POST /docs/files/{fileId}/data_table - Write
Update table metadata
Update the table metadata, such as the title. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_data_table:update` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:update:data_table` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
PATCH /docs/files/{fileId}/data_tables/{tableId} - Write
Create a column
Add a new column to the table. A table allows up to 200 columns. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_data_table:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:write:data_table` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
POST /docs/files/{fileId}/data_tables/{tableId}/columns - Write
Update a column
Update a column. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_data_table:update` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:update:data_table` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
PATCH /docs/files/{fileId}/data_tables/{tableId}/columns/{columnId} - Write
Create table rows
Add rows to a table. Create up to 10 rows at a time. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_data_table:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:write:data_table` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
POST /docs/files/{fileId}/data_tables/{tableId}/rows - Write
Update rows
Update rows of the table. A maximum of 10 rows can be updated at one time. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_data_table:update` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:update:data_table` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
PATCH /docs/files/{fileId}/data_tables/{tableId}/rows - Destructive
Delete a column
Delete a column from a table. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_data_table:delete` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:delete:data_table` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
DELETE /docs/files/{fileId}/data_tables/{tableId}/columns/{columnId} - Destructive
Delete rows
Batch delete rows. Delete up to 10 rows at a time. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_data_table:delete` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:delete:data_table` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
DELETE /docs/files/{fileId}/data_tables/{tableId}/rows
Doc Content
- Write
Insert blocks into a document
Insert new blocks at a specific position in a document. Accepts XML-formatted block content and supports positioning above, below, or inside a specific parent block. Use the Get file content endpoint with the query parameter `format=xml` first to fetch the document structure and block IDs. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_content:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:write:content` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /docs/files/{fileId}/blocks - Destructive
Replace a range of blocks
Replace a contiguous range of sibling blocks with new blocks in a single atomic operation. All blocks between start and end (inclusive) are removed and replaced with the provided XML block content. Important: `start_block_id` and `end_block_id` must be direct children of the same parent block (siblings). If they are not siblings, the operation will fail. Use the Get file content endpoint to verify the document structure before calling this endpoint. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_content:update` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:update:content` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /docs/files/{fileId}/blocks/replace_range - Destructive
Delete a specific block
Deletes a block and all its content from the document. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_content:delete` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:delete:content` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /docs/files/{fileId}/blocks/{blockId} - Destructive
Update a specific block
Updates the content of an existing block using XML-formatted content. Keeps the existing block type and replaces the content. To change the block type, use ReplaceBlockRange. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_content:update` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:update:content` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /docs/files/{fileId}/blocks/{blockId}
Export
- Read
Get file export status
Use this API to query the status of a file export. Before using this API, confirm that you have invoked the API Create a file export endpoint and obtained the `export_id`. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_export:read`,`docs_export:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read:export`,`docs:read:export:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /docs/exports/{exportId}/status - Read
Get file content
Retrieve the file name, full file content in the requested `format`, and a link to open the document. Supported formats: `markdown` or `xml`. Use `markdown` for reading or summarization; use `xml` to get an XML block tree with block IDs for block-level editing. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_export:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read:export` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `CANVAS-EXPORT`
GET /docs/files/{fileId}/content - Read
Get file content
Retrieve the file name and full file content in the requested `format`. Supported formats per file type: doc - `markdown` or `xml`; spreadsheet - `csv`; presentation - `markdown`; paper_doc - `markdown`. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `hub_content:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `hub:read:content` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `CANVAS-EXPORT` **Not supported in Gov cluster**
GET /hub/files/{fileId}/content - Read
Download whiteboard export
Use this API to download the whiteboard export. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_content:read:admin`,`whiteboard_content:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:export`,`whiteboard:read:export:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /whiteboards/export/task/{taskId} - Read
Get whiteboard export generation status
Use this API to query the status of the whiteboard export generation. Before using this API, confirm that you have invoked the interface for generating the whiteboard file [**Create whiteboard export**](https://developers.zoom.us/docs/zoom-whiteboard/apis/#operation/Createwhiteboardsexport) and obtained the `task_id`. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_content:read:admin`,`whiteboard_content:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:export`,`whiteboard:read:export:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /whiteboards/export/task/{taskId}/status - Write
Create a file export
Creates a export for specified file. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_export:write`,`docs_export:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:write:export`,`docs:write:export:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `CANVAS-EXPORT` **Not supported in Gov cluster**
POST /docs/exports - Write
Create whiteboard export
Generates the export for the provided whiteboards. This process will generate a PDF of whiteboard projects along with an audit log, bundling them into a ZIP file. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_export:write:admin`,`whiteboard_export:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write:export`,`whiteboard:write:export:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /whiteboards/export
File Management
- Read
Get metadata of a file
Get metadata of a file. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read`,`docs:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read:file`,`docs:read:file:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /docs/files/{fileId} - Read
List all children of a file
List all children of a file. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read`,`docs:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read:list_children`,`docs:read:list_children:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /docs/files/{fileId}/children - Read
Get user My docs info
Get the specified user's My docs info. My docs is the root of a user's documents. **Example**: When an admin needs to list all children of another user's My docs ([/docs/files/{fileId}/children](https://s.zoom.us/u/bPFf2TRxP)), this API should be called to get the target user's My docs ID as `fileId` in path. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read:file:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /docs/users/{userId}/root - Read
Get file duplicate task status
Get the current status and result of a file duplicate task. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `hub_file_duplicate_task:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `hub:read:file_duplicate_task` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /hub/file_duplicate_tasks/{taskId} - Write
Create a new file
Creates a new file for a user. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:write`,`docs:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:write:file`,`docs:write:file:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /docs/files - Write
Modify metadata of a file
Modify metadata of a file. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:write`,`docs:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:update:file`,`docs:update:file:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
PATCH /docs/files/{fileId} - Write
Duplicate a file
Duplicate an existing Zoom Hub file to the target location. Supported file types include `doc`, `data_table`, `paper_doc`, `spreadsheet`, `presentation`, `whiteboard`, and `clip`. Other file types are not supported. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `hub_content:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `hub:write:content` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY` **Not supported in Gov cluster**
POST /hub/files/{fileId}/duplicate - Write
Move a file
Move a file or folder into a target parent, optionally controlling its position among the target parent's children. Moving a folder also moves all of its descendants. The operation runs synchronously; on success it returns no content. A move is rejected when the target parent does not exist, when the target parent is the file being moved or a descendant of it (which would create a cycle), or when the caller lacks permission to remove the file from its current location or to add children to the target parent. When invoked with an `admin` scope, this operation can move only individual files; moving folders is not supported and the request is rejected. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:write`,`docs:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:update:file`,`docs:update:file:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster** **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `hub_move:write`,`hub_move:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `hub:write:move`,`hub:write:move:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
POST /hub/files/{fileId}/move - Destructive
Delete a file
Delete a file. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:delete`,`docs:delete:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:delete:file`,`docs:delete:file:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /docs/files/{fileId} - Destructive
Transfer ownership of a file
Transfer a file’s ownership to another user. Only `doc` or `data table` files are supported. Only the file `owner` has permission to perform an ownership transfer. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_file_owner:write`,`docs_file_owner:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:update:file_owner`,`docs:update:file_owner:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
PUT /docs/files/{fileId}/owner
File Uploads
- Write
Create file upload for docs import or attachments
Create a file upload for document import or attachments. Notes: - Base URL: https://fileapi.zoom.us/v2. - Rate limit: 20 requests per second per user or 2000 requests per second per IP address. - The caller must retain the Authorization header when redirected to a different hostname. - Unsupported file formats: `.svg`. - For an account-level [OAuth](https://developers.zoom.us/docs/integrations/create/) app, this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983#h_80abad9b-86a8-492c-8a3b-5b0141a8c0a9) with Edit permission for Docs Management. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_file_uploads:write`,`docs_file_uploads:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:write:file_uploads`,`docs:write:file_uploads:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `CANVAS-IMPORT` **Not supported in Gov cluster**
POST /docs/file_uploads
General Access
- Read
Get the general access setting of a file
Get the general access settings of a file. Only `doc` or `data table` files are supported. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_general_access:read`,`docs_general_access:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read:general_access`,`docs:read:general_access:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /docs/files/{fileId}/general_access_setting - Write
Modify the general access setting of a file
Modify the general access setting for a file. Only `doc` or `data table` files are supported. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_general_access:write`,`docs_general_access:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:update:general_access`,`docs:update:general_access:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
PATCH /docs/files/{fileId}/general_access_setting
Import
- Read
Get file import status
Use this API to query the status of a new file by import. Before using this API, confirm that you have invoked the API **Create a new file by import** endpoint and obtained the `import_id`. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_import:read`,`docs_import:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read:import`,`docs:read:import:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /docs/imports/{importId}/status - Read
Get import job status
Retrieve an import job's current status and results. Poll this endpoint after submitting an import job via [**Submit a task import job**](/docs/api-reference/tasks/methods#operation/submitTasksImportJob). **Job lifecycle** `pending` > `processing` > `completed` or `failed` **Polling recommendation** Poll every 3-5 seconds. Stop when status is `completed` or `failed`. Import job results are retained for 7 days. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks:read`,`tasks:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks:read:import`,`tasks:read:import:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /tasks/imports/{importId} - Read
Get whiteboard import status
Use this API to query the status of new whiteboard by import. Before using this API, confirm that you have invoked the interface for import file to create new whiteboard **Create a new whiteboard by import** and obtained the `task_id`. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_import:read`,`whiteboard_import:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:import:admin`,`whiteboard:read:import` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /whiteboards/import/{taskId}/status - Write
Create a new file from content
Creates a new doc from Markdown content. The Markdown content is limited to 100 KB in size. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_import:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:write:import` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `CANVAS-IMPORT` **Not supported in Gov cluster**
POST /docs/import_content - Write
Create a new file by import
Creates a new file from a file upload. **When importing the uploaded file as a specified type of Docs file:** - `doc` - Upload file size limit is 10MB. - The size limit for a single Block's content is 1MB. - Maximum number of Blocks allowed is 20,000. - `data_table` - Upload file size limit is 10MB. - Maximum number of columns allowed in a single data table is 200. - The size limit for a single Block's content is 1MB. - Maximum number of Blocks allowed in a single data table is 20,000. **When importing an HTML compressed package exported from Notion into Docs:** - Maximum allowed size for a single zip archive is 4GB. - Maximum number of files that can be imported into Docs within a single ZIP file is 100,000. - The maximum depth of parent-child relationships between files in the tree structure is 20. - Maximum number of child nodes allowed per node in the tree is 2,000. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_import:write`,`docs_import:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:write:import`,`docs:write:import:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `CANVAS-IMPORT` **Not supported in Gov cluster**
POST /docs/imports - Write
Create a new file from content
Creates a new file from plain-text content. The expected content format per file type: doc - Markdown; paper_doc - Markdown; spreadsheet - CSV. The content is limited to 100 KB in size. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `hub_content:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `hub:write:content` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `CANVAS-IMPORT` **Not supported in Gov cluster**
POST /hub/files - Write
Submit a task import job
Submit an asynchronous import job to import tasks from an external platform into Zoom Tasks. Use the `file_id` returned from the **Upload an import file** endpoint. The import job is processed asynchronously. Use **Get import job status** to poll the progress and results. **Field mapping (Slack Lists to Zoom Tasks)** Slack Lists has two schema patterns. This endpoint supports both. 1. **Todo mode** - schema contains task-oriented columns such as `todo_completed`, `todo_due_date`, and `todo_assignee`. 2. **Normal mode** - schema does not contain `todo_completed`. Status is inferred from `select` columns when `status_mapping` is provided. | Slack Column Type | Zoom Tasks Field | Notes | |---|---|---| | `text` + `is_primary_column: true` | Title | Required. The main task name column. | | `text` + `is_primary_column: false` | Description | Non-primary text columns (for example, "Description"). | | `todo_assignee` / `user` | Assignee | Slack user ID is mapped to Zoom user by email. See `user_mapping`. | | `todo_due_date` / `date` | Due date | Mapped as-is in `yyyy-MM-dd` format. | | `todo_completed` | Status | Todo mode only. `true` -> `done`, `false` -> `to_do` when no `status_mapping` match is found. | | `select` | Status | Used in both modes. Option label is matched against `status_mapping` keys. In normal mode, this is the primary status source. | | `rating` | Priority | 1 star -> `Low`, 2 stars -> `Medium`, 3 stars -> `High`. | | `number` / `checkbox` / `email` / `phone` / `channel` / `link` / `message` / `vote` / `reference` / `attachment` / `canvas` | Description (appended) | Preserved as custom fields. `Custom Fields: {column name}: {value}`. | **Status precedence** if `status_mapping` resolves a value from `select`, that value is used first; otherwise the importer falls back to `todo_completed` and then `to_do` as the default. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks:write`,`tasks:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks:write:import`,`tasks:write:import:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /tasks/imports - Write
Create a new whiteboard by import
Creates a new whiteboard for a user by converting Miro, Mural, or Visio files. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_import:write`,`whiteboard_import:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write:import`,`whiteboard:write:import:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY` **Not supported in Gov cluster**
POST /whiteboards/import
Report
- Read
Get activity report
Retrieve a list of docs activity logs. Only one month at a time can be requested and it must be within the last year. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_activity_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read:activity_report:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /docs/reports/activity - Read
Get Zoom Virtual Agent engagements
Generates a list of Zoom Virtual Agent engagements. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva_report:read`,`zva_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:read:list_engagements:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /virtual_agent/report/engagements - Read
Get ZVA query details
Returns a list of ZVA engagement query details. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva_report:read`,`zva_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:read:list_queries:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /virtual_agent/report/engagements/query_details - Read
Get ZVA variable details
Get a list of ZVA engagement variable details. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva_report:read`,`zva_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:read:list_variables:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /virtual_agent/report/engagements/variables - Read
Get ZVA Surveys
Returns a list of ZVA engagement surveys. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva_report:read`,`zva_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:read:list_surveys:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /virtual_agent/report/surveys - Read
Get ZVA transcripts
Generates a list of ZVA transcripts. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva_report:read`,`zva_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:read:list_transcripts:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /virtual_agent/report/transcripts
Search
- Read
Search files
Search for files accessible to the current user by query and filters (file_types, ancestor_ids, created_by, owner_id). Pagination uses an opaque next_page_token cursor. The first page should omit next_page_token; subsequent pages must pass it back unchanged along with the same filter parameters as the initial request. Changing any filter while providing next_page_token is invalid and will result in a 400 Bad Request. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_file_search:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:write:file_search` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
POST /docs/file_search
Chat Channel Mention Group
- Read
List channel mention groups
Returns a list of all the mention groups in a channel. The maximum number of mention groups in a channel is 20. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:read`,`chat_channel:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:mention_group`,`team_chat:read:mention_group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /chat/channels/{channelId}/mention_group - Read
List the members of a mention group
Returns a list of the members in the mention group. The maximum number of members in a mention group is **100**. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:read`,`chat_channel:write:admin`,`chat_channel:read:member` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:mention_group`,`team_chat:read:mention_group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /chat/channels/{channelId}/mention_group/{mentionGroupId}/members - Write
Create a channel mention group
Creates a channel mention group. A channel can have a maximum of 20 mention groups. The caller must be an admin or owner of the channel. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:write`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:write:mention_group:admin`,`team_chat:write:mention_group` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /chat/channels/{channelId}/mention_group - Write
Update a channel mention group information
Updates a mention group's information. The caller must be the channel's admin or owner. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:write`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:update:mention_group`,`team_chat:update:mention_group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /chat/channels/{channelId}/mention_group/{mentionGroupId} - Write
Add channel members to a mention group
Adds the channel members to a mention group. The maximum of a mention group members is 100. The caller must be the admin or owner of the channel. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:write`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:update:mention_group`,`team_chat:update:mention_group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /chat/channels/{channelId}/mention_group/{mentionGroupId}/members - Destructive
Delete a channel mention group
Removes a mention group in a channel. The caller must be the channel's admin or owner. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:write`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:delete:mention_group`,`team_chat:delete:mention_group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /chat/channels/{channelId}/mention_group/{mentionGroupId} - Destructive
Remove channel mention group members
Removes a mention group in channel. The caller must be the channel's admin or owner. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:write`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:update:mention_group`,`team_chat:update:mention_group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /chat/channels/{channelId}/mention_group/{mentionGroupId}/members
Chat Channels
- Read
List channel activity logs
Returns a list of a channel's activity logs. Date range need be less or equal to 3 days. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:list_channel_activity_logs:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /chat/activities/channels - Read
Get a channel
Returns information about a specific channel. Zoom chat [channels](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) allow users to communicate through chat in private or public groups. The [**Get a channel**](/docs/api-reference/chat/methods#operation/getChannel) API retrieves the channel information of other account users. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:read`,`chat_channel:write`,`chat_channel:read:admin`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:channel`,`team_chat:read:channel:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /chat/channels/{channelId} - Read
List channel members
Lists all members of a channel. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:read`,`chat_channel:write`,`chat_channel:read:admin`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:list_members`,`team_chat:read:list_members:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /chat/channels/{channelId}/members - Read
List channel members (Groups)
Returns a list of channel member groups. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:read:admin`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:list_groups:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /chat/channels/{channelId}/members/groups - Read
List user's channels
Generates a list of user's chat channels. 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 chat [channels](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) allow users to communicate through chat in private or public groups. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:read`,`chat_channel:write`,`chat_channel:read:admin`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:list_user_channels`,`team_chat:read:list_user_channels:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /chat/users/{userId}/channels - Write
Perform operations on channels
Performs different operations on channels. Operations include archive and unarchive. It supports batch operations. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:write:admin`,`chat_channel:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:update:archive_channels`,`team_chat:update:archive_channels:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /chat/channels/events - Write
Update a channel
Updates the name, type, and settings of a specific channel you own or administer. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:write`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:update:channel`,`team_chat:update:channel:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /chat/channels/{channelId} - Write
Invite channel members
Invites members that are in a user's contact list to a channel. A [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or multiple members. Five is the maximum number of members you can add at once with this API. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:write`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:write:members`,`team_chat:write:members:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /chat/channels/{channelId}/members - Write
Invite channel members (Groups)
Adds members and groups to a channel. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:write:groups:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /chat/channels/{channelId}/members/groups - Write
Join a channel
Joins a channel that is open for anyone in the same organization to join. A [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or more members. You cannot use this API to join private channels that only allow invited members to be a part of them. **Note:** This API only supports **user-managed** [OAuth-app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:write`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:write:member` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /chat/channels/{channelId}/members/me - Write
Create a channel
Creates a channel 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. Zoom chat channels allow users to communicate through chat in private or public groups. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:write`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:write:user_channel`,`team_chat:write:user_channel:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /chat/users/{userId}/channels - Write
Add a chat session content tab
Adds a content tab to a chat session, which can be a channel or one-to-one chat. The tab appears in the chat's top tab bar and gives participants quick access to a website or supported Zoom content such as a document, whiteboard, sheet, slide, or shared folder. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_chat:write:chat_tab` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /zoomchat/chat_sessions/{chat_session_id}/tabs - Write
Update a chat session content tab
Updates a content tab in a chat session, which can be a channel or a one-to-one chat. The tab is a shortcut in the chat's top tab bar to a website or supported Zoom content. It is not a browser tab or a separate chat session. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_chat:update:chat_tab` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /zoomchat/chat_sessions/{chat_session_id}/tabs/{tab_id} - Destructive
Delete a channel
Deletes a specific channel. Zoom chat [channels](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) allow users to communicate via chat in private or public groups. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:write`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:delete:channel`,`team_chat:delete:channel:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /chat/channels/{channelId} - Destructive
Batch remove members from a channel
Removes multiple members from a chat channel in a batch. A [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or many members. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:write`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:delete:batch_members`,`team_chat:delete:batch_members:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /chat/channels/{channelId}/members - Destructive
Remove a member (group)
Removes a group from a chat channel. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:delete:group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /chat/channels/{channelId}/members/groups/{groupId} - Destructive
Leave a channel
Leaves a specific channel. If you're no longer interested in being a member of an existing channel, you can leave the channel at any time. After leaving the channel, you can no longer access information from that channel. **Note:** This API only supports **user-managed** [OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app) **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:write`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:delete:member`,`team_chat:delete:member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /chat/channels/{channelId}/members/me - Destructive
Remove a member
Removes a member from a chat channel. A [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or many members. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:write`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:delete:member`,`team_chat:delete:member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /chat/channels/{channelId}/members/{identifier} - Destructive
Remove a chat session content tab
Removes a content tab from a chat session, which can be a channel or one-to-one chat. This removes only the shortcut from the chat's top tab bar; it does not delete the linked website, document, whiteboard, or other content. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_chat:delete:chat_tab` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /zoomchat/chat_sessions/{chat_session_id}/tabs/{tab_id}
Chat Channels (Account-level)
- Read
List account's public channels
Lists public chat channels that the account's users create. **Note:** This API only supports account-level apps. The user calling this API must have a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management) that has the **View** or **Edit** permission for the **Chat Channels** feature. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:read:admin`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:list_channels:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /chat/channels - Read
Search user's or account's channels
Searches user's or account's chat channels. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:read`,`chat_channel:write`,`chat_channel:read:admin`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:write:search_channels`,`team_chat:write:search_channels:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `RESOURCE-INTENSIVE`
POST /chat/channels/search - Read
List channel activity logs
Returns a list of a channel's activity logs. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:list_channel_activity_logs:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /chat/channels/{channelId}/activities - Read
Get retention policy of a channel
Returns the retention policy of a channel. **Note:** This API only supports account-level apps. The user calling this API must have a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management) that has the **View** or **Edit** permission for the **Chat Channels** feature. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:read:admin`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:retention:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /chat/channels/{channelId}/retention - Read
Get a channel
Returns information about a specific channel. 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 chat [channels](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) allow users to communicate through chat in private or public groups. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:read`,`chat_channel:write`,`chat_channel:read:admin`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:user_channel`,`team_chat:read:user_channel:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /chat/users/{userId}/channels/{channelId} - Read
List channel administrators
Lists all administrators of a channel. 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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:read`,`chat_channel:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:list_administrators:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /chat/users/{userId}/channels/{channelId}/admins - Read
List channel members
Returns a list of all members of a channel. 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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:read`,`chat_channel:write`,`chat_channel:read:admin`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:list_members`,`team_chat:read:list_members:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /chat/users/{userId}/channels/{channelId}/members - Write
Assign a new channel owner
Change the owner of a chat channel to another member within that channel. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:update:channel_owner:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /chat/channels/{channelId}/owner/{identifier} - Write
Update retention policy of a channel
Updates the retention policy of a channel. **Note:** This API only supports account-level apps. The user calling this API must have a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management) that has the **Edit** permission for the **Chat Channels** feature. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:update:retention:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /chat/channels/{channelId}/retention - Write
Update a channel
Updates the name, type, and settings of a specific channel that the user owns or administers. 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 chat channels allow users to communicate through chat in private or public channels. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:write`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:update:user_channel`,`team_chat:update:user_channel:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /chat/users/{userId}/channels/{channelId} - Write
Promote channel members to administrators
Promotes members to an administrator role in a channel. 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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:write`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:write:administrator:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /chat/users/{userId}/channels/{channelId}/admins - Write
Invite channel members
Invites members that are in a user's contact list to a channel. 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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:write`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:write:members`,`team_chat:write:members:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /chat/users/{userId}/channels/{channelId}/members - Destructive
Batch delete channels
Delete channels in batches. For user-level apps, pass the `me` value instead of the `userId` parameter. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:write`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:delete:channels`,`team_chat:delete:channels:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /chat/users/{userId}/channels - Destructive
Delete a channel
Deletes a specific channel. 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 chat [channels](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) allow users to communicate via chat in private or public groups. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:write`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:delete:user_channel`,`team_chat:delete:user_channel:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /chat/users/{userId}/channels/{channelId} - Destructive
Batch demote channel administrators
Demotes administrators in a channel in batch. 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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:write`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:delete:batch_administrators:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /chat/users/{userId}/channels/{channelId}/admins - Destructive
Batch remove members from a user's channel
Removes multiple members from a user's chat channel in a batch. A [chat channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or many members. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:write:admin`,`chat_channel:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:delete:member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /chat/users/{userId}/channels/{channelId}/members - Destructive
Remove a member
Removes a member from a chat channel. A [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or many members. 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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_channel:write`,`chat_channel:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:delete:member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
DELETE /chat/users/{userId}/channels/{channelId}/members/{identifier}
Chat Emoji
- Read
List custom emojis
Queries the custom emojis list. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat:read:admin`,`chat:read`,`chat:write:admin`,`chat:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:list_custom_emojis`,`team_chat:read:list_custom_emojis:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /chat/emoji - Write
Add a custom emoji
Add a custom emoji. **Note:** * The base URL for this API's is `https://fileapi.zoom.us/v2`. * The rate limit of this API is 20 requests per second per API or 2000 requests per second per IP address. * The caller must support HTTP 30x redirects. * All files are sent as common files except `png`,`jpg`,`jpeg` and `gif` * The caller must retain the authorization header when redirected to a different hostname. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat:write`,`chat:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:write:custom_emoji`,`team_chat:write:custom_emoji:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /chat/emoji/files - Destructive
Delete a custom emoji
Delete a custom emoji by *fileId*. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat:write`,`chat:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:delete:custom_emoji`,`team_chat:delete:custom_emoji:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /chat/emoji/{fileId}
Chat External Connections
- Read
External connections: view external accounts connected to your account.
Use this endpoint to see which external accounts collaborate with your account and review the scale, timing, and policy settings of each relationship. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_chat:read:list_external_connections:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /zoomchat/external_connections/accounts - Read
External connections: view channels for one external account.
Use this endpoint to see which channels and group chats involve a specific external account, how many users on each side are present, and whether the chat is owned by the external side. This endpoint currently merges classic channels and group chats into one list and does not expose `channel_type`. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_chat:read:list_external_connections:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoomchat/external_connections/accounts/{external_account_ref}/channels - Read
External connections: view direct chats for one external account.
Use this endpoint to see which external users from a specific external account have direct-message relationships with users in your account. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_chat:read:list_external_connections:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoomchat/external_connections/accounts/{external_account_ref}/direct_chats - Read
External connections: view external users who collaborate with your account.
Use this endpoint to see which external users are connected to your account, which external account they belong to, and how much collaboration exists through chats and direct messages. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_chat:read:list_external_connections:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /zoomchat/external_connections/external_users - Read
External connections: view channels for one external user.
Use this endpoint to see which channels and group chats a specific external user participates in, who invited them, and whether the chat is owned by the external side. This endpoint currently merges classic channels and group chats into one list and does not expose `channel_type`. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_chat:read:list_external_connections:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /zoomchat/external_connections/external_users/{member_id}/channels - Read
External connections: view direct chats for one external user.
Use this endpoint to see which internal users have direct-message relationships with a specific external user and when those relationships began. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_chat:read:list_external_connections:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /zoomchat/external_connections/external_users/{member_id}/direct_chats - Read
External connections: view internal users who collaborate with external users.
Use this endpoint to see which users in your account have external collaboration activity and how much collaboration each person has across chats and direct messages. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_chat:read:list_external_connections:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /zoomchat/external_connections/internal_users - Read
External connections: view channels for one internal user.
Use this endpoint to see which channels and group chats a specific user in your account participates in for external collaboration, who invited them, and whether the chat is owned by the external side. This endpoint currently merges classic channels and group chats into one list and does not expose `channel_type`. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_chat:read:list_external_connections:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoomchat/external_connections/internal_users/{user_id}/channels - Read
External connections: view direct chats for one internal user.
Use this endpoint to see which external users have direct-message relationships with a specific user in your account and when those relationships began. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_chat:read:list_external_connections:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /zoomchat/external_connections/internal_users/{user_id}/direct_chats
Chat Files
- Read
Get file info
Returns information about the chat file. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:file`,`team_chat:read:file:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /chat/files/{fileId} - Write
Upload a chat file
Uploads a file to chat. **Note:** * The base URL for this API's is `https://file.zoom.us/v2/`. * The rate limit of this API is 20 requests per second per API or 2000 requests per second per IP address. * The caller must support HTTP 30x redirects. * All files are sent as common files except `png`,`jpg`,`jpeg` and `gif` * Zoom Cloud Storage will store the files sent through this API. If you do not use Zoom Cloud Storage, Zoom Cloud will temporarily store these files for 7 days. * The caller must retain the authorization header when redirected to a different hostname. * After upload a file, the default behavior will show the file in personal chat message. For an **account-level** [OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app), this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.) that has the **Edit** permission for **Chat Messages**. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_message:write`,`chat_message:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:write:files`,`team_chat:write:files:admin`
POST /chat/users/{userId}/files - Write
Send a chat file
Sends a file on Zoom to either an individual user in your contact list or a [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) of which you are a member. **Note:** * The base URL for this API is `https://file.zoom.us/v2/`. * The rate limit of this API is 20 requests per second per API or 2000 requests per second per IP address. * The caller must support HTTP 30x redirects. * All files are sent as common files except `png`,`jpg`,`jpeg` and `gif` * Zoom Cloud Storage will store the files sent through this API. If you do not use Zoom Cloud Storage, Zoom Cloud will temporarily store these files for 7 days. * The caller must retain the authorization header when redirected to a different hostname. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. For an [account-level OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app), this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management) that has the **Edit** permission for **Chat Messages**. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_message:write`,`chat_message:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:write:message_files`,`team_chat:write:message_files:admin`
POST /chat/users/{userId}/messages/files - Destructive
Delete a chat file
Deletes a chat file. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:delete:file`,`team_chat:delete:file:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /chat/files/{fileId}
Chat Messages
- Read
List pinned history messages of channel
Returns a list of pinned history messages of channel. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat:read`,`chat:read:admin`,`chat:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:list_pinned_messages` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /chat/channels/{channelId}/pinned - Read
Get a forwarded message
Returns a chat message previously sent to a contact or a channel. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. You must provide one of the following query parameters: * `to_contact` — The email address of the Zoom contact to whom you sent the message. * `to_channel` — The ID of the Zoom channel where you sent the message. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_message:read`,`chat_message:read:admin`,`chat_message:write`,`chat_message:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:user_message`,`team_chat:read:user_message:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /chat/forwarded_message/{forwardId} - Read
List bookmarks
Returns the bookmarks for a given channel, 1:1 conversation, or across all of the sessions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_message:read`,`chat_message:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:list_bookmarks` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /chat/messages/bookmarks - Read
List scheduled messages
Returns a list of scheduled messages. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_message:read`,`chat_message:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:list_scheduled_messages` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /chat/messages/schedule - Read
List user's chat messages
Returns a list of chat messages and shared files between a user and an individual contact, or a chat channel. 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. **Note:** For an [account-level OAuth app](https://developers.zoom.us/docs/integrations/create/), this API can only be used on behalf of a [user assigned to a role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management) with the **Edit** permission for **Chat Messages**. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_message:read`,`chat_message:write`,`chat_message:read:admin`,`chat_message:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:list_user_messages`,`team_chat:read:list_user_messages:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /chat/users/{userId}/messages - Read
Get a message
Returns a chat message previously sent to a contact or a channel. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. You must provide one of the following query parameters: * `to_contact` — The email address of the Zoom contact to whom you sent the message. * `to_channel` — The ID of the Zoom channel where you sent the message. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_message:read`,`chat_message:read:admin`,`chat_message:write`,`chat_message:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:user_message`,`team_chat:read:user_message:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /chat/users/{userId}/messages/{messageId} - Read
Retrieve a thread
Retrieves all messages under a thread. For user-level apps, pass the `me` value instead of the `userId` parameter. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_message:read`,`chat_message:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:thread_message`,`team_chat:read:thread_message:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /chat/users/{userId}/messages/{messageId}/thread - Write
Perform operations on the message of channel
Performs different operations, such as pin or unpin, on the message of channel. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:update:pin_message` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /chat/channel/message/events - Write
Send a chat message
Sends chat messages to a user in your contact list or to a [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) of which you are a member. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. - To send a message to a contact, provide the contact's email address in the `to_contact` field. - To send a message to a channel, provide the channel's ID in the `to_channel` parameter. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_message:write`,`chat_message:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:write:user_message`,`team_chat:write:user_message:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /chat/users/{userId}/messages - Write
Mark message read or unread
Marks a chat message as read or unread. 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:** For an [account-level OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app), this API can only be used on behalf of a [user assigned to a role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management) with the "**Edit**" permission for **Chat Messages**. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_message:write`,`chat_message:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:update:message_status`,`team_chat:update:message_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /chat/users/{userId}/messages/{messageId}/status - Destructive
Add or remove a bookmark
Adds a bookmark to a message or removes the bookmark from a message. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_message:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:update:bookmark` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /chat/messages/bookmarks - Destructive
Delete a scheduled message
Deletes a scheduled message. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_message:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:delete:scheduled_message` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /chat/messages/schedule/{draftId} - Destructive
Update a message
Edits a chat message that you previously sent to either a contact or a channel in Zoom. It provides the ID of the message as the value of the `messageId` parameter. You can get the ID from the [List User's Chat Messages](https://developers.zoom.us/docs/api/rest/reference/chat/methods/#operation/getChatMessages) API. Additionally, as a query parameter, you must provide either the contact's **email address** of the contact or the **Channel ID** of the channel where the message was sent. 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:** For an **account-level** [OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app), you can only use this API on behalf of a user who is assigned with a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.) that has the **Edit** permission for **Chat Messages**. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_message:write`,`chat_message:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:update:user_message`,`team_chat:update:user_message:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PUT /chat/users/{userId}/messages/{messageId} - Destructive
Delete a message
Deletes a chat message previously sent to a contact or a channel. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. For an [account-level OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app), this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management) that has the **Edit** permission for **Chat Messages**. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_message:write`,`chat_message:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:delete:user_message`,`team_chat:delete:user_message:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
DELETE /chat/users/{userId}/messages/{messageId} - Destructive
React to a chat message
Adds or removes an emoji to a chat message. For an **account-level** [OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app), this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.) that has the **Edit** permission for **Chat Messages**. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_message:write`,`chat_message:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:update:message_emoji`,`team_chat:update:message_emoji:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /chat/users/{userId}/messages/{messageId}/emoji_reactions
Chat Migration
- Read
Get migrated Zoom channel IDs
Returns Zoom channel IDs by their corresponding migrated channel IDs. Currently, the API only returns mappings for conversations migrated with the Team Chat Migration app. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_migration:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:migrated_channels:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
GET /chat/migration/mappings/channels - Read
Get migrated Zoom user IDs
Returns Zoom user IDs by their corresponding migrated user IDs. Currently, the API only returns mappings for users migrated with the Team Chat Migration app. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_migration:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:migrated_users:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /chat/migration/mappings/users - Write
Migrate channel members
Adds a maximum of 20 members to a migrated chat channel. **Note**: The use of this endpoint is **locked**. We make it available upon request on a case by case basis. To unlock this endpoint, contact [Zoom Support](https://support.zoom.com/hc/en/contact?id=contact_us). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_migration:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:write:migrate_channel_members:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /chat/migration/channels/{channelId}/members - Write
Migrate a channel tab
Migrate a web link tab to a Zoom Team Chat channel. Adds a web link as a tab to a migrated Zoom Team Chat channel, for example, an existing document from a productivity suite. **Requirements** * The target channel must already exist in the same account as a migrated channel. * The caller must be an owner or administrator of the target channel. **Usage** Provide the target channel ID and a display name for the tab. Zoom automatically generates the channel tab ID and handles all required migration fields. **Limitations** * Supports web link tabs only. * Does not create or configure permissions for productivity suite documents or Zoom Canvas. **Access** This endpoint is locked by default and available upon request. To enable it for your account, contact [Zoom Support](https://support.zoom.com/hc/en/contact?id=contact_us). **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:write:migrate_channel_tab:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /chat/migration/channels/{channelId}/tabs - Write
Migrate chat message reactions
Adds emoji reactions to a migrated chat message. **Note**: The use of this endpoint is **locked**. We make it available upon request on a case by case basis. To unlock this endpoint, contact [Zoom Support](https://support.zoom.com/hc/en/contact?id=contact_us). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_migration:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:write:migrate_chat_message_reactions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /chat/migration/emoji_reactions - Write
Migrate chat messages
Adds a maximum of 20 messages to migrated 1:1 conversations or channels. **Note**: The use of this endpoint is **locked**. We make it available upon request on a case by case basis. To unlock this endpoint, contact [Zoom Support](https://support.zoom.com/hc/en/contact?id=contact_us). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_migration:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:write:migrate_chat_messages:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /chat/migration/messages - Write
Migrate a chat channel
Migrates a chat channel. **Note**: The use of this endpoint is **locked**. We make it available upon request on a case by case basis. To unlock this endpoint, contact [Zoom Support](https://support.zoom.com/hc/en/contact?id=contact_us). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_migration:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:write:migrate_a_chat_channel:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /chat/migration/users/{identifier}/channels - Write
Migrate 1:1 conversation or channel operations
Performs operations on migrated 1:1 conversations or channels. For now, the only supported operation is to star 1:1 conversations or channels. **Note**: By default, the use of this endpoint is **locked**. We make it available upon request on a case by case basis. To unlock this endpoint, contact [Zoom Support](https://support.zoom.com/hc/en/contact?id=contact_us). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_migration:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /chat/migration/users/{identifier}/events - Destructive
Delete a channel tab
Remove a web link tab from a Zoom Team Chat channel. Removes a web link tab from a migrated Zoom Team Chat channel — for example, a previously added document from a productivity suite. Requirements - The target channel must already exist in the same account as a migrated channel. - The caller must be an owner or administrator of the target channel. Usage Provide the target channel ID and the tab_id of the tab to remove. The tab_id is the identifier Zoom returned when the tab was added. On success, the endpoint returns 204 No Content with an empty response body. Limitations - Supports web link tabs only. - Does not remove or modify the underlying productivity suite document or Zoom Canvas — only the channel tab reference is removed. Access This endpoint is locked by default and available upon request. To enable it for your account, contact [Zoom Support](https://support.zoom.com/hc/en/contact?id=contact_us). **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:delete:channel_tab:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /chat/migration/channels/{channelId}/tabs
Chat Reminder
- Read
List reminders
Returns a list reminders for a person or a chat channel. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_message:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:list_reminders` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /chat/reminder - Write
Create a reminder message
Creates a reminder for a person or a chat channel. You must provide one of the following query parameters: `to_contact` — The email address of the Zoom contact to whom you want to set the reminder. `to_channel` — The ID of the Zoom channel where you set the reminder. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_message:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:write:reminder` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /chat/messages/{messageId}/reminder - Destructive
Delete a reminder for a message
Deletes a reminder. You must provide one of the following query parameters: - `to_contact` — The email address of the Zoom contact that you want to delete the reminder. - `to_channel` — The ID of the Zoom channel where you want to delete the reminder. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_message:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:delete:reminder` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /chat/messages/{messageId}/reminder
Chat Sessions
- Read
List a user's chat sessions
Retrieves a user's chat sessions. 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:** For an **account-level** [OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app), you can only use this API on behalf of a user who is assigned a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.) that has the **View** or **Edit** permission for **Chat Messages**. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_message:read`,`chat_message:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:list_user_sessions`,`team_chat:read:list_user_sessions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /chat/users/{userId}/sessions - Write
Star or unstar a channel or contact user
Stars or unstars a contact or channel 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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_event:write:admin`,`chat_event:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:update:chat_control`,`team_chat:update:chat_control:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /chat/users/{userId}/events
Contacts
- Read
List user's contacts
Lists all the contacts of a Zoom user. Zoom categorizes contacts into **company contacts** and **external contacts**. You must specify the contact type in the `type` query parameter. If you do not specify, by default, the type is set as company contact. A user under an organization's Zoom account has internal users listed under **company contacts** in the Zoom Client. A Zoom user can also add another Zoom user as a [contact](https://support.zoom.us/hc/en-us/articles/115004055706-Managing-Contacts). **Note:** This API only supports **user-managed** [OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_contact:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:list_contacts` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /chat/users/me/contacts - Read
Get user's contact details
Returns information on a specific contact of the Zoom user. A user under an organization's Zoom account has internal users listed under Company Contacts in the Zoom Client. A Zoom user can also add another Zoom user as a [contact](https://support.zoom.us/hc/en-us/articles/115004055706-Managing-Contacts). **Note:** This API only supports **user-managed** [OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_contact:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:contact` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /chat/users/me/contacts/{identifier} - Read
Search company contacts
Searches for users that are in the company contacts of a Zoom account. A user under an organization's Zoom account has internal users listed under Company Contacts in the Zoom Client. When using the `search_key` query parameter, provide either the first name, last name, or the email address of the user that you would like to search. Optionally, set `query_presence_status` to `true` to include the presence status of a contact. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact:read:admin`,`contact:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact:read:list_contacts`,`contact:read:list_contacts:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contacts - Write
Create a user-managed contact
Create a private contact for the target user. If `user_id` is `me` or matches the token user, the caller creates a contact for themselves. If `user_id` is another user, the caller must be an account-level OAuth app, and the target user must belong to the same account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `personal_contacts:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_chat:write:personal_contact`,`zoom_chat:write:personal_contact:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
POST /contacts/user/{user_id}/personal - Write
Update a user-managed contact
Update a private contact for the target user using the contact ID. The `contact_id` is the encrypted ID returned during creation. The server decrypts it, verifies that the contact type is personal, and then updates only the provided fields. Omitted or null fields retain their stored values. If the `user_id` is `me` or matches the token user, the caller updates their own contact. Specifying another user's ID requires an account-level OAuth token, and the target user must belong to the same account. The contact must belong to that target user. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `personal_contacts:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_chat:update:personal_contact`,`zoom_chat:update:personal_contact:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
PATCH /contacts/user/{user_id}/personal/{contact_id} - Destructive
Delete a user-managed contact
Delete an existing private contact for the target user. The `contact_id` is the encrypted ID returned during creation. The server decrypts it, verifies that the contact type is personal, confirms the contact exists and is owned by the target user, then deletes it. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `personal_contacts:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_chat:delete:personal_contact`,`zoom_chat:delete:personal_contact:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
DELETE /contacts/user/{user_id}/personal/{contact_id}
IM Chat
- Write
Send IM messages
Sends the chat message to a user. **Note:** This API only supports OAuth 2.0. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `imchat:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /im/users/me/chat/messages
IM Groups
- Read
List IM directory groups
Lists [IM directory groups](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `imgroup:read:admin`,`imgroup:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_group:read:list_groups:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /im/groups - Read
Retrieve an IM directory group
Retrieves an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account. Scopes: `imgroup:read:admin` **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `imgroup:read:admin`,`imgroup:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_group:read:group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /im/groups/{groupId} - Read
List IM directory group members
Lists the members of an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `imgroup:read:admin`,`imgroup:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_group:read:list_members:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /im/groups/{groupId}/members - Write
Create an IM directory group
Create an IM directory group under your account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `imgroup:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_group:write:group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
POST /im/groups - Write
Update an IM directory group
Updates an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `imgroup:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_group:update:group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /im/groups/{groupId} - Write
Add IM directory group members
Add members to an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under an account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `imgroup:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_group:write:member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /im/groups/{groupId}/members - Destructive
Delete an IM directory group
Deletes an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account. Scopes: `imgroup:write:admin` **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `imgroup:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_group:delete:group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /im/groups/{groupId} - Destructive
Delete IM directory group member
Delete a member from an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under an account. Scopes: `imgroup:write:admin` **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `imgroup:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_group:delete:member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /im/groups/{groupId}/members/{memberId}
Invitations
- Write
Send new contact invitation
Sends a new contact invitation. For user-level apps, pass the `me` value instead of the `userId` parameter. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_contact:write`,`chat_contact:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:write:contact_information:admin`,`team_chat:write:contact_information` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /chat/users/{userId}/invitations
Legal Hold
- Read
List legal hold matters
Returns a list of legal hold matters. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_history_legal_hold:read:admin`,`chat_history_legal_hold:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:list_legal_hold_matters:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `RESOURCE-INTENSIVE`
GET /chat/legalhold/matters - Read
List legal hold files by given matter
Returns a list files for given legal hold matter. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_history_legal_hold:read:admin`,`chat_history_legal_hold:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:list_legal_hold_matter_files:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /chat/legalhold/matters/{matterId}/files - Read
Download legal hold files for given matter
Downloads a zip file. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_history_legal_hold:read:admin`,`chat_history_legal_hold:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:read:legal_hold_matter_file:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /chat/legalhold/matters/{matterId}/files/download - Write
Add a legal hold matter
Adds a new legal hold matter. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_history_legal_hold:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:write:legal_hold_matter:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `RESOURCE-INTENSIVE`
POST /chat/legalhold/matters - Write
Update legal hold matter
Updates the name for a given legal hold matter. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_history_legal_hold:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:update:legal_hold_matter:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /chat/legalhold/matters/{matterId} - Destructive
Delete legal hold matters
Deletes a legal hold matter. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat_history_legal_hold:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:delete:legal_hold_matter:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /chat/legalhold/matters/{matterId}
Reports
- Read
Get chat sessions reports
Returns Zoom Chat session reports for a specified period of time. The monthly date range **must** be within the last six months. **Prerequisites** * A Pro or higher plan * Report chat permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report_chat:read:admin`,`imchat:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:list_chat_sessions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /report/chat/sessions - Read
Get chat message reports
Returns Zoom Chat message reports for a specified period of time. The monthly date range must be within the last six months. **Prerequisites** * A Pro or higher plan * Report chat permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report_chat:read:admin`,`imchat:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:chat_session:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /report/chat/sessions/{sessionId} - Read
Get chat transcripts report
Retrieves the chat transcripts report for an event. At present, this API returns data only for users who have enabled the [meeting and webinar cloud archiving feature](https://support.zoom.us/hc/en-us/articles/360061037572-Configuring-archival-settings-for-meetings-and-webinars). The meeting and webinar cloud archiving feature determines whether users can download in-meeting, private 1:1, and private group chats. Below, chat-type data is returned based on the event type and the archiving feature. * `If cloud archiving is enabled`: **For multi-session events** - Lobby Chat, Private Lobby Chat, Event Staff Chat, Exhibitor Chat, Expo Booth Chat, Private 1: 1 Chat, Private Group Chat, In-meeting and webinar Chat . **For single session & recurring events** - In-meeting or webinar chat. * `If cloud archiving is not enabled` : **For multi-session events** - Lobby Chat, Private Lobby Chat, Event Staff Chat, Exhibitor Chat, Expo Booth Chat. **For single session & recurring events** - None. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_reports:read`,`zoom_events_reports:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:chat_transcripts`,`zoom_events:read:chat_transcripts:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /zoom_events/events/{eventId}/reports/chat_transcripts - Read
Get custom report
Retrieves data for the custom report for the given report ID. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_reports:read`,`zoom_events_reports:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:custom_report`,`zoom_events:read:custom_report:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /zoom_events/events/{eventId}/reports/custom_reports/{customReportId} - Read
Get event attendance (Live or Lobby) report
Retrieves the event attendance (live or lobby) report for the event. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_reports:read`,`zoom_events_reports:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:event_attendance`,`zoom_events:read:event_attendance:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /zoom_events/events/{eventId}/reports/event_attendance - Read
Get session attendance report
Retrieves a session attendance report. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_reports:read`,`zoom_events_reports:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:session_attendance`,`zoom_events:read:session_attendance:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId}/reports/sessions/{sessionId}/attendance - Read
Get event survey report
Retrieve event and session survey information. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_reports:read`,`zoom_events_reports:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_session_surveys`,`zoom_events:read:list_session_surveys:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /zoom_events/events/{eventId}/reports/survey - Read
Get event registrations report
Retrieves event ticket registrations. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_reports:read`,`zoom_events_reports:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:event_registration`,`zoom_events:read:event_registration:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /zoom_events/events/{eventId}/reports/ticket_registration - Read
Get VOD channel registration report
Retrieves VOD channel registrations and view duration information. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_reports:read`,`zoom_events_vod_reports:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:vod_registrations`,`zoom_events:read:vod_registrations:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /zoom_events/hubs/{hubId}/vod_channels/{channelId}/reports/registrations - Read
Get sign In / sign out activity report
Retrieve a list of sign in / sign out activity logs [report](https://support.zoom.us/hc/en-us/articles/201363213-Getting-Started-with-Reports) of users under a Zoom account. **Prerequisites** * Pro or higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:user_activities:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
GET /report/activities - Read
Get billing reports
Get department billing reports of a Zoom account. **Prerequisites:** * Pro or a higher account with Department Billing option enabled. Contact Zoom Support team for details. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:billing:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
GET /report/billing - Read
Get billing invoice reports
Get department billing invoices reports for a specific billing period. Provide the `billing_id` of the billing period for which you would like to retrieve the invoices. Retrieve this ID from the **Get Billing Reports** API. **Prerequisites:** * Pro or a higher account with Department Billing option enabled. Contact the Zoom Support team to enable this feature. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:billing_invoice:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /report/billing/invoices - Read
Get cloud recording usage report
Retrieve cloud recording usage report for a specified period. You can only get cloud recording reports that is one day earlier than the current date and for the most recent period of 6 months. The date gap between from and to dates should be smaller or equal to 30 days. **Prerequisites** * Pro or higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
GET /report/cloud_recording - Read
Get daily usage report
Retrieve daily report to access the account-wide usage of Zoom services for each day in a given month. It lists the number of new users, meetings, participants, and meeting minutes. **Prerequisites** * Pro or higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /report/daily - Read
Get disclaimer report
Retrieve a list of disclaimer records. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:disclaimer:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /report/disclaimer - Read
Get history meeting and webinar list
Retrieve a list of history meetings and webinars. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:list_history_meetings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /report/history_meetings - Read
Get a meeting activities report
Retrieve a list of a meeting activity logs. Contact Zoom Support to enable the meeting audit trail log feature on your account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:meeting_activity_log:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /report/meeting_activities - Read
Get meeting detail reports
Get a detailed report for a past meeting. **Prerequisites** * Pro or a higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:meeting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /report/meetings/{meetingId} - Read
Get meeting participant reports
Return a report of a past meeting with two or more participants, including the host. To return a report for past meeting with only **one** participant, use the [**List meeting participants**](/docs/api/accounts/#tag/dashboards/GET/metrics/meetings/{meetingId}/participants) API. **Note:** This API may return empty values for participants' `user_name`, `ip_address`, `location`, and `email` responses when the account calling this API: * Is a [**legacy** HIPAA BAA account](/docs/api/references/legacy-business-associate-agreements/). **Prerequisites:** * A Pro or a higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:list_meeting_participants:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /report/meetings/{meetingId}/participants - Read
Get meeting poll reports
Use this API to get a report of [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) results for a past meeting. **Prerequisites:** * A Pro or a higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:list_meeting_polls:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
GET /report/meetings/{meetingId}/polls - Read
Get meeting Q&A report
Retrieve a report on questions asked and answered by participants from past meetings. **Prerequisites:** * Pro plan or higher. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:meeting_qna:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /report/meetings/{meetingId}/qa - Read
Get meeting survey report
Retrieve a report on past [meeting survey](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057559). **Prerequisites:** * Pro or a higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:meeting_survey:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /report/meetings/{meetingId}/survey - Read
Get operation logs report
The [Operations Logs](https://support.zoom.us/hc/en-us/articles/360032748331-Operation-Logs) report allows you to audit admin and user activity, such as adding a new user, changing account settings, and deleting recordings. Use this API to retrieve operation logs report for a specified period of time. **Prerequisites:** * Pro or higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:operation_logs:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /report/operationlogs - Read
Get remote support report
Retrieve a list of remote support records. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:remote_support:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /report/remote_support - Read
Get telephone reports
The [telephone report](https://support.zoom.us/hc/en-us/articles/206514816-Telephone-reports) allows you to view who dialed into meetings via phone (Audio Conferencing or SIP Connected Audio) and which number they dialed into and other details. Use this API to get telephone report for a specified period of time. **Prerequisites:** * Pro or higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:telephone:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /report/telephone - Read
Get upcoming events report
Use this API to list upcoming meeting and/or webinar events within a specified period of time. The report's time range is limited to one month. **Prerequisites:** * A Pro or higher plan **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:upcoming_meetings_webinars:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
GET /report/upcoming_events - Read
Get active or inactive host reports
Retrieve a host report for a specified period of time within the last six months. The report time range is limited to a month. You can specify the type of report and date range using the query parameters. * The **Active Hosts** report displays a list of meetings, participants, and meeting minutes. An **active host** is defined as any user who has hosted at least one meeting during the during the month specified in the `from` and `to` range. * The **Inactive Hosts** report pulls a list of users who were not active during a specific period of time. An **inactive host** is defined as any user who has not hosted any meetings during the specified period of time for the report. to be inactive. **Prerequisites:** * Pro or higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:list_users:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /report/users - Read
Get meeting reports
Retrieve [report](https://support.zoom.us/hc/en-us/articles/216378603-Meeting-Reporting) on past meetings and webinars for a specified time period. The time range for the report is limited to a month and the month must fall within the past six months. Meetings and webinars are returned only if they have two or more unique participants. **Prerequisites:** * Pro or higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:user:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /report/users/{userId}/meetings - Read
Get webinar detail reports
Retrieve a [report](https://support.zoom.us/hc/en-us/articles/201393719-Webinar-Reporting) containing past webinar details. **Prerequisites:** * Pro or higher plan with Webinar add-on. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:webinar:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
GET /report/webinars/{webinarId} - Read
Get webinar participant reports
Get a detailed report on each webinar attendee. You can get webinar participant reports for the last 6 months. **Prerequisites:** * A Pro or a higher plan with Webinar add-on enabled. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:list_webinar_participants:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /report/webinars/{webinarId}/participants - Read
Get webinar poll reports
Retrieve a report on past [webinar polls](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars). **Prerequisites:** * Pro or a higher plan with Webinar add-on enabled. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:list_webinar_polls:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
GET /report/webinars/{webinarId}/polls - Read
Get webinar Q&A report
Retrieve a report on questions asked by participants and answered by panelists, co-hosts and hosts from past webinars. **Prerequisites:** * Pro or a higher plan with the Webinar add-on enabled. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:webinar_qna:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /report/webinars/{webinarId}/qa - Read
Get webinar survey report
Retrieve a report on past [webinar survey](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057559). **Prerequisites:** * Pro or a higher plan with Webinar add-on enabled. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:webinar_survey:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /report/webinars/{webinarId}/survey - Read
Get call charges usage report
Retrieves the Phone Call Charges Report. The Call charges usage report allows account owners and admins to view monthly Zoom phone call charges. Account owners and admins can also access this information when they log into their Zoom accounts and navigate to [Call Charges Usage Report](https://zoom.us/pbx/page/report/system#/report/phone-system/charge?page_size=15&chargeRestrict=0&by=1). **Prerequisites:** * Account must be enrollled in Pro or a higher plan * Account must be enrolled in a [Zoom Phone](https://zoom.us/pricing/zoom-phone) plan **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_charges:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /phone/reports/call_charges - Read
Get fax charges usage report
Retrieves the Phone Fax Charges Report. The fax charges usage report allows account owners and admins to view monthly Zoom phone fax charges. Account owners and admins can also access this information when they log into their Zoom accounts and navigate to [Fax Charges Usage Report](https://zoom.us/pbx/page/report/system#/report/phone-system/charge?page_size=15&by=3). **Prerequisites** * Account must be enrollled in Pro or a higher plan * Account must be enrolled in a [Zoom Phone](https://zoom.us/pricing/zoom-phone) plan **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:fax_charges:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /phone/reports/fax_charges - Read
Get operation logs report
Retrieves the phone system operation logs report. The phone system operation logs report allows account owners and admins to view monthly Zoom phone related admin operation details. Account owners and admins can also access this information by logging into their Zoom accounts and navigating to [Phone System Operation Logs](https://zoom.us/pbx/page/report/operations#/report/operation-logs). **Prerequisites:** * Account must be enrollled in Pro or a higher plan * Account must be enrolled in a [Zoom Phone](https://zoom.us/pricing/zoom-phone) plan **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:operation_logs:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /phone/reports/operationlogs - Read
Get SMS/MMS charges usage report
Retrieves the **SMS/MMS Charges Report**. The **SMS/MMS charges usage report** allows account owners and admins to view monthly Zoom phone SMS charges. Account owners and admins can also access this information by when they log into their Zoom accounts and navigate to [ SMS/MMS Charges Usage Report](https://zoom.us/pbx/page/report/system#/report/phone-system/charge?page_size=15&chargeRestrict=0&by=2). **Prerequisites** * Account must be enrolled in Pro or a higher plan * Account must be enrolled in a [Zoom Phone](https://zoom.us/pricing/zoom-phone) plan **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:sms_charges:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /phone/reports/sms_charges - Read
List agents' adherence data
Get agents' adherence data. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:read:list_adherence_agents:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /workforce-management/reports/adherence/agents - Read
List all schedule agents
List all the schedule agents for the particular date and timezone **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:read:list_schedule_agents:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /workforce-management/reports/schedules/agents
Shared Spaces
- Write
Create a shared space
Creates a shared space. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat:write`,`chat:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:write:shared_space`,`team_chat:write:shared_space:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `RESOURCE-INTENSIVE`
POST /chat/spaces - Write
Promote shared space members to administrators
Promotes shared space members to administrators. **Note:** This API supports account-level apps. The user calling this API must have a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management) that has the **Edit** permission for the **Chat Channels** feature. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat:write`,`chat:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:write:shared_space_administrators`,`team_chat:write:shared_space_administrators:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /chat/spaces/{spaceId}/admins - Write
Add members to a shared space
Adds members to a shared space. **Note:** This API supports account-level apps. The user calling this API must have a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management) that has the **Edit** permission for the **Chat Channels** feature. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat:write`,`chat:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:write:shared_space_members`,`team_chat:write:shared_space_members:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /chat/spaces/{spaceId}/members - Write
Transfer shared space ownership
Transfers shared space ownership to a member or administrator. **Note:** This API supports account-level apps. The user calling this API must have a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management) that has the **Edit** permission for the **Chat Channels** feature. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat:write`,`chat:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:update:shared_space_owner`,`team_chat:update:shared_space_owner:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /chat/spaces/{spaceId}/owner - Destructive
Delete a shared space
Deletes a shared space. This API endpoint works for user-level and account-level apps. **Note:** For user-level apps, the user calling this API must be the shared space owner. **Note:** For account-level apps, the user calling this API must have a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management) that has the **Edit** permission for the **Chat Channels** feature. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat:write`,`chat:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:delete:shared_space`,`team_chat:delete:shared_space:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `RESOURCE-INTENSIVE`
DELETE /chat/spaces/{spaceId} - Destructive
Demote shared space administrators to members
Demotes shared space administrators to members. **Note:** This API supports account-level apps. The user calling this API must have a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management) that has the **Edit** permission for the **Chat Channels** feature. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat:write`,`chat:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:delete:shared_space_administrators`,`team_chat:delete:shared_space_administrators:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /chat/spaces/{spaceId}/admins - Destructive
Remove members from a shared space
Removes members from a shared space. **Note:** This API supports account-level apps. The user calling this API must have a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management) that has the **Edit** permission for the **Chat Channels** feature. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `chat:write`,`chat:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `team_chat:delete:shared_space_members`,`team_chat:delete:shared_space_members:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /chat/spaces/{spaceId}/members
Chatbot Messages
- Write
Send Chatbot messages
Sends messages from your Marketplace Chatbot app. **Authorization Flow:** Client Credentials Flow To authorize, make a POST request to the `/oauth/token` endpoint with the `client_credentials` grant type. Use the `https://api.zoom.us/oauth/token?grant_type=client_credentials` endpoint for the request. You will need to send your Client ID and Secret as a Basic Base64-encoded authorization header (for example, `Basic base64Encode({client_id}:{client_secret}`). Then, use the received `access_token` value as a Bearer token when you make the GET `/im/chat/users/{user_id}/messages/{message_id}` request. For more information about authorizing Chatbots, read the Chatbot [**Installation and Authentication**](https://developers.zoom.us/docs/team-chat-apps/installation-and-authentication/) documentation. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `imchat:bot` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /im/chat/messages - Write
Link Unfurls
Unfurls a link with your Marketplace Chat app. **Authorization Flow:** The client credentials flow authorizes and makes a POST request to the `/oauth/token` endpoint with the `client_credentials` grant type. - Use the `https://api.zoom.us/oauth/token?grant_type=client_credentials` endpoint for the request. - You must send your client ID and secret as a basic Base64-encoded authorization header. (For example, `Basic base64Encode({client_id}:{client_secret}`). - Use the received `access_token` value as a Bearer token when you make the GET `/im/chat/users/{user_id}/messages/{message_id}` request. For more information about authorizing Chatbots, see the Chatbot [**Authorization and installation**](https://developers.zoom.us/docs/team-chat-apps/installation-and-authentication/) documentation. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `imchat:bot` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /im/chat/users/{userId}/unfurls/{triggerId} - Destructive
Edit a Chatbot message
Use this API to edit a message [sent](/api-reference/chatbot/methods#operation/sendChatbot) by your Chatbot app. After sending a message via the [**Send Chatbot message**](/api-reference/chatbot/methods#operation/sendChatbot) API, you must store the `messageId` value returned in the API response in order to make edits to the associated message using this API. **Authorization Flow:** Client Credentials Flow To authorize, make a POST request to the `/oauth/token` endpoint with the `client_credentials` grant type. Use the `https://api.zoom.us/oauth/token?grant_type=client_credentials` endpoint for the request. You will need to send your Client ID and Secret as a Basic Base64-encoded authorization header (for example, `Basic base64Encode({client_id}:{client_secret})`). Then, use the received `access_token` value as a Bearer token when you make the GET `/im/chat/users/{user_id}/messages/{message_id}` request. For more information about authorizing chatbots, see the [**Authorize**](https://developers.zoom.us/docs/chat/installation-and-authentication/) documentation. **JSON payloads for guest users**: Be aware that guest users (users not signed in to Zoom or who are members of a different account) are assigned temporary IDs that are valid only for the duration of that meeting or chat channel. Data for guest users in JSON payloads is associated with these temporary IDs. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `imchat:bot` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PUT /im/chat/messages/{message_id} - Destructive
Delete a Chatbot message
Deletes a message from your Chatbot app. **Authorization Flow:** Client Credentials Flow To authorize, make a POST request to the `/oauth/token` endpoint with the `client_credentials` grant type. Use the `https://api.zoom.us/oauth/token?grant_type=client_credentials` endpoint for the request. You will need to send your Client ID and Secret as a Basic Base64-encoded authorization header (for example, `Basic base64Encode({client_id}:{client_secret}`). Then, use the received `access_token` value as a Bearer token when you make the GET `/im/chat/users/{user_id}/messages/{message_id}` request. For more information about authorizing Chatbots, read the Chatbot [Authentication**](https://developers.zoom.us/docs/team-chat-apps/installation-and-authentication/) documentation. **JSON payloads for guest users**: Be aware that guest users (users not signed in to Zoom or who are members of a different account) are assigned temporary IDs that are valid only for the duration of that meeting or chat channel. Data for guest users in JSON payloads is associated with these temporary IDs. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `imchat:bot` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /im/chat/messages/{message_id}
Clips
- Read
List all clips
Returns a list of clips of the current user or a list of all clips under the account. **Required scopes** `clips:read:list_user_clips:admin)` **Note** `user_id` can intake Zoom user ID or email, which only applies when `scope = clips:read:list_user_clips:admin` or `scope=clips:read:list_user_clips:master`. Otherwise, the `user_id` can only intake `me`. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:read`,`clips:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:read:list_user_clips`,`clips:read:list_user_clips:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /clips - Read
Get collaborators of a clip
Returns the list of collaborators for a clip that the current user owns or returns the list of collaborators for any clip associated with the account. **Required scopes** `clips:read:list_collaborator:admin` **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:read`,`clips:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:read:list_collaborator`,`clips:read:list_collaborator:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /clips/{clipId}/collaborators - Write
Batch star clips
Stars or unstars multiple clips in one request. Star requests require the caller to have permission to watch every target clip. Unstar requests do not require view authorization. The operation is all-or-nothing: if request validation, required authorization, or the update fails for any clip, no partial success response is returned. Only an admin can request to star clips on behalf of a user in the same account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:read`,`clips:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:write:star_clips`,`clips:write:star_clips:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
POST /clips/starred
Download
- Read
Download a clip
Retrieves the download URL for a specific clip and redirects the client to that URL. This endpoint performs a HTTP 302 redirect to the actual download location, allowing the client to download the clip mp4 file directly. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:read`,`clips:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:read:download_clip`,`clips:read:download_clip:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /clips/{clipId}/download
Single
- Read
Get a clip
Returns a clip from the current user, or returns any clips associated with the account. **Required scopes**: `clips:read:clip:admin`. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:read`,`clips:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:read:clip`,`clips:read:clip:admin`
GET /clips/{clipId} - Read
Get Clip Chapters
Get the complete chapter list and chapter generation status for a clip. If the clip has no chapters, this returns an empty chapters array instead of an error. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:read`,`clips:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:read:chapters`,`clips:read:chapters:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /clips/{clipId}/chapters - Write
Update a clip's basic info
Updates clips basic info by clip's Id, now support update title/description/tags **Required scopes**: `clips:write:clip:admin`. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:write`,`clips:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:update:clip`,`clips:update:clip:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /clips/{clipId} - Write
Duplicate Clips
Duplicate a clip. Only the clip owner can duplicate their clips. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:write:admin`,`clips:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:write:duplicate` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /clips/{clipId}/duplicate - Destructive
Delete a clip(soft delete)
Deletes a clip. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:write`,`clips:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:delete:clip`,`clips:delete:clip:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /clips/{clipId} - Destructive
Create Clip Chapters
Create or replace all chapters for a clip. The request body must include the complete chapter list. Existing chapters will be replaced by the submitted list. This API does not support appending chapters. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:read`,`clips:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:write:chapters`,`clips:write:chapters:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
POST /clips/{clipId}/chapters
Transfer
- Read
Transfer task status check
Transfers the task status check. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:read:transfer_task_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /clips/transfers/{taskId} - Write
Transfer clips owner
Transfers clip ownership to another user. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:write:transfer_owner:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /clips/transfers
Upload
- Write
Upload clip file
Uploads a video file to create a Zoom Clip. **Note:** * Base URL: `https://fileapi.zoom.us/v2/`. * The rate limit is 20 requests per second or 2,000 requests per second per IP address or 50 requests per user within a 24-hour period. * The caller must support HTTP 30x redirects. * The caller must retain the Authorization header when redirected to a different hostname. * Supported video formats: `.mp4`, `.webm`. * When your object size reaches 2 GB, you should use multipart uploads instead of uploading the object in a single operation. * For an **account-level** [OAuth app](https://developers.zoom.us/docs/integrations/create/), this API can only be used on behalf of a user who is assigned a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.) with **Edit** permission for **Zoom Clips**. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:write`,`clips:write:admin`
POST /clips/files - Write
Upload clip multipart files
Uploads a multipart file to create a Zoom Clip. **Note:** * The base URL for this API is `https://fileapi.zoom.us/v2/`. * The rate limit of this API is 20 requests per second or 2,000 requests per second per IP address, or 50 requests per user within a 24-hour period. * The caller must support HTTP 30x redirects. * The caller must retain the authorization header when redirected to a different hostname. * Video can be in `.mp4` or `.webm` format. * In general, when your object size reaches 2 GB, you should use multipart uploads instead of uploading the object in a single operation. * For an **account-level** [OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app), this API can only be used on behalf of a user who is assigned a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.) that has the **Edit** permission for **Zoom Clips**. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:write`,`clips:write:admin`
POST /clips/files/multipart - Write
Initiate and complete the multipart file upload for a clip
Initiates or completes a multipart upload. **Note:** * The base URL for this API is `https://fileapi.zoom.us/v2/`. * The rate limit is 20 requests per second or 2000 requests per second per IP address or 50 requests per user within a 24-hour period * The caller must support HTTP 30x redirects. * The caller must retain the authorization header when redirected to a different hostname. * Once initiated, the multipart upload must complete within 7 days. * For **account-level** [OAuth apps](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app), this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.) with **Edit** permission for **Zoom Clips**. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:write:admin`,`clips:write`
POST /clips/files/multipart/upload_events - Write
Temporary file upload API for Clips
Uploads temporary files for Clips. **Note** * Base URL: `https://fileapi.zoom.us/v2/`. * The rate limit is 20 requests per second or 2,000 requests per second per IP address or 50 requests per user within a 24-hour period. * The caller must support HTTP 30x redirects. * The caller must retain the Authorization header when redirected to a different hostname. * Supported file formats: `.PNG`, `.JPEG`, `.GIF`, `.JPG`. * The image file (including `.PNG`, `.JPEG`, `.GIF`, `.JPG`) maximum size must be less than 2 MB. * All files' TTL is 72 hours. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:write`,`clips:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clips:write:uploadTempFile`,`clips:write:uploadTempFile:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /clips/files/tmp
Sessions
- Read
List live sessions
List the total live sessions that occurred during a specified period of time. You can specify a monthly date range for this data using the `from` and `to` query parameters. The month should fall within the last six months. The report only includes one month's worth of data. **Prerequisites:** * Cobrowse SDK **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cobrowse_sdk:read:list_live_sessions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /cobrowsesdk/live_sessions - Read
List past sessions
List the total live or past sessions that occurred during a specified period of time. You can specify a monthly date range for this data using the `from` and `to` query parameters. The month should fall within the last six months. The report only includes one month's worth of data. **Prerequisites**: * Cobrowse SDK **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cobrowse_sdk:read:list_past_sessions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `RESOURCE-INTENSIVE`
GET /cobrowsesdk/past_sessions - Read
Get session details
Get information about live or past Cobrowse sessions. **Prerequisites:** * Cobrowse SDK. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cobrowse_sdk:read:session_details:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /cobrowsesdk/sessions/{sessionId} - Read
List session users
List the users from live or past sessions. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cobrowse_sdk:read:list_session_users:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /cobrowsesdk/sessions/{sessionId}/users - Read
List sessions
Retrieves the sessions in an event. Event hosts and special-role ticket users, such as speakers and co-hosts, can access this API. Users will not need to provide any special query parameters. The API internally identifies based on the user role and provides the session information for the event. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:read`,`zoom_events_sessions:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_sessions`,`zoom_events:read:list_sessions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId}/sessions - Read
Get the session information
Returns the session information. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:read`,`zoom_events_sessions:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:session`,`zoom_events:read:session:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId}/sessions/{sessionId} - Read
List session interpreters
Retrieves interpreters in a session. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus /Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:read`,`zoom_events_sessions:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_session_interpreters`,`zoom_events:read:list_session_interpreters:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId}/sessions/{sessionId}/interpreters - Read
Get ticket session join token by Event ID and Session ID
Retrieves the join token to join an event session. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:read`,`zoom_events_sessions:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:session_token`,`zoom_events:read:session_token:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId}/sessions/{sessionId}/join_token - Read
Get session livestream configuration
List the livestream configuration for the given session. RTMP Incoming livestream will only work for webinar sessions (not meetings). Please check [RTMP livesteam](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0077038) for the feature details. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:read`,`zoom_events_sessions:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:session_livestream_config`,`zoom_events:read:session_livestream_config:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId}/sessions/{sessionId}/livestream - Read
List session polls
List all the polls of a session. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:read`,`zoom_events_sessions:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_session_polls`,`zoom_events:read:list_session_polls:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId}/sessions/{sessionId}/polls - Read
List session reservations
Retrieves the list of reservations made by registrants for the session. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:read`,`zoom_events_sessions:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_session_reservations`,`zoom_events:read:list_session_reservations:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId}/sessions/{sessionId}/reservations - Read
List sessions
List the total live or past sessions that occurred during a specified period of time. You can specify a monthly date range for this data using the `from` and `to` query parameters. The month should fall within the last six months. The report only includes one month's worth of data. The response displays whether features such as audio, video, screen sharing, and recording were used during the session. **Prerequisites:** * A Video SDK account **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:read:session_list:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `RESOURCE-INTENSIVE`
GET /videosdk/sessions - Read
Get session details
Get information about scheduled, live, or past sessions. The overview response displays whether features such as audio, video, screen sharing, and recording were used during the session. **Prerequisites:** * A Video SDK account **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:read:session_detail:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /videosdk/sessions/{sessionId} - Read
Get session live stream details
Use this API to return a session's live stream configuration details, such as the stream's URL, key, and page URL. **Prerequisites:** * A Video SDK account **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:read:session_livestream:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /videosdk/sessions/{sessionId}/livestream - Read
Get a session SIP URI with passcode
Get a live video SDK session's SIP URI. The URI consists of the Video session ID, and may include the 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. **Prerequisites**: * The SIP URI is valid for 2 hours, or 7200 seconds, by default. After this period, the URI will expire and the API must be called again to retrieve a new one. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:write:session_sip_dialing:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /videosdk/sessions/{sessionId}/sip_dialing - Read
List session streaming ingestions
List all streaming ingestions of a live session. **Prerequisites:** * A Video SDK account. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:read:list_session_stream_ingestions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /videosdk/sessions/{sessionId}/stream_ingestions - Read
List session users
Use this API to return a list of users from live or past sessions. You can specify a monthly date range for this data using the `from` and `to` query parameters. The month should fall within the last six months. * If you do **not** provide the `type` query parameter, the API defaults to the `live` value and the API will only return metrics for users in a live session, if a session is currently in progress. * To view metrics on past session users, provide the `past` value for the `type` query parameter. **Prerequisites:** * A Video SDK account. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:read:session_users:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /videosdk/sessions/{sessionId}/users - Read
List session users QoS
Return a list of session users from live or past sessions along with the quality of service (QoS) they received during the session. For example, connection quality for sending and receiving video, audio, and shared content. You can specify a monthly date range for the dashboard data using the `from` and `to` query parameters. The month should fall within the last six months. * If you do **not** provide the `type` query parameter, the API defaults to the `live` value and the API will only return metrics for users in a live session, if a session is currently in progress. * To view metrics on past session users, provide the `past` value for the `type` query parameter. **Prerequisites:** * A Video SDK Account **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:read:session_users_qos:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /videosdk/sessions/{sessionId}/users/qos - Read
Get session user QoS
Retrieve the quality of service (QoS) for users from live or past sessions. The data returned indicates the connection quality for sending and receiving video, audio, and shared content. For a session that has started and is ongoing, the API returns live session data. If the session has ended, the API returns the past session data. * This API will **not** return data if there is no data being sent or received at the time of request. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:read:seesion_user_qos:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /videosdk/sessions/{sessionId}/users/{userId}/qos - Read
List stream ingestions
List all the stream ingestions on your Zoom account. **Prerequisites:** * A Video SDK account. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:read:list_stream_ingestions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /videosdk/stream_ingestions - Read
Get a stream ingestion
Get information about a stream ingestion. **Prerequisites:** * A Video SDK account. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:read:stream_ingestion:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /videosdk/stream_ingestions/{streamId} - Write
Create a session
Creates a session. This operation is not available for a single session event type. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:write:admin`,`zoom_events_sessions:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:session`,`zoom_events:write:session:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /zoom_events/events/{eventId}/sessions - Write
Update a session
Updates an existing session in an event. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:write`,`zoom_events_sessions:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:session`,`zoom_events:update:session:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /zoom_events/events/{eventId}/sessions/{sessionId} - Write
Update session livestream configuration
Update the livestream configuration for the given session. RTMP Incoming livestream will only work for webinar sessions (not meetings). Please check [RTMP livestream](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0077038) for the feature details. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:write`,`zoom_events_sessions:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:session_livestream_config`,`zoom_events:update:session_livestream_config:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /zoom_events/events/{eventId}/sessions/{sessionId}/livestream - Write
Add session reservations
Reserve a spot for a user in the given session. As a host, reserve registrants for a particular session. Session reservation needs to be enabled before using this API. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:write`,`zoom_events_sessions:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:session_reservations`,`zoom_events:write:session_reservations:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /zoom_events/events/{eventId}/sessions/{sessionId}/reservations - Write
Create a session
Create a Video SDK session. This API is designed to get the PSTN or SIP dial in information before starting a session with the session name specified in this API. The Create a session API is not required for creating or starting a Video SDK session. Zoom creates and starts Video SDK sessions on demand when the first user joins, see the Video SDK Session documentation for your platform for details. Video SDK sessions only show up in the dashboard or REST API reports when they are live or completed. **Prerequisites:** * A Video SDK account. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:write:session:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /videosdk/sessions - Write
Update a session live stream
Use this API to update a session's live stream information. **Prerequisites:** * A Video SDK account **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:update:session_livestream:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /videosdk/sessions/{sessionId}/livestream - Write
Update session livestream status
Update a session's livestream status. **Prerequisites:** * A Video SDK account **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:update:session_livestream_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /videosdk/sessions/{sessionId}/livestream/status - Write
Update Realtime Media Streams (RTMS) app status
Update the status of the Realtime Media Streams (RTMS) app in an ongoing session. Zoom lets individuals control their own RTMS during a session. **Prerequisites:** * A Video SDK account. * Contact [Developer Support](https://developers.zoom.us/support/) to enable RTMS features. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:update:session_rtms_app_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /videosdk/sessions/{sessionId}/rtms_app/status - Write
Create a stream ingestion
Create a stream ingestion. A stream ingestion is a unique identifier used to establish a connection between an external streaming source (such as a third-party live streaming app) and the Zoom streaming platform. Once you've created a stream ingestion, you can bind it to your video session, so you can integrate the video feeds from the streaming source into your live video session, for a more immersive experience. You can create up to 20 stream ingestions. **Prerequisites:** * A Video SDK account. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:write:stream_ingestion:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /videosdk/stream_ingestions - Write
Update a stream ingestion
Update a stream ingestion. **Prerequisites:** * A Video SDK account. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:update:stream_ingestion:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /videosdk/stream_ingestions/{streamId} - Destructive
Delete a session
Deletes a session. Not allowed for a single session event type. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:write`,`zoom_events_sessions:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:delete:session`,`zoom_events:delete:session:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /zoom_events/events/{eventId}/sessions/{sessionId} - Destructive
Create or update session interpreters
Creates or updates the list of interpreters for the session. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:write`,`zoom_events_sessions:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:session_interpreter`,`zoom_events:update:session_interpreter:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /zoom_events/events/{eventId}/sessions/{sessionId}/interpreters - Destructive
Create or update session polls
Create or update the list of polls for the session. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:write`,`zoom_events_sessions:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:session_poll`,`zoom_events:update:session_poll:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /zoom_events/events/{eventId}/sessions/{sessionId}/polls - Destructive
Delete session reservations
This tool removes a user's reservation spot for a given session. As a host, you can use it to remove reservations of registrants for a particular session. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_sessions:write`,`zoom_events_sessions:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:delete:session_reservations`,`zoom_events:delete:session_reservations:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /zoom_events/events/{eventId}/sessions/{sessionId}/reservations - Destructive
Delete a session
Delete a session. **Prerequisites:** * A Video SDK account. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:delete:session:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /videosdk/sessions/{sessionId} - Destructive
Use in-session events controls
Control in-session events such as the **recording controls** to start a recording, stop a recording, pause a recording, and resume a recording, and **invitation control** to invite users. The recording controls only work for cloud recordings and not for local recordings. **Prerequisite:** * The session must be a live session. * Cloud recording must be enabled for recording controls. * The user using this API must either be the host or manager of the session. * You must have a Conference Room Connector add-on plan to invite users to the session using a room system callout. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:update:in_session_controls:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /videosdk/sessions/{sessionId}/events - Destructive
Update session status
Use this API to update a session's status. **Prerequisites:** * A Video SDK account **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:update:session_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /videosdk/sessions/{sessionId}/status - Destructive
Delete a stream ingestion
Delete a stream ingestion. **Prerequisites:** * A Video SDK account. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:delete:stream_ingestion:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /videosdk/stream_ingestions/{streamId}
Account Management
- Read
Get the list of all accounts associated with a Zoom Partner/Sub-Reseller, by the account type
Returns the list of all accounts associated with a Zoom Partner and Sub-Reseller, by the account type - endCustomer, subReseller, and relatedPartner. <br><b>Note:</b> Please check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:account:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
GET /commerce/accounts - Read
Get the account details for a Zoom Partner/Subreseller/End Customer
Returns the account details for a Zoom Partner, Subreseller, and End Customer. <br><b>Note:</b> Please check the base URL for sandbox and production environments under the Zoom Commerce section [here](https://developers.zoom.us/docs/api/). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:account:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /commerce/accounts/{accountKey} - Write
Create an end customer account
Creates an end customer account. **Note** Please check the base URL for sandbox and production environments under Zoom Commerce section [here](/docs/api). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:sub_account:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
POST /commerce/account - Write
Add contacts to an existing end customer or your own account.
Add contacts to an existing end customer or your own account. <br><b>Note:</b> Check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:update:account:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
POST /commerce/account/{accountKey}/contacts
Billing
- Read
Gets all billing documents for a distributor or a reseller
Returns all billing documents for a distributor or a reseller. Billing Documents represent the end customer's invoices, credit memos and debit memos. The response can be filtered by status, document date etc. By default, the list of unpaid invoices in the last 1 month are retrieved. <br><b>Note:</b> Check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:billing_documents:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
GET /commerce/billing_documents - Read
Gets the PDF document for the billing document ID
Returns the PDF document for the billing document ID. <br><b>Note:</b> Check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:billing_documents:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /commerce/billing_documents/{documentNumber}/document - Read
Get detailed information about a specific invoice for a distributor or a reseller
Returns detailed information about a specific invoice for a distributor or a reseller. To filter the details for a particular end customer provide the end customer Zoom account number or CRM account number. <br><b>Note:</b> Check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:billing_documents:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /commerce/invoices/{invoiceNumber}
Deal Registration
- Read
Retrieves all valid Zoom Campaigns which a deal registration can be associated with.
Retrieves all valid Zoom Campaigns which a deal registration can be associated with. <br><b>Note:</b> Please check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:deal_registration:admin` **Not supported in Gov cluster**
GET /commerce/campaigns - Read
Gets all valid Deal Registrations for a partner
Retrieves all valid deal registrations for a partner. <br><b>Note:</b> Please check the base URL for sandbox and production environments under the Zoom Commerce section [here](https://developers.zoom.us/docs/api). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:deal_registration:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
GET /commerce/deal_registrations - Read
Get details of a deal registration by registration number
Retrieve details for a deal registration by the deal registration number. **Note** Check the base URL for sandbox and production environments under the Zoom Commerce section [here](https://developers.zoom.us/docs/api). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:deal_registration:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /commerce/deal_registrations/{dealRegKey} - Write
Creates a new deal registration for a partner
Creates a new Deal Registration for a partner. <br><b>Note:</b> Check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:deal_registration:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
POST /commerce/deal_registration - Write
Updates an existing deal registration
Updates an existing deal registration that has been returned (Deal status = returned). <br><b>Note:</b> Please check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:deal_registration:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
PATCH /commerce/deal_registrations/{dealRegKey}
Order
- Read
Preview delta order metrics and subscriptions in an order
Previews the delta order metrics and subscriptions in an order. Validates the order and gets the metrics like TCV, applicable discounts, and net MRR before placing the order for provisioning. This operation is only an order preview, and no order is submitted for fulfillment. To submit the order, use the [order API](https://developers.zoom.us/docs/api/commerce/#tag/order/post/commerce/order/preview). \n**Note** Please check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api/). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:order:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY` **Not supported in Gov cluster**
POST /commerce/order/preview - Read
Gets all orders for a Zoom partner.
Returns all orders for a Zoom partner based on specified filters. <br><b>Note:</b> Please check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:order:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
GET /commerce/orders - Read
Get order details by order reference ID
Gets order details by order reference ID. <br><b>Note:</b> Please check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:order:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /commerce/orders/{orderReferenceId} - Destructive
Create a subscription order for a Zoom partner
Create a subscription order for a Zoom partner's end customers. One order can have more than one subscription for more than one end customer. The same order can create a new subscription and also amend an existing subscription. **Note** Check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api/). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:order:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY` **Not supported in Gov cluster**
POST /commerce/order
Platform
- Read
Gets details of all files associated with a quote or deal registration
**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:file:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /commerce/files/{associatedReferenceId}/details - Read
Download a file associated with a quote or deal registration.
Download a file associated with a quote or deal registration. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:file:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /commerce/files/{documentReferenceId} - Write
Upload an attachment pdf file in context of a deal registration or quote
**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:file:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
POST /commerce/file
Product Catalog
- Read
Gets Zoom Product Catalog for a Zoom Partner
Returns the Zoom product catalog for a Zoom Partner. <br><b>Note:</b> Please check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:product_catalog:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
POST /commerce/catalog - Read
Gets the details for a Zoom product or offer.
Returns the details for a Zoom product or offer. Each offer is identified by a unique ID. <br><b>Note:</b> Please check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:product_catalog:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
GET /commerce/catalog/{offerId} - Read
Validate offer compatibility and dependencies
Validates offers against dependency rules, quantity constraints, and eligibility criteria. Each violation provides a recommendation on how to fix the violation. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:product_catalog:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /commerce/catalogvalidator - Read
Gets the pricebook in a downloadable file
Returns the pricebook in a CSV or Excel format including list price and discounted price based on the partner type. <br><b>Note:</b> Please check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:product_catalog:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
GET /commerce/pricebooks
Quote
- Read
Preview delta quote metrics and subscriptions in a quote
Previews the delta quote metrics and subscriptions in a quote. The API can be used to validate the quote and get metrics like TCV, applicable discounts, and net MRR before submitting the quote for actual creation and provisioning. This operation is only a quote preview and no quote is submitted for approval and fulfillment. To submit the quote, use the quote API. <br><b>Note:</b> Please check the base URL for sandbox and production environments in the Zoom Commerce section [here](https://developers.zoom.us/docs/api). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:quote:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY` **Not supported in Gov cluster**
POST /commerce/quote/preview - Read
Gets all quotes for a Zoom partner
Returns all quotes for a Zoom partner based on specified filters. <br><b>Note:</b> Please check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:quote:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
GET /commerce/quotes - Read
Get quote details by quote reference ID
Get quote details by quote reference ID. **Note** Check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api/). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:quote:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /commerce/quotes/{quoteReferenceId} - Write
Create a subscription quote for a Zoom Partner
Create a subscription quote for a Zoom partner's end customers. **Note** Check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api/). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:quote:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
POST /commerce/quote - Write
Update a subscription quote for a Zoom Partner
Update a subscription quote for a Zoom partner's end customers. Approved quotes cannot be updated.<br><b>Note:</b> Check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api/). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:quote:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
PATCH /commerce/quotes/{quoteReferenceId} - Write
Submits a subscription quote for provisioning
Submits a subscription quote for provisioning. Only approved quotes can be submitted for fulfillment. <br><b>Note:</b> Check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api/). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:quote:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /commerce/quotes/{quoteReferenceId}/fulfillment
Subscription
- Read
Gets paid subscriptions for a Zoom partner.
Returns paid subscriptions for a distributor or a reseller. The subscriptions list can be filtered by end customer account number, subscription status, subscription number, start and end dates. By default, the list of active subscriptions in the last month is retrieved. <br><b>Note:</b> Please check the base URL for sandbox and production environments under the Zoom Commerce section [here](https://developers.zoom.us/docs/api). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:subscription:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
GET /commerce/subscriptions - Read
Gets subscription details for a given subscription number
Returns the subscription details for a given subscription number. <br><b>Note:</b> Please check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api/). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:subscription:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /commerce/subscriptions/{subscriptionNumber} - Read
Gets subscription changes/versions for a given subscription number.
Returns the subscription changes or versions for a given subscription number. <br><b>Note:</b> Please check the base URL for sandbox and production environments under Zoom Commerce section here - https://developers.zoom.us/docs/api **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:subscription:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
GET /commerce/subscriptions/{subscriptionNumber}/versions - Read
Get trial subscriptions for a Zoom partner
Returns trial subscriptions for a distributor or reseller. The subscriptions list can be filtered by end customer account number, subscription status, subscription number, and start and end dates. By default, the list of active subscriptions in the last month is retrieved. <br><b>Note:</b> Please check the base URL for sandbox and production environments under the Zoom Commerce section [here](https://developers.zoom.us/docs/api). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:subscription:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /commerce/trials - Read
Get trial details for an end customer by their Zoom account number or the trial ID
Returns the trial details for an end customer. <br><b>Note:</b> Please check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api/). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:subscription:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /commerce/trials/{trialReferenceId}
Address Books
- Read
List address books
Return a list of all address books. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_contact:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_address_books:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/address_books - Read
List an address book contact's custom fields
List all custom fields on a contact. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_contact:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:address_book_custom_field:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/address_books/contacts/{contactId}/custom_fields - Read
List an address book's custom fields
Return all customer list (formerly address book) custom fields. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_contact:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:address_book_custom_field:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/address_books/custom_fields - Read
Get an address book's custom field
Get information about a customer list (formerly [address book](https://support.zoom.us/hc/en-us/articles/4471544949389)) custom field. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_contact:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:address_book_custom_field:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/address_books/custom_fields/{customFieldId} - Read
List address book units
Return all collections (formerly [address book unit](https://support.zoom.us/hc/en-us/articles/4471495629837-Managing-address-book-units)). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_contact:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_address_book_units:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/address_books/units - Read
Get an address book unit
Returns information about a collection (formerly [address book unit](https://support.zoom.us/hc/en-us/articles/4471495629837-Managing-address-book-units)). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_contact:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:address_book_unit:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/address_books/units/{unitId} - Read
Get an address book
Returns information about a customer list (formerly [address book](https://support.zoom.us/hc/en-us/articles/4471544949389)). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_contact:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:address_book:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/address_books/{addressBookId} - Read
List address book contacts
When the `emails` or `phone_numbers` query parameter is included, the address book returns a maximum of 10,000 contacts. The optional `source_id` and `source_name` query parameters are independent CRM filters. You may send either one or both; when both are sent, both filters are applied. Omit both to list contacts without CRM source filtering. Non-CRM contacts do not have CRM source fields. Using either source filter when CRM integration is disabled returns error `2009`. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_contact:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_address_book_contacts:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/address_books/{addressBookId}/contacts - Read
Get an address book contact
Returns information about a customer list (formerly [address book](https://support.zoom.us/hc/en-us/articles/4471544949389)) contact. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_contact:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:address_book_contact:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/address_books/{addressBookId}/contacts/{contactId} - Read
Get contact by source ID
Retrieve an address book contact by its Salesforce source ID. The lookup is scoped to the address book in the path, which determines the CRM integration. This endpoint is only applicable to CRM-integrated address books; non-CRM contacts do not have CRM source identifiers. **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/address_books/{addressBookId}/crm/{sourceId} - Write
Create an address book
Create a customer list (formerly [address book](https://support.zoom.us/hc/en-us/articles/4471544949389)) . A customer list (formerly address book) is a collection of contacts and their information like display names, phone numbers, and locations. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_contact:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:address_book:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/address_books - Write
Create an address book custom field
Create a customer list (formerly [address book](https://support.zoom.us/hc/en-us/articles/4471544949389)) custom field. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_contact:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:address_book_custom_field:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/address_books/custom_fields - Write
Update an address book custom field
Update a customer list (formerly address book) custom field. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_contact:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:address_book_custom_field:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/address_books/custom_fields/{customFieldId} - Write
Create an address book unit
Create a collection (formerly [address book unit](https://support.zoom.us/hc/en-us/articles/4471495629837-Managing-address-book-units)). Admins can use collections to organize several customer lists (formerly [address book](https://support.zoom.us/hc/en-us/articles/4471544949389)). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_contact:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:address_book_unit:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/address_books/units - Write
Update an address book unit
Update a collection (formerly address book unit). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_contact:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:address_book_unit:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/address_books/units/{unitId} - Write
Update an address book
Update a customer list's (formerly address book) information. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_contact:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:address_book:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/address_books/{addressBookId} - Write
Create an address book contact
Create a new contact in an [address book](https://support.zoom.us/hc/en-us/articles/4471544949389). During an active engagement, the Zoom desktop client displays information from the address book if that customer is a contact in the address book. If the consumer is not in the address book, agents can add a new contact and choose which address book the contact belongs to. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_contact:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:address_book_contact:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/address_books/{addressBookId}/contacts - Write
Batch create address book contacts
Batch create new contacts in a [customer list](https://support.zoom.us/hc/en-us/articles/4471544949389) (formerly address book). Supports up to 10 contacts per request. Valid contacts are created while invalid contacts are rejected with detailed error messages. Returns 200 for all valid or partial success with invalid contact details, or 400 if all contacts are invalid. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_contact:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:address_book_contact:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /contact_center/address_books/{addressBookId}/contacts/batch - Write
Batch update address book contacts
Batch update contacts in an address book. For more information, see [Managing address books and contacts](https://support.zoom.us/hc/en-us/articles/4471544949389). Supports up to 50 contacts per request. Each item must include `contact_id` for an existing contact update. CRM source fields are integration-managed and are not part of this update request contract. Successful CRM contacts include `source_id` and `source_name` in the response when available. Non-CRM contacts do not have CRM source fields. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_contact:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:address_book_contact:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /contact_center/address_books/{addressBookId}/contacts/batch - Write
Update an address book contact
Update an address book contact, including contacts created through a CRM integration. The existing contact ID path remains supported. CRM source fields are managed by the integration and are not part of this public update request contract. Non-CRM contacts do not have CRM source fields. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_contact:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:address_book_contact:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/address_books/{addressBookId}/contacts/{contactId} - Write
Update contact by source ID
Update an address book contact using its Salesforce source ID. The lookup is scoped to the address book in the path, which determines the CRM integration. CRM source fields are managed by the integration and are not part of this public update request contract. Non-CRM contacts do not have CRM source fields. **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/address_books/{addressBookId}/crm/{sourceId} - Destructive
Delete an address book custom field
Delete a customer list (formerly [address book](https://support.zoom.us/hc/en-us/articles/4471544949389)) custom field. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_contact:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:address_book_custom_field:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/address_books/custom_fields/{customFieldId} - Destructive
Delete an address book unit
Delete a collection (formerly [address book unit](https://support.zoom.us/hc/en-us/articles/4471495629837-Managing-address-book-units)). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_contact:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:address_book_unit:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/address_books/units/{unitId} - Destructive
Delete an address book
Delete a customer list (formerly [address book](https://support.zoom.us/hc/en-us/articles/4471544949389)). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_contact:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:address_book:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/address_books/{addressBookId} - Destructive
Batch delete address book contacts
Batch delete contacts from a customer list (formerly [address book](https://support.zoom.us/hc/en-us/articles/4471544949389)). Supports up to 50 contacts per request. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_contact:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:address_book_contact:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /contact_center/address_books/{addressBookId}/contacts/batch - Destructive
Delete an address book contact
Delete a contact from an address book, including contacts created through a CRM integration. The existing internal contact ID path remains supported. Use the CRM source ID endpoint when the salesforce or CRM source identifier is the only identifier available. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_contact:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:address_book_contact:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/address_books/{addressBookId}/contacts/{contactId} - Destructive
Delete contact by source ID
Delete an address book contact using its Salesforce source ID. The lookup is scoped to the address book in the path, which determines the CRM integration. This endpoint is only applicable to CRM-integrated address books. Non-CRM contacts do not have CRM source identifiers. **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/address_books/{addressBookId}/crm/{sourceId}
Agent Statuses
- Read
List system statuses
Get a list of system statuses. Administrators can create system statuses, such as **Maintenance**. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_preference:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_system_statues:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/system_statuses - Read
Get a system status
Get information about a system status. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_preference:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:system_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/system_statuses/{statusId} - Write
Create a system status
Create custom statuses for the `agent_status` and `queue_opt_out_and_not_ready_status` categories. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_preference:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:system_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/system_statuses - Write
Update a system status
Update a custom status for the `agent_status` and `queue_opt_out_and_not_ready_status` categories. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_preference:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:system_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/system_statuses/{statusId} - Destructive
Delete a system status
Delete a custom status for the `agent_status` and `queue_opt_out_and_not_ready_status categories`. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_preference:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:system_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/system_statuses/{statusId}
Asset Library
- Read
List assets
List Contact Center assets. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_asset_library:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:asset_library:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/asset_library/assets - Read
Get an asset
Get information about an asset. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_asset_library:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:asset_library:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/asset_library/assets/{assetId} - Read
List asset categories
List asset categories. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_asset_library:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:asset_library:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/asset_library/categories - Read
Get an asset category
Get an asset category. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_asset_library:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:asset_library:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/asset_library/categories/{categoryId} - Write
Create an asset
Create an asset to store in the Contact Center Asset Library. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_asset_library:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:asset_library:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/asset_library/assets - Write
Batch update asset items
Batch updates asset items across multiple assets in a single request. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_asset_library:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:asset_library:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /contact_center/asset_library/assets/items - Write
Duplicate an asset
Creates new assets based on an existing asset. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_asset_library:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:asset_library:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /contact_center/asset_library/assets/{assetId}/duplicate - Write
Create an asset category
Create an asset category. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_asset_library:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:asset_library:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/asset_library/categories - Write
Update an asset category
Update an asset category. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_asset_library:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:asset_library:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/asset_library/categories/{categoryId} - Destructive
Delete an asset
Delete or achive an existing asset. You can only operate assets that have not been assigned to other modules. Only assets in archived status can be deleted. Set the asset to `archived` through this API before deleting. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_asset_library:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:asset_library:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/asset_library/assets/{assetId} - Destructive
Update an asset
Update an asset. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_asset_library:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:asset_library:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/asset_library/assets/{assetId} - Destructive
Delete asset items
Delete specific asset items. The default asset item cannot be deleted. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_asset_library:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:asset_library:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/asset_library/assets/{assetId}/items - Destructive
Delete an asset category
Delete an existing asset category. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_asset_library:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:asset_library:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
DELETE /contact_center/asset_library/categories/{categoryId}
Block List Rules
- Read
List block list rules for IP addresses
List block list rules for IP addresses. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_block_list_rules:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:block_list_rules:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/block_list_rules/ip_addresses - Read
Get a block list rule of IP addresses
Get a block list rule of IP addresses. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_block_list_rules:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:block_list_rules:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/block_list_rules/ip_addresses/{ipAddressBlockListRuleId} - Read
List block list rules of phone numbers
List block list rules of phone numbers. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_block_list_rules:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:block_list_rules:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/block_list_rules/phone_numbers - Read
Get a block list rule of phone numbers
Get a block list rule of phone numbers. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_block_list_rules:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:block_list_rules:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/block_list_rules/phone_numbers/{phoneBlockListRuleId} - Write
Create block list rules for IP addresses
Create block list rules for IP addresses. Supports up to 20 block list rules per request. Valid block list rules are created while invalid block list rules are rejected with detailed error messages. Returns `201` if all are valid, `207` for partial success, or `400` if all are invalid. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_block_list_rules:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:block_list_rules:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /contact_center/block_list_rules/ip_addresses - Write
Create block list rules for phone numbers
Create block list rules for phone numbers. Supports up to 20 block list rules per request. Valid block list rules are created while invalid block list rules are rejected with detailed error messages. Returns `201` if all are valid, `207` for partial success, or `400` if all are invalid. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_block_list_rules:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:block_list_rules:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /contact_center/block_list_rules/phone_numbers - Destructive
Delete IP addresses' block list rules
Delete block list rules of IP addresses. Supports up to 20 block list rules per request. No block list rules are deleted unless all IDs in the request are valid. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_block_list_rules:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:block_list_rules:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /contact_center/block_list_rules/ip_addresses - Destructive
Delete phone numbers' block list rules
Delete block list rules of phone numbers. Supports up to 20 block list rules per request. No block list rules are deleted unless all IDs in the request are valid. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_block_list_rules:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:block_list_rules:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /contact_center/block_list_rules/phone_numbers
Call Control
- Read
List user's devices
List a Contact Center user's device information. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:user_device:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/users/{userId}/devices - Write
Command control of a user
Issue a command to trigger an action for a Contact Center user. - command - `make_call` initiates an outbound voice engagement. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:user_control:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/users/{userId}/commands - Destructive
Control an engagement's recording
Controls the recording state for an engagement. This request is only valid for video and voice engagements. Calling this API for other channel types is invalid. Acceptance of a request and response of `HTTP 204 No Content` only ensures there were no validation errors with the request. **Note:** The **Control an engagement's recording** API only works with third-party apps if the account admin has enabled the **Allow Open API to pause and resume automatic call recording** setting. For more details, refer to this [support article](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0059069). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:engagement_recording_control:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /contact_center/engagements/{engagementId}/recording/{command}
Campaigns
- Read
List outbound campaigns
List Contact Center outbound campaigns. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:outbound_campaign:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/outbound_campaign/campaigns - Read
Get an outbound campaign
Get a Contact Center outbound campaign. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:outbound_campaign:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/outbound_campaign/campaigns/{campaignId} - Read
List campaign contact lists' custom fields
Retrieve all custom fields defined for campaign contact lists. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign_contactlist:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:outbound_campaign_contactlist:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/outbound_campaign/contact_list_custom_fields - Read
Get a campaign contact list's custom field
Retrieve information about a campaign contact list custom field. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign_contactlist:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:outbound_campaign_contactlist:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/outbound_campaign/contact_list_custom_fields/{customFieldId} - Read
List campaign contact lists
List campaign contact lists. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign_contactlist:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:outbound_campaign_contactlist:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/outbound_campaign/contact_lists - Read
Get a campaign contact list
Get a campaign contact list. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign_contactlist:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:outbound_campaign_contactlist:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/outbound_campaign/contact_lists/{contactListId} - Read
List a campaign contact list's contacts
List contacts on a campaign contact list. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign_contacts:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:outbound_campaign_contacts:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/outbound_campaign/contact_lists/{contactListId}/contacts - Read
Get a campaign contact list's contact
Get a contact on a campaign contact list. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign_contacts:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:outbound_campaign_contacts:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/outbound_campaign/contact_lists/{contactListId}/contacts/{contactId} - Read
List a campaign contact's custom fields
Retrieve all custom fields associated with a contact. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign_contactlist:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:outbound_campaign_contactlist:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/outbound_campaign/contacts/{contactId}/custom_fields - Read
List campaign DNC phone numbers
List phone numbers on a campaign DNC (Do Not Call) list. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign_dnc_list_phones:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:outbound_campaign_dnc_list_phones:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/outbound_campaign/dnc_lists/{dncListId}/phones - Write
Create an outbound campaign
Create an outbound Contact Center campaign. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:outbound_campaign:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/outbound_campaign/campaigns - Write
Update an outbound campaign
Update an outbound Contact Center campaign. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign:update:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:outbound_campaign:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/outbound_campaign/campaigns/{campaignId} - Write
Update an outbound campaign status
Update an outbound campaign status. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:outbound_campaign:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/outbound_campaign/campaigns/{campaignId}/status - Write
Create a campaign contact list's custom field
Create a custom field for a campaign contact list. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign_contactlist:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:outbound_campaign_contactlist:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/outbound_campaign/contact_list_custom_fields - Write
Create a campaign contact list
Create a campaign contact list. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign_contactlist:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:outbound_campaign_contactlist:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/outbound_campaign/contact_lists - Write
Batch update campaign contact lists
Batch update campaign contact lists. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign_contactlist:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:outbound_campaign_contactlist:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /contact_center/outbound_campaign/contact_lists - Write
Update a campaign contact list
Update a campaign contact list **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign_contactlist:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:outbound_campaign_contactlist:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/outbound_campaign/contact_lists/{contactListId} - Write
Create a campaign contact list's contact
Add a new contact to a campaign contact list. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign_contacts:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:outbound_campaign_contacts:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/outbound_campaign/contact_lists/{contactListId}/contacts - Write
Batch create a campaign DNC list's phones
Batch add phone numbers to a Do Not Call (DNC) list. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign_dnc_list_phones:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:outbound_campaign_dnc_list_phones:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/outbound_campaign/dnc_lists/{dncListId}/phones - Destructive
Delete an outbound campaign
Delete a Contact Center's outbound campaign. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign:delete:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:outbound_campaign:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/outbound_campaign/campaigns/{campaignId} - Destructive
Update outbound campaign contact lists
Attach or detach the contact lists associated with an outbound Contact Center campaign. The request body represents the contact list association set and operations. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign:update:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:outbound_campaign:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/outbound_campaign/campaigns/{campaignId}/contact_lists - Destructive
Delete a campaign contact list's custom field
Delete a custom field in a campaign contact list. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign_contactlist:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:outbound_campaign_contactlist:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/outbound_campaign/contact_list_custom_fields/{customFieldId} - Destructive
Update a campaign contact list's custom field
Update details of a campaign contact list's custom field. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign_contactlist:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:outbound_campaign_contactlist:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/outbound_campaign/contact_list_custom_fields/{customFieldId} - Destructive
Remove a campaign contact list
Delete a campaign contact list **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign_contactlist:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:outbound_campaign_contactlist:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/outbound_campaign/contact_lists/{contactListId} - Destructive
Update a batch of contacts on a campaign contact list
Batch update contacts on a campaign contact list. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign_contacts:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:outbound_campaign_contacts:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /contact_center/outbound_campaign/contact_lists/{contactListId}/contacts - Destructive
Insert a batch of contacts into a campaign contact list
Batch insert contacts into a campaign contact list. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign_contacts:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:outbound_campaign_contacts:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /contact_center/outbound_campaign/contact_lists/{contactListId}/contacts/batch - Destructive
Remove campaign contact list's contact
Remove a contact by ID from a campaign contact list. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign_contacts:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:outbound_campaign_contacts:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/outbound_campaign/contact_lists/{contactListId}/contacts/{contactId} - Destructive
Update contact on a campaign contact list
Update a contact on a campaign contact list. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign_contacts:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:outbound_campaign_contacts:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/outbound_campaign/contact_lists/{contactListId}/contacts/{contactId} - Destructive
Batch delete a campaign DNC list's phones
Batch delete phone numbers from a Do Not Call (DNC) list. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign_dnc_list_phones:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:outbound_campaign_dnc_list_phones:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/outbound_campaign/dnc_lists/{dncListId}/phones
Dispositions
- Read
List dispositions
Return a list of available dispositions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_disposition:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_dispositions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/dispositions - Read
List disposition sets
Return a list of available disposition sets. Use sets to organize dispositions into groups. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_disposition:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_disposition_sets:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/dispositions/sets - Read
Get a disposition set
Get detailed information about a disposition set. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_disposition:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:disposition_set:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/dispositions/sets/{dispositionSetId} - Read
Get a disposition
Get detailed information about a disposition. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_disposition:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:disposition:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/dispositions/{dispositionId} - Write
Create a disposition
Create a new [disposition](https://support.zoom.us/hc/en-us/articles/4470153057549-Managing-dispositions). Dispositions let agents assign an outcome or topic to each engagement. After creating dispositions, you can add them to queues. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_disposition:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:disposition:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/dispositions - Write
Create a disposition set
Create a new disposition set. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_disposition:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:disposition_set:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/dispositions/sets - Write
Update a disposition set
Update a disposition set. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_disposition:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:disposition_set:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/dispositions/sets/{dispositionSetId} - Write
Update a disposition
Update an existing disposition. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_disposition:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:disposition:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/dispositions/{dispositionId} - Destructive
Delete a disposition set
Delete a disposition set. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_disposition:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:disposition_set:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/dispositions/sets/{dispositionSetId} - Destructive
Delete a disposition
Delete a disposition. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_disposition:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:disposition:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/dispositions/{dispositionId}
Engagements
- Read
List historical engagements
Retrieve a list of **historical/completed** engagements. **Note** For **active/open** engagements, use [**List Open Engagements**](/docs/api/contact-center/#tag/engagements/get/contact_center/open_engagements). Engagement data is available only after the engagement has ended and only after post-engagement processing has completed. Before querying this endpoint, listen for the [`contact_center.legacy_engagement_end_data_ready` webhook](/docs/api/contact-center/events/#tag/contact-center/postcontact_center.legacy_engagement_end_data_ready), which indicates that the historical engagement data has finished processing and is ready to be retrieved with this API. When calling this API immediately after receiving a [contact_center.engagement_ended](/docs/api/contact-center/events/#tag/contact-center/postcontact_center.engagement_ended) webhook instead of waiting for contact_center.legacy_engagement_end_data_ready, the requested engagement details may not yet be available or may be partially available. If necessary, retry the request for up to 1 minute, using exponential backoff or another retry strategy to avoid rate limiting. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_engagements:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/engagements - Read
Get a historical engagement
Retrieve details about a **historical/completed** engagement. **Note** For **active/open** engagements, use [List Open Engagements](/docs/api/contact-center/#tag/engagements/get/contact_center/open_engagements). Engagement data is available only after the engagement has ended and only after post-engagement processing has completed. Before querying this endpoint, listen for the [`contact_center.legacy_engagement_end_data_ready` webhook](/docs/api/contact-center/events/#tag/contact-center/postcontact_center.legacy_engagement_end_data_ready), which indicates that the historical engagement data has finished processing and is ready to be retrieved with this API. When calling this API immediately after receiving a [contact_center.engagement_ended](/docs/api/contact-center/events/#tag/contact-center/postcontact_center.engagement_ended) webhook instead of waiting for contact_center.legacy_engagement_end_data_ready, the requested engagement details may not yet be available or may be partially available. If necessary, retry the request for up to 1 minute, using exponential backoff or another retry strategy to avoid rate limiting. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/engagements/{engagementId} - Read
Get an engagement's attachments
Retrieve a list of attachments for a specified engagement. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_attachment:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:attachment:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/engagements/{engagementId}/attachments - Read
Get an engagement's events
Retrieve information about an engagement's events. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/engagements/{engagementId}/events - Read
Poll an engagement recording's status
Polls a video or voice engagement's recordings' status. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement_recording_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/engagements/{engagementId}/recordings/status - Read
Get an engagement's survey
Get an engagement's survey and answer item configuration. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/engagements/{engagementId}/survey - Read
Get an engagement's available transfer flows
Retrieve a list of flows that are available for engagement transfer. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_flow:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:flow:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/engagements/{engagementId}/transfer/flows - Read
Get an engagement's available transfer queues
Return a list of queues that are available for engagement transfer. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_queues:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/engagements/{engagementId}/transfer/queues - Read
Get an engagement's available transfer users
Retrieve a list of available transfer engagement users. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_users:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/engagements/{engagementId}/transfer/users - Read
List open engagements
Return a list of open engagements. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_engagements:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/open_engagements - Write
Start an engagement
Start an engagement. Currently only supports the `Work Item` channel. **Note** When creating a work item, variable conflicts are resolved using these guidelines. - If a key exists in both `consumerInfo` and `variableList`, the value from `consumerInfo` takes precedence. - If duplicate keys are provided within `variableList`, only the first occurrence is used. - If a key appears only once in `variableList`, the provided value is applied. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:engagement:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/engagement - Write
Update an engagement
Allows performing an action on an engagement **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:engagement:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/engagements/{engagementId}
Files
- Write
Upload a file
Upload a file. **Note:** - Base URL: `https://fileapi.zoom.us/v2/`. - Supported file extensions: `.aac`, `.amr`, `.mp3`, `.m4a`, `.ogg`, `.txt`, `.xls`, `.xlsx`, `.doc`, `.docx`, `.ppt`, `.pptx`, `.pdf`, `.jpg`, `.jpeg`, `.png`, `.webp`, `.3gp`, `.mp4`, `.zip`. - All files must be less than 100 MB. - The returned `file_id` expires after 24 hours. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_files:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:files:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `RESOURCE-INTENSIVE`
POST /contact_center/files - Write
Upload events file
Uploads files to Zoom Webinars Plus & Events. Use this API to upload video recordings and supporting assets for Zoom Events Video Management (ZE VOD). When `file_type=recording`, the file is uploaded as a video in a single step and a `video_id` is returned. For other `file_type` values, the API uploads supporting files (e.g., captions, thumbnails, metadata) and returns a `file_id`. These files must be attached to a video in a second step using the [Update Video Metadata API](/docs/api/events/#tag/videos/patch/zoom_events/videos/{videoId}/metadata). **Note:** * These file upload Open APIs are currently limited to supporting video recordings and their associated metadata files only (supported formats: `.vtt`, `.jpeg/jpg`, `.png`, `.pdf`, `.txt`, `.ppt`, `.doc`, `.csv`, `xls`). They do not support the ZE content library or other file upload use cases on the ZE platform at this time, though support for additional use cases may be added in the future. * Base URL: `https://fileapi.zoom.us/v2/`. * The caller must support HTTP 30x redirects. * The caller must retain the Authorization header when redirected to a different hostname. * Supported video formats: `.mp4`, `.webm`. * Supported transcription/captioning file formats: `.vtt`. * When your object size reaches 2 GB, you should use multipart uploads instead of uploading the object in a single operation. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_file:write`,`zoom_events_file:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:file_upload`,`zoom_events:write:file_upload:admin`
POST /zoom_events/files - Write
Upload events multipart files
Uploads a multipart file. **Note:** * The base URL for this API is `https://fileapi.zoom.us/v2/`. * The caller must support HTTP 30x redirects. * The caller must retain the authorization header when redirected to a different hostname. * Once initiated, the multipart upload must complete within 7 days. * In general, when your object size reaches 2 GB, you should use multipart uploads instead of uploading the object in a single operation. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_file:write:admin`,`zoom_events_file:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:file_upload`,`zoom_events:write:file_upload:admin`
POST /zoom_events/files/multipart - Write
Initiate and complete the multipart file upload
Uploads files to Zoom Events using a multipart API Use this API when the file is large, typically when the size reaches 2 GB. Use this API to upload video recordings and supporting assets for Zoom Events Video Management (ZE VOD). When `file_type=recording`, the file is uploaded as a video in a single step and a `video_id` is returned. For other `file_type` values, the API uploads supporting files (e.g., captions, thumbnails, metadata) and returns a `file_id`. These files must be attached to a video in a second step using the [Update Video Metadata API](/docs/api/events/#tag/videos/patch/zoom_events/videos/{videoId}/metadata). **Note:** * These file upload Open APIs are currently limited to supporting video recordings and their associated metadata files only (supported formats: `.vtt`, `.jpeg/jpg`, `.png`, `.pdf`, `.txt`, `.ppt`, `.doc`, `.csv`, `xls`). They do not support the ZE content library or other file upload use cases on the ZE platform at this time, though support for additional use cases may be added in the future. * The base URL for this API is `https://fileapi.zoom.us/v2/`. * The caller must support HTTP 30x redirects. * The caller must retain the authorization header when redirected to a different hostname. * Once initiated, the multipart upload must complete within 7 days. * Supported video formats: `.mp4`, `.webm`. * Supported transcription/captioning file formats: `.vtt`. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_file:write:admin`,`zoom_events_file:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:file_upload`,`zoom_events:write:file_upload:admin`
POST /zoom_events/files/multipart/upload - Write
Upload file for video management
Uploads a file to Zoom Video Management and returns a `file_id` that can be used in subsequent resource requests. Use this API to upload supporting assets such as thumbnail images and transcript files for channels, playlists, and videos. This API only stores the file. To associate the file with a channel, playlist, or video, call the corresponding create or update API and include the returned `file_id`. For example, to create a channel with a thumbnail image, first upload the image with this API, then include the returned `file_id` in the [Create Channel API](/docs/api/video-management/#tag/channels/post/video_management/channels). **Note:** * Base URL: `https://fileapi.zoom.us/v2/`. * Supported file formats: `.vtt`, `.jpeg/.jpg`, `.png`, `.gif`. * All files must be less than 2 GB. **Prerequisites:** * A [Pro or higher account plan](https://www.zoom.us/pricing?). * A Zoom Video Management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt_file:write`,`video_mgmt_file:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt:write:file`,`video_mgmt:write:file:admin`
POST /video_management/files
Flows
- Read
List flows
Return a list of flows. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_flow:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_flows:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/flows - Read
Get a flow
Get information about a flow. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_flow:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:flow:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/flows/{flowId} - Read
List the flow's entry points
Retrieve a list of the entry points bound to the current flow. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_flow:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:flow:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/flows/{flowId}/entry_points - Read
Export a flow
Export a flow's content as JSON. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_flow:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:flow:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/flows/{flowId}/export - Read
List entry points
Retrieve a list of entry points. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_flow:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:flow:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/flows_entry_points - Write
Import a flow
Import and create a flow, using content from another flow's exported JSON. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_flow:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:flow:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /contact_center/flows - Write
Edit a flow
Edit a flow's attributes. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_flow:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:flow:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/flows/{flowId} - Write
Add flow entry points
Add entry points to a flow. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_flow:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:flow:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/flows/{flowId}/entry_points - Destructive
Delete a flow
Delete a flow. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_flow:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:flow:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/flows/{flowId} - Destructive
Remove flow entry points
Remove entry points from a flow. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_flow:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:flow:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/flows/{flowId}/entry_points - Destructive
Publish a flow
Publish a flow version. Any other published version of the flow will be replaced with the one specified in this request. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_flow:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:flow:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /contact_center/flows/{flowId}/publish
Follow-up Tasks
- Read
List engagement follow-up tasks
Returns a list of follow-up tasks under an engagement. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_follow_up_task:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_follow_up_tasks:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/engagements/{engagementId}/follow_up_tasks - Read
Get a follow-up task
Returns a single follow-up task by engagement and task ID. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_follow_up_task:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:follow_up_task:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/engagements/{engagementId}/follow_up_tasks/{taskId} - Write
Update a follow-up task
Updates a single follow-up task. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_follow_up_task:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:follow_up_task` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/engagements/{engagementId}/follow_up_tasks/{taskId}
Inboxes
- Read
List inboxes
Return a list of inboxes. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_inbox:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_inboxes:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/inboxes - Read
List an account's inbox messages
Return all messages in an inbox. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_inbox:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:inbox_messages:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/inboxes/messages - Read
Get an inbox
Retrieve an inbox. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_inbox:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:inbox:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/inboxes/{inboxId} - Read
Get an inbox email notification list
Retrieve a list of inbox email notifications. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_inbox:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:inbox:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/inboxes/{inboxId}/email_notifications - Read
List an inbox's messages
Return a list of all messages in an inbox. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_inbox:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:inbox_messages:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/inboxes/{inboxId}/messages - Read
List queues assigned to an inbox
Returns a paginated list of Contact Center queues assigned to the specified inbox, including each queue's identifier, name, description, channel, and configuration details. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_inbox_queues:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/inboxes/{inboxId}/queues - Read
List inbox users
Retrieve a list of users assigned to an inbox. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:inbox_user:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/inboxes/{inboxId}/users - Write
Create an inbox
Create a new inbox. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_inbox:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:inbox:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/inboxes - Write
Update an inbox
Update an inbox. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_inbox:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:inbox:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/inboxes/{inboxId} - Write
Update an inbox's email notification setting
Update an inbox's email notification setting for a given user. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_inbox:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:inbox:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/inboxes/{inboxId}/email_notification - Write
Assign queues to an inbox
Assigns the specified Contact Center queues to an inbox, making the queues available through that inbox. This operation creates queue-to-inbox assignments without modifying the queues themselves. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:inbox_queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /contact_center/inboxes/{inboxId}/queues - Write
Assign inbox access users
Assign users to a Contact Center inbox. This operation is atomic - all specified users must be valid and not already assigned to the inbox, or the entire request fails. No partial assignments occur. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:inbox_user:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /contact_center/inboxes/{inboxId}/users - Destructive
Delete inboxes
Delete one or more inboxes. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_inbox:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:inbox:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /contact_center/inboxes - Destructive
Delete inbox messages
Delete messages. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_inbox:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:inbox_messages:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/inboxes/messages - Destructive
Delete an inbox's messages
Delete multiple messages in an inbox. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_inbox:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:inbox_messages:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/inboxes/{inboxId}/messages - Destructive
Delete an inbox message
Delete a single message in an inbox. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_inbox:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:inbox_message:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/inboxes/{inboxId}/messages/{messageId} - Destructive
Unassign queues from an inbox
Removes up to 30 specified Contact Center queues from the inbox. This operation removes only the queue-to-inbox assignments. It does not delete the queues. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:inbox_queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /contact_center/inboxes/{inboxId}/queues - Destructive
Unassign inbox access users
Remove users' access to an inbox. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:inbox_user:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /contact_center/inboxes/{inboxId}/users
Logs
- Read
List email message history
Retrieve the list of messages exchanged during a specific email engagement. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement_log:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/email/messages - Read
List message history
Retrieve the list of messages exchanged during a specific messaging engagement. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_messaging:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:messaging:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/messaging/messages - Read
List operation logs
Retrieve the Zoom Contact Center management system operation logs. The Zoom Contact Center management system operation logs report lets account owners and admins view monthly Zoom Contact Center-related admin operation details. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_operation_logs:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:operation_logs:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/reports/operation_logs - Read
List SMS logs
Returns a list of SMS engagement logs. Engagement data are available via API once they are completed. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_sms:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:sms_log:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/sms - Read
List voice call logs
Return a list of voice call engagement logs. Engagement data is available via API once it is completed. **Note** These fields - `agents.user_ip_address`, `agents.user_device_mac_address`, `agents.user_registered_sip_zone`, `agents.sip_zone_ip_address`, `session_border_controller_list.session_border_controller_name`, `session_border_controller_list.session_border_controller_ip_address`, `session_border_controller_list.consumer_zoom_trunk_name` and `session_border_controller_list.consumer_sbc_ip_address` - are only available to accounts which have enabled an internal flag to return these additional fields. To enable the feature flag, contact Zoom Support. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_voice_call:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:voice_call_log:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/voice_calls - Read
List work item message history
Retrieve the list of messages exchanged during a specific work item engagement. **Note** This endpoint retrieves messages from work item sessions associated with the engagement. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement_log:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/work_item/messages - Read
List AI Management operation logs
List AI Management operation logs. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva_report:read`,`zva_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:read:list_operation_logs:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /ai_studio/reports/operation_logs
SMS
- Read
Get account's SMS sessions
Returns details about SMS sessions for an account. --- **Service Endpoint SMS** * This API now supports retrieving Service Endpoint SMS sessions. * Non-Zoom Phone users can access only Service Endpoint SMS sessions. An account-level app is required for non-Zoom Phone users to access Service Endpoint SMS. --- **Prerequisites** * Paid account * Zoom Phone enabled for the account * For Zoom Phone SMS: a Zoom Phone-enabled user * For Service Endpoint SMS: an account-level app and a Service Endpoint phone number enabled for SMS **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_sms:read`,`phone_sms:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_sms_sessions`,`phone:read:list_sms_sessions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/sms/sessions - Read
Get SMS session details
Returns details about an SMS session. **Service Endpoint SMS** * This API now supports retrieving a Service Endpoint SMS session. * The `sessionId` must belong to a Service Endpoint SMS session. * Non-Zoom Phone users can access only Service Endpoint SMS sessions. An account-level app is required for non-Zoom Phone users to access Service Endpoint SMS. **Prerequisites** * A paid account * Zoom Phone enabled for the account * For Zoom Phone SMS: a Zoom Phone-enabled user * For Service Endpoint SMS: an account-level app and a Service Endpoint phone number enabled for SMS **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read`,`phone_sms:read`,`phone_sms:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:sms_session`,`phone:read:sms_session:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/sms/sessions/{sessionId} - Read
Get SMS by message ID
Returns details about a specific message in an SMS session. **Service Endpoint SMS** * This API supports retrieving a specific message from a Service Endpoint SMS session. * The `sessionId` must belong to a Service Endpoint SMS session, and the `messageId` must belong to that session. * Non-Zoom Phone users can only access messages in Service Endpoint SMS sessions. An account-level app is required for non-Zoom Phone users to access Service Endpoint SMS. **Prerequisites** * A paid account * Zoom Phone enabled for the account * For Zoom Phone SMS: a Zoom Phone-enabled user * For Service Endpoint SMS: an account-level app and a Service Endpoint phone number enabled for SMS **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read`,`phone_sms:read`,`phone_sms:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:sms_message`,`phone:read:sms_message:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/sms/sessions/{sessionId}/messages/{messageId} - Read
Sync SMS by session ID
Syncs SMS messages in a session. **Service Endpoint SMS** * This API now supports syncing a Service Endpoint SMS session. * The `sessionId` must belong to a Service Endpoint SMS session. * Non-Zoom Phone users can sync only Service Endpoint SMS sessions. An account-level app is required for non-Zoom Phone users to access Service Endpoint SMS. **Prerequisites** * Paid account * Zoom Phone enabled for the account * For Zoom Phone SMS: a Zoom Phone-enabled user * For Service Endpoint SMS: an account-level app and a Service Endpoint phone number enabled for SMS **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read`,`phone_sms:read`,`phone_sms:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:sms_session`,`phone:read:sms_session:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/sms/sessions/{sessionId}/sync - Read
Get user's SMS sessions
Returns details about SMS sessions 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. **Prerequisites:** * Paid account * User-enabled Zoom phone **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read`,`phone_sms:read`,`phone_sms:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_sms_sessions`,`phone:read:list_sms_sessions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/users/{userId}/sms/sessions - Read
List user's SMS sessions in descending order
Retrieves the user's SMS sessions in descending order. Mirrors the ZP client behavior with the most recent on top. **Prerequisites:** * Paid account * User-enabled Zoom phone **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read`,`phone_sms:read`,`phone_sms:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:sms_session`,`phone:read:sms_session:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/users/{userId}/sms/sessions/sync - Write
Send an SMS
Send an SMS message. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_sms:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:sms:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/sms - Write
Post SMS message
Sends [SMS messages](https://support.zoom.us/hc/en-us/articles/360054631031-Setting-up-SMS) to Zoom Phone accounts. **Service Endpoint SMS** * This API now supports sending a Service Endpoint SMS or MMS message. * The sender phone number must be assigned to a Service Endpoint and enabled for SMS. * Non-Zoom Phone users can send only Service Endpoint SMS or MMS messages. An account-level app is required for non-Zoom Phone users to send Service Endpoint SMS. **Prerequisites** * A Zoom Phone license * SMS enabled for the account or admin privileges * For Zoom Phone SMS: a Zoom Phone-enabled user * For Service Endpoint SMS: an account-level app, SMS enabled for the account, and a Service Endpoint phone number enabled for SMS **SMS and attachments - Size and limits** * SMS size with no media attachments: 2048 bytes * SMS size with attachments: 1000 bytes * Total attachments: 10 * Total attachment file size: 2 MB **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write`,`phone_sms:write`,`phone_sms:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:sms_message`,`phone:read:sms_message:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/sms/messages
Messaging
- Write
Send a message
Send a message via the specified messaging channel. **Note** A 200 OK response indicates that the request was successfully received and accepted by the API. It doesn't guarantee that the message has been sent or delivered. Message delivery is processed asynchronously. To track the actual send and delivery status, use the `contact_center.message_status` webhook, which provides updates as the message progresses through the system. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_messaging:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:messaging:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/messages
Notes
- Read
List notes
Return a list of notes. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_note:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_notes:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/engagements/notes - Read
List engagement notes
Return a list of notes under an engagement. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_note:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_notes:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/engagements/{engagementId}/notes - Read
Get a note
Retrieve a note. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_note:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:note:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/engagements/{engagementId}/notes/{noteId} - Write
Update a note
Update a note. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_note:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:note` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/engagements/{engagementId}/notes/{noteId}
Operating Hours
- Read
List business hours
Get a list of business hours. Admins can create business hours to select, such as the business hours "Default Hours". **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_operating_hours:read:admin`,`contact_center_queue:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_business_hours:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/business_hours - Read
Get business hours
Get information about business hours. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_operating_hours:read:admin`,`contact_center_queue:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:business_hour:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/business_hours/{businessHourId} - Read
List the business hours' flows
Show a list of flows using business hours. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_flow:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:business_hours_flow:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/business_hours/{businessHourId}/flows - Read
List the business hours' queues
Show a list of queues using business hours. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:business_hours_queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/business_hours/{businessHourId}/queues - Read
List closures
Get a list of closures. Admins can create closures to select. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin`,`contact_center_operating_hours:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_closure_hours:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/closures - Read
Get a closure set
Get information about a closure set. Closure sets are used to contain business closure hours. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin`,`contact_center_operating_hours:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:closure_hour:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/closures/{closureSetId} - Read
List the closures' flows
Show a list of flows that are using a closure set. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_flow:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:clousre_hour_flow:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/closures/{closureSetId}/flows - Read
List the closures' queues
Show a list of queues that are using a closure set. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:closure_hour_queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/closures/{closureSetId}/queues - Write
Create business hours
Create new business hours. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_operating_hours:write:admin`,`contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:business_hour:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/business_hours - Write
Update business hours
Update business hours. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_operating_hours:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:business_hour:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/business_hours/{businessHourId} - Write
Create a closure set
Create a new closure set for use in queue and other object operating hours. Closure sets are used to display business closure hours. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin`,`contact_center_operating_hours:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:closure_hour:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/closures - Destructive
Delete business hours
Delete business hours. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_operating_hours:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:business_hour:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/business_hours/{businessHourId} - Destructive
Delete a closure set
Delete a closure set. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_operating_hours:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:closure_hour:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/closures/{closureSetId} - Destructive
Update a closure set
Update information about a closure set. Closure sets are used to contain business closure hours. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_operating_hours:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:closure_hour:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/closures/{closureSetId}
Queue Waiting Experiences
- Destructive
Assign a queue waiting experience interrupt menu strategy
Create or replace the menu of options offered to consumers during the queue waiting experience. Currently, the only supported queue channel type is voice. The request body separates language-neutral structural configuration from language-specific messages and audio — see the request body description for details. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /contact_center/queue_waiting_experiences/{queueId}/interrupt_menu - Destructive
Delete a queue waiting experience interrupt menu strategy
Remove the interrupt menu configuration from the queue waiting experience. This deletes all menu-based interrupt settings including menu options, callback settings, voice prompts, and timing configurations. - When `bucket_id` is **omitted**, the queue-level interrupt menu and its callback settings are deleted. Bucket-level overrides are not affected and must be deleted separately. - When `bucket_id` is **provided**, only that bucket's interrupt-menu override is removed. The queue-level menu remains in effect. Only the menu interrupt is removed - `notify` and `audio` interrupts on the same queue or bucket are left untouched. This operation is **idempotent**, deleting when no interrupt menu is configured returns `204` without error. This operation only works for voice queues. Other channel types return an error. **Scopes** `contact_center:update:queue:admin` **Granular Scopes** `contact_center:update:queue:admin` **Rate Limit Label** `Light` **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/queue_waiting_experiences/{queueId}/interrupt_menu
Queues
- Read
List queue templates
Retrieve a list of queue templates. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/queue_templates - Read
Get a queue template
Retrieve a Contact Center queue template. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/queue_templates/{queueTemplateId} - Read
List queues
Get information about all available queues. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_queues:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/queues - Read
Get a queue
Returns detailed information about a specific Contact Center queue, including its name, description, channel, assigned resources, and configuration settings. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/queues/{queueId} - Read
List queue agents
Retrieve the list of Contact Center users assigned to a queue, including their agent persona assignments for that queue. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_queue_agents:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/queues/{queueId}/agents - Read
List queue dispositions
Return a list of queue's [dispositions](https://support.zoom.us/hc/en-us/articles/4470153057549-Managing-dispositions). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_dispositions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/queues/{queueId}/dispositions - Read
List queue disposition sets
Return a list of queue's disposition sets(https://support.zoom.us/hc/en-us/articles/4470153057549-Managing-dispositions). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_disposition_sets:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/queues/{queueId}/dispositions/sets - Read
Get a queue's interrupt settings
Retrieve the interrupt settings for a specific queue, including audio interrupts and notify interrupts. If set up, returns detailed information about custom audio configurations. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/queues/{queueId}/interrupt - Read
Get a queue's operating hours
Get information about a queue's operating hours. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:queue_operating_hours:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/queues/{queueId}/operating_hours - Read
List queue recordings
Return a list of all recordings in a queue. **Note** Use recording-related APIs to manipulate data whose recording was created after July 18, 2022. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_recording:read:admin`,`contact_center_recording:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_recordings:admin`,`contact_center:read:list_recordings` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/queues/{queueId}/recordings - Read
List queue scheduled callback variables
Retrieve a paginated list of scheduled callback variables available for use in a queue's scheduled callback settings. Variables can be filtered by group and searched by keyword. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/queues/{queueId}/scheduled_callback_variables - Read
List a queue's scheduled callbacks availability
List scheduled callbacks booking slots for a scheduler set up under a queue. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/queues/{queueId}/scheduled_callbacks/supportive_slots - Read
List queue supervisors
Retrieve the list of a queue's assigned Contact Center users with supervisor persona assignment to the Contact Center queue. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:queue_supervisor:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/queues/{queueId}/supervisors - Write
Create a queue template
Create a Contact Center queue template. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /contact_center/queue_templates - Write
Update a queue template
Update a Contact Center queue template. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/queue_templates/{queueTemplateId} - Write
Create a queue
Create a [queue](https://support.zoom.us/hc/en-us/articles/4423986595085) that determines which agents handle incoming engagements - voice, video, chat, messaging, email, and other channels. Each queue links to an existing routing profile that determines how engagements are distributed to available agents based on configurable rules and priorities. Returns the created queue, including its server-assigned `queue_id`. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/queues - Write
Batch create queues with a template
Create bulk of contact center queues with templateId. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /contact_center/queues/batch - Write
Assign queue agents
Assign users to a Contact Center queue as agent persona. The API response will contain only those users confirmed to have been assigned to the queue, and ignores any unrecognized user ID or users already assigned to the queue. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:queue_agent:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /contact_center/queues/{queueId}/agents - Write
Update a queue agent's opt-in/opt-out status
Updates the opt-in or opt-out status of an agent assigned to a Contact Center queue. Use this endpoint to control whether an agent receives engagements from the specified queue. Opting an agent out temporarily removes them from the queue's routing pool without removing their queue assignment. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:queue_agent:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/queues/{queueId}/agents/{userId} - Write
Assign queue dispositions
Add dispositions to a queue. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:queue disposition:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /contact_center/queues/{queueId}/dispositions - Write
Assign queue disposition sets
Add disposition sets to a queue. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:queue_disposition_set:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /contact_center/queues/{queueId}/dispositions/sets - Write
Update a queue's interrupt settings
Update the interrupt settings for a voice queue. While consumers wait to connect, the queue can interrupt the hold media to announce estimated wait time, position in queue, audio messages, or menu options. Configure interrupts to occur within the max wait duration. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/queues/{queueId}/interrupt - Write
Assign a queue menu based interrupt
Create a menu of options to offer to consumers during the queue waiting experience. Currently, the only support for queue channel type is voice. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/queues/{queueId}/interrupt_menu - Write
Update a queue's operating hours
Update a queue's operating hours. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:patch:queue_operating_hours:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/queues/{queueId}/operating_hours - Write
Schedule a callback on a queue
Schedule a callback on a queue. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
POST /contact_center/queues/{queueId}/scheduled_callbacks/events - Write
Assign queue supervisors
Assign users to a Contact Center queue as supervisor persona. The API response will contain only those users confirmed to have been assigned to the queue, and ignores any unrecognized user ID and users already assigned to the queue. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:queue_supervisor:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /contact_center/queues/{queueId}/supervisors - Write
Assign queue teams
Add teams to a queue. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:queue_team:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /contact_center/queues/{queueId}/teams - Destructive
Batch delete queue templates
Delete multiple Contact Center queue templates. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /contact_center/queue_templates - Destructive
Delete a queue template
Delete a Contact Center queue template. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/queue_templates/{queueTemplateId} - Destructive
Batch delete queues
Delete Contact Center queues in bulk. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /contact_center/queues/batch - Destructive
Delete a queue
Delete a specified queue. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/queues/{queueId} - Destructive
Update a queue
Update a queue's settings. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/queues/{queueId} - Destructive
Unassign a queue agent
Remove an agent from a Contact Center queue. The specified user will be unassigned from the queue and will no longer receive engagements routed through it. The user must be currently assigned as an agent to the queue. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:queue_agent:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/queues/{queueId}/agents/{userId} - Destructive
Unassign a queue disposition set
Delete a disposition set from a queue. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:queue_disposition_set:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/queues/{queueId}/dispositions/sets/{dispositionSetId} - Destructive
Unassign a queue disposition
Delete a disposition from a queue. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:queue_disposition:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/queues/{queueId}/dispositions/{dispositionId} - Destructive
Delete a queue's interrupt menu configuration
Deletes the interrupt menu configuration for a specific queue. This removes all menu-based interrupt settings including menu options, callback settings, voice prompts, and timing configurations. This operation only works for voice queues. Other channel types will return an error. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/queues/{queueId}/interrupt_menu - Destructive
Delete queue recordings
Delete all recordings in a queue. **Note** Use recording-related APIs to manipulate data whose recording creation time is after 2022-07-18. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_recording:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:recording:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/queues/{queueId}/recordings - Destructive
Delete an attendee from a scheduled callback event
Remove an attendee from an event slot on a scheduled callback. If the attendee is the last remaining participant in that event, the entire event is deleted. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
DELETE /contact_center/queues/{queueId}/scheduled_callbacks/attendees/{attendeeId} - Destructive
Unassign a queue supervisor
Remove a supervisor from a Contact Center queue. The specified user will be unassigned from the queue and will no longer have supervisory access to engagements routed through it. The user must be currently assigned as a supervisor to the queue. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:queue_supervisor:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/queues/{queueId}/supervisors/{userId} - Destructive
Unassign queue teams
Remove teams from a queue. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:queue_team:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /contact_center/queues/{queueId}/teams - Destructive
Unassign a queue team
Remove a team from a queue. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:queue_team:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /contact_center/queues/{queueId}/teams/{teamId}
RTMS
- Destructive
Update engagement Real-Time Media Streams (RTMS) app status
Update the RTMS status for a specific engagement. Contact Center allows changing status [start, pause, resume, stop] for RTMS at the engagement level. **Prerequisites:** * The app has a media scope assigned in the Zoom Marketplace. * The app has an OpenAPI scope assigned in the Zoom Marketplace. * The app has queues assigned in the Contact Center web portal. * The engagement must be in progress. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_rtms:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:engagement_rtms_app_status`,`contact_center:update:engagement_rtms_app_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /contact_center/{engagementId}/rtms_app/status
Recordings
- Read
List engagement recordings
Return a list of all of an engagement's recordings. **Note:** Use recording-related APIs to manipulate data whose recording was created after July 18, 2022. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_recording:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_recordings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/engagements/{engagementId}/recordings - Read
List recordings
Return a list of available recordings. **Note** Use recording-related APIs to manipulate data whose recording was created after July 18, 2022. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_recording:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_recordings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/recordings - Read
Get a recording by call element ID
Returns an account's [call recording](https://support.zoom.us/hc/en-us/articles/360038521091-Accessing-and-sharing-call-recordings) by the call element's `callElementId`. **Prerequisites** * A Pro or higher account with Zoom Phone license * Account owner or admin privileges **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_recording:read`,`phone_recording:read:admin`,`phone:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_recording`,`phone:read:call_recording:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/call_element/{callElementId}/recording - Read
Get recording by call ID (deprecated)
Returns an account's [call recording](https://support.zoom.us/hc/en-us/articles/360038521091-Accessing-and-sharing-call-recordings) by the recording's `callId` or `callLogId`. **Note**: Returns the `file_url` in the JSON query results. **Prerequisites** * A Pro or higher account with Zoom Phone license * Account owner or admin privileges **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_recording:read`,`phone_recording:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_recording`,`phone:read:call_recording:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/call_logs/{id}/recordings - Read
Download a phone recording
Downloads the phone recording. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin`,`phone_recording:read`,`phone_recording:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_recording`,`phone:read:call_recording:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/recording/download/{fileId} - Read
Download a phone recording transcript
Downloads the phone recording transcript. **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin`,`phone_recording:read`,`phone_recording:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:recording_transcript`,`phone:read:recording_transcript:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/recording_transcript/download/{recordingId} - Read
Get call recordings
Returns an account's [call recordings](https://support.zoom.us/hc/en-us/articles/360038521091-Accessing-and-sharing-call-recordings). **Prerequisites:** * A Pro or higher account plan * A Zoom Phone license * Account owner or admin privileges **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_recording:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_recordings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/recordings - Read
Get user's recordings
Gets a user's [Zoom Phone recordings](https://support.zoom.us/hc/en-us/articles/360021336671-Viewing-Call-History-and-Recordings). For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin`,`phone_recording:read`,`phone_recording:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_recordings`,`phone:read:list_recordings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/users/{userId}/recordings - Write
Update auto delete field
Updates the auto delete field for recording. It only updates if you enable the **Auto Delete Data After Retention Duration** setting in the account settings for recordings. **Prerequisites:** * User must belong to a Business or Enterprise account * User must have a Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write`,`phone_recording:write`,`phone_recording:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_recording`,`phone:update:call_recording:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/recordings/{recordingId} - Destructive
Delete engagement recordings
Delete all recordings in a given engagement. **Note**: Use recording-related APIs to manipulate data whose recording creation time is after 2022-07-18. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_recording:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:recording:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/engagements/{engagementId}/recordings - Destructive
Delete a recording
Delete a selected recording. **Note**: Use recording-related APIs to manipulate data whose recording creation time is after 2022-07-18. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_recording:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:recording:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/recordings/{recordingId} - Destructive
Delete a call recording
Deletes a call recording. **Prerequisites:** * User must belong to a Business or Enterprise account * User must have a Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write`,`phone_recording:write`,`phone_recording:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_recording`,`phone:delete:call_recording:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/recordings/{recordingId} - Destructive
Update Recording Status
Updates the status of a single recording in account. **Prerequisites:** * User must belong to a Business or Enterprise account. * User must have a Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write`,`phone_recording:write`,`phone_recording:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_recording`,`phone:update:call_recording:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /phone/recordings/{recordingId}/status
Regions
- Read
List regions
Get information about all available regions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_region:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_regions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/regions - Read
Get a region
Get information about a region. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_region:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:region:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/regions/{regionId} - Read
List a region's users
Retrieve the list of a region's assigned Contact Center users. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_region:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_region_users:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/regions/{regionId}/users - Write
Create a region
Create a new region. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_region:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:region:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/regions - Write
Update a region
Update information for a region. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_region:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:udpate:region:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/regions/{regionId} - Write
Assign users to a region
Assign users to a region. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_region:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:region_user:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/regions/{regionId}/users - Destructive
Delete a region
Delete a site and move its members to another region. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_region:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:region:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/regions/{regionId}
Reports V1 (Legacy)
- Read
List agent leg reports
Generate a list of agent's leg reports. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:agent_report:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/analytics/agents/leg_metrics - Read
List agent's status history reports
Generate a list of an agent's status history reports. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:agent_status_report:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/analytics/agents/status_history - Read
List agent's time sheet reports
Generate a list of an agent's time sheet reports. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:agent_report:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/analytics/agents/time_sheets - Read
List historical detail reports
Retrieve historical engagement details. The maximum lookback time is 6 months. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement_report:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/analytics/historical/details/metrics - Read
List historical agent reports by queue
Generate detailed historical reports of agents from a specific queue. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:agent_report:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/analytics/historical/queues/agents/metrics - Read
List historical queue reports
Generate a list of historical queue reports. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:queue_report:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/analytics/historical/queues/metrics - Read
List historical queue's agents reports
Generate a list of a historical queue's agent reports. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:agent_report:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/analytics/historical/queues/{queueId}/agents/metrics
Reports V2 (CX Analytics)
- Read
List historical agent load dataset data
Generate a list of historical agent load dataset data. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:dataset_agent_load:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/analytics/dataset/historical/agent_load - Read
List historical agent performance dataset data
Generate a list of agent performance dataset raw data. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:dataset_agent_performance:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/analytics/dataset/historical/agent_performance - Read
List historical agent timecard dataset data
Generate a list of agent timecard dataset raw data. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:dataset_agent_timecard:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/analytics/dataset/historical/agent_timecard - Read
List historical custom report tabular data
Generate a list of tabular data based on the custom report after enabling the API in the CX Analytics. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:custom_report:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/analytics/dataset/historical/custom_reports/{reportId}/widgets/{widgetId} - Read
Get historical custom report tabular schema
Generate the schema information for a tabular based on the custom report after enabling API in the CX Analytics. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:custom_report:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/analytics/dataset/historical/custom_reports/{reportId}/widgets/{widgetId}/schema - Read
List historical disposition dataset data
View the historical disposition data for finished engagements in the Contact Center to conduct disposal data analysis, such as displaying the disposition data through dashboards or reports. Filter the results with the provided input parameters. The input filters are conjunctive. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:dataset_disposition:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/analytics/dataset/historical/disposition - Read
List historical engagement dataset data
Generate a list of engagement dataset raw data. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:dataset_engagement:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/analytics/dataset/historical/engagement - Read
List historical engagement timelines
Retrieve engagement timelines, including entities and segments, for engagements in a time range. Data is available after engagements have completed processing, not immediately after the engagements end. This API may return an empty or partial response while the data is persisting. Retry this request for up to 1 minute to get timeline details, if querying shortly after an [`engagement_ended` webhook event](/docs/api/contact-center/events/#tag/contact_center/postcontact_center.engagement_ended). Consider using a backoff between retries to avoid rate limiting. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement_timeline:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/analytics/dataset/historical/engagement_timelines - Read
List historical expert assist dataset data
Display expert assist dataset key metrics on the adoption of AI expert assist and its impact on key engagement measures. This data is available only after an engagement has ended and includes only those engagements where AI expert assist data is present. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:dataset_expert_assist:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/analytics/dataset/historical/expert_assist - Read
List historical flow performance dataset data
Generate a list of flow performance dataset raw data. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:dataset_flow_performance:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/analytics/dataset/historical/flow_performance - Read
List historical outbound dialer performance dataset data
Generate a list of outbound dialer performance dataset raw data. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:dataset_outbound_dialer_performance:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/analytics/dataset/historical/outbound_dialer_performance - Read
List historical queue performance dataset data
Generate a list of queue performance dataset raw data. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:dataset_queue_performance:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/analytics/dataset/historical/queue_performance - Read
List historical routing log performance dataset data
Generate a list of routing log performance dataset raw data. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:dataset_routing_log:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/analytics/dataset/historical/routing_log_performance - Read
List historical agent compliance logs
Generate a list of agent compliance logs. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_agent_compliance_logs:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/analytics/log/historical/agent_compliance - Read
List historical agent opt in or out logs
Generate a list of agent opt in or out logs. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_agent_opt_logs:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/analytics/log/historical/agent_opt - Read
List historical agent work session logs
Generate a list of agent work session logs. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_agent_work_session_logs:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/analytics/log/historical/agent_work_session - Read
List historical engagement log data
Retrieve a list of all historical engagement log data. The log captures all details of closed engagements, including a timeline and key events, providing a clear record for tracking and analysis. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement_log:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/analytics/log/historical/engagement - Read
List historical Zoom Phone to Contact Center call journey data
View the complete customer journey of a call across both Contact Center and Zoom Phone. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:call_journey_log:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/analytics/log/historical/journey
Routing Profiles
- Read
List agent routing profiles
Returns a list of agent routing profiles. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_routing_profile:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:agent_routing_profile:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/agent_routing_profiles - Read
Get an agent routing profile
Retrieve the agent routing profile. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_routing_profile:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:agent_routing_profile:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/agent_routing_profiles/{agentRoutingProfileId} - Read
List consumer routing profiles
Return a list of consumer routing profiles. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_routing_profile:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:consumer_routing_profile:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/consumer_routing_profiles - Read
Get a consumer routing profile
Retrieve the consumer routing profile. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_routing_profile:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:consumer_routing_profile:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/consumer_routing_profiles/{consumerRoutingProfileId} - Write
Create an agent routing profile
Create an agent routing profile. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_routing_profile:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:agent_routing_profile:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/agent_routing_profiles - Write
Update an agent routing profile's details
Update an agent routing profile details. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_routing_profile:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:agent_routing_profile:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/agent_routing_profiles/{agentRoutingProfileId} - Write
Create a consumer routing profile
Create a consumer routing profile. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_routing_profile:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:consumer_routing_profile:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/consumer_routing_profiles - Write
Update a consumer routing profile's details
Update a consumer routing profile details. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_routing_profile:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:consumer_routing_profile:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/consumer_routing_profiles/{consumerRoutingProfileId} - Destructive
Delete an agent routing profile
Delete an agent routing profile. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_routing_profile:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:agent_routing_profile:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/agent_routing_profiles/{agentRoutingProfileId} - Destructive
Delete a consumer routing profile
Delete a consumer routing profile. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_routing_profile:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:consumer_routing_profile:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/consumer_routing_profiles/{consumerRoutingProfileId}
Skills
- Read
List skills
Return a list of a skills or a skill category's assigned skills. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_skill:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_skills:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/skills - Read
List skill categories
List all available skill categories and their information. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_skill:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_skill_categories:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/skills/categories - Read
Get a skill category
Return information about a specific skill category. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_skill:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:skill_category:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/skills/categories/{skillCategoryId} - Read
Get a skill
Return a skill's information and its usage. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_skill:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:skill:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/skills/{skillId} - Read
List skill users
Retrieve a list of users assigned to a skill. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_skill_users:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/skills/{skillId}/users - Write
Create a skill
Create a [skill](https://support.zoom.us/hc/en-us/articles/4423986613261) for skill-based routing. Skills are agent traits that ensure they are the right person to handle a customer interaction. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_skill:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:skill:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/skills - Write
Create a skill category
Create a new skill category. Skill categories let you assign several similar skills to a category, such as language skills. You can then route French-speaking callers to contact center agents that have the highest proficiency with French. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_skill:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:skill_category:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/skills/categories - Write
Update a skill category
Update a skill category. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_skill:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:skill_category:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/skills/categories/{skillCategoryId} - Write
Update a skill
Use this API to update a skill's name. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_skill:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:skill:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/skills/{skillId} - Destructive
Delete a skill category
Delete an existing skill category. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_skill:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:skill_category:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/skills/categories/{skillCategoryId} - Destructive
Delete a skill
Delete a skill. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_skill:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:skill:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/skills/{skillId}
Teams
- Read
List teams
Retrieve a list of all teams with details, including supervisors and agents. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_team:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:team:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/teams - Read
Get a team
Get information about a team. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_team:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:team:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/teams/{teamId} - Read
List team agents
Retrieve a list of a team's assigned agents. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_team:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:team:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/teams/{teamId}/agents - Read
List a team's child teams
Get a list of a team's child teams. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_team:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:team:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/teams/{teamId}/children - Read
List team's parent teams
Get a list of a team's parent teams. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_team:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:team:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/teams/{teamId}/parents - Read
List team supervisors
Lists the supervisors assigned to a specific team. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_team:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:team:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/teams/{teamId}/supervisors - Read
List Account Teams [Deprecated] (deprecated)
List account teams. Filter by parent team ID or team name. (deprecated) **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_team:read:admin`,`iq_team:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /iq/teams - Read
List Unassigned Team Users
List unassigned team zra users by page **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_team:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:unassigned_team_users:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /zra/team/unassigned_team_users - Read
Get Team Detail
Get team detail, such as team name, team description, team member size and etc. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_team:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:team:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /zra/team/{teamId} - Read
List Team Managers
List Team Managers **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_team:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:team_managers:admin`,`zra:read:team_managers` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /zra/team/{teamId}/team_managers - Read
List Team Members
List team members by page **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_team:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:team_members:admin`,`zra:read:team_members` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /zra/team/{teamId}/team_members - Read
List Account Teams
List account teams. Filter by parent team ID or team name. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_team:read:admin`,`iq_team:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:team_list:admin`,`zra:read:team_list` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /zra/teams - Write
Create a team
Create a new team. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_team:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:team:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/teams - Write
Update a team
Update a team's details. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_team:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:team:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/teams/{teamId} - Write
Assign team agents
Assign agents to a team. Assign one or more users as agents to the specified team. This API supports partial success - the response includes only the agents that were successfully assigned. Any user IDs that are invalid, unresolvable, or already assigned to the team will not appear in the response. To determine which users were not assigned, compare the returned agents list with the requested user IDs. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_team:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:team:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /contact_center/teams/{teamId}/agents - Write
Move a team
Move a team's level. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_team:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:team:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
PATCH /contact_center/teams/{teamId}/move - Write
Assign team supervisors
Assign supervisors to a team. Assign one or more users as supervisors to the specified team. This API supports partial success - the response includes only the supervisors that were successfully assigned. Any user IDs that are invalid, unresolvable, or already assigned to the team will not appear in the response. To determine which users were not assigned, compare the returned supervisors list with the requested user IDs. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_team:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:team:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /contact_center/teams/{teamId}/supervisors - Write
Create Team
Please create team one by one, if your account enable hierarchical structure team. We currently do not support concurrent hierarchical team creation **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_team:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:write:team:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
POST /zra/team - Write
Update Team name
Update the team name. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_team:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:update:team:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /zra/team/{teamId} - Write
Move team to new parent
Move current team under a new parent team. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_team:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:update:team:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
PATCH /zra/team/{teamId}/parent_team - Write
Assign Team Managers
Add team managers. Make sure your account support hierarchical structure team. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_team:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:write:team_manages:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
POST /zra/team/{teamId}/team_managers - Write
Assign Team Members
Add one or more users to a team. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_team:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:write:team_members:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
POST /zra/team/{teamId}/team_members - Destructive
Delete a team
Delete a specified team. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_team:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:team:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
DELETE /contact_center/teams/{teamId} - Destructive
Unassign team agents
Unassign agents from a team. The API is all-or-nothing. On success - Returns HTTP 204 No Content - all supervisors unassigned On failure - Throws an exception and returns an error response - no agents unassigned **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_team:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:team:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /contact_center/teams/{teamId}/agents - Destructive
Unassign team supervisors
Unassign supervisors from a team. The API is all-or-nothing. On success - Returns HTTP 204 No Content - all supervisors unassigned On failure - Throws an exception and returns an error response - no supervisors unassigned **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_team:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:team:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /contact_center/teams/{teamId}/supervisors - Destructive
Delete Team
Please delete team one by one, if your account enable hierarchical structure team. We currently do not support concurrent hierarchical team deletion. And if you want to delete flat team, you should make sure that the team members of the target team are empty. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_team:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:delete:team:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
DELETE /zra/team/{teamId} - Destructive
Unassign Team Managers
Delete team managers. Make sure your account support hierarchical structure team. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_team:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:delete:team_managers:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
DELETE /zra/team/{teamId}/team_managers - Destructive
Unassign Team Members
Delete members of the team. Make sure to delete less than 30 users at one time. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_team:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:delete:team_members:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
DELETE /zra/team/{teamId}/team_members
Users
- Read
List user profiles
Returns a list of Contact Center users. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_users:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/users - Read
List user templates
Return the user template list **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:user_templates:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/users/templates - Read
Get a user template
Get a user template. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:user_templates:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/users/templates/{templateId} - Read
Get a user's profile
Retrieve a Contact Center user. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:user:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/users/{userId} - Read
List a user's queues
List the Contact Center queues that a user is assigned to. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_user_queues:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/users/{userId}/queues - Read
List a user's recordings
List a user's Contact Center recordings. **Note** Recordings are not available before July 18th, 2022. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_recording:read`,`contact_center_recording:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_recordings:admin`,`contact_center:read:list_recordings` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/users/{userId}/recordings - Read
List a user's skills
Get a list of skills assigned to a given user. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_skill:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_user_skills:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/users/{userId}/skills - Read
Get User info
Get Zoom Revenue Accelerator (ZRA) user information, including user region and user segment, for a set of users within your own account. Provide a comma-separated list of user IDs (up to 20 per request) and the API returns each user's basic profile and ZRA attributes. Only users belonging to the authenticated account are returned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra_user:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:user`,`zra:read:user:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /zra/users - Read
List phone users
Returns a list of all of an account's users who are assigned a Zoom Phone license. **Prerequisites** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_users:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/users - Read
Get a user's profile
Returns a user's [Zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) profile. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:user`,`phone:read:user:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/users/{userId} - Read
Get user call handling setting
Returns the call handling setting of a user for the specified hour type. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:user_call_handling_setting:admin`,`phone:read:user_call_handling_setting` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/users/{userId}/call_handling/settings - Read
List users' phone numbers for a customized outbound caller ID
Retrieves phone numbers that can be the `user-level` customized outbound caller ID. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_user_customized_number`,`phone:read:list_user_customized_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/users/{userId}/outbound_caller_id/customized_numbers - Read
Get user policy details
Returns the user policy details. **Prerequisites** * Pro or higher account plan with Zoom phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:user_policy:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/users/{userId}/policies/{policyType} - Read
Get a user's profile settings
Returns the Zoom Phone [profile settings](https://support.zoom.us/hc/en-us/articles/360021325712-Configuring-Settings) of 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. **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:user_setting:admin`,`phone:read:user_setting` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/users/{userId}/settings - Read
List users
Retrieve a list of your account's users. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read`,`user:write`,`user:read:admin`,`user:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read:list_users:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /users - Read
Check a user email
Verify if a user's email is registered with Zoom. <b>Note: </b>You can successfully check if a user is a registered Zoom user only if the user **signed up for Zoom via email and is within your account.** If you provide an email address of a user who is not in your account, the value of "existed_email" parameter will be "false" irrespective of whether or not the user is registered with Zoom. The response of this API call will not include users who joined Zoom using options such as "Sign in with SSO", "Sign in with Google" or "Sign in with Facebook" even if they are in the same account as yours. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read`,`user:write`,`user:read:admin`,`user:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read:email`,`user:read:email:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
GET /users/email - Read
Get the user's ZAK
Get the Zoom Access Key (ZAK) for the authenticated user associated with the access token in the API request. Use a ZAK to start or join a meeting on behalf of this user. ZAKs obtained with this endpoint expire five minutes after receipt. To get a ZAK for a different user or with a different expiration, use the [Get a user token](https://marketplace.zoom.us/docs/api-reference/zoom-api/methods#operation/userToken) API with the `zak` `type` query parameter. See [Getting a Zoom Access Key (ZAK)](https://developers.zoom.us/docs/meeting-sdk/auth/#start-meetings-and-webinars-with-a-zoom-users-zak-token) for details. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user_zak:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read:zak`,`user:read:zak:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
GET /users/me/zak - Read
Get user summary
Gets a summary of users, including the number and types of users in the account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read`,`user:write`,`user:read:admin`,`user:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read:summary:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /users/summary - Read
Check a user's PM room
A personal meeting room is a virtual meeting room that can be permanently assigned to a user. Use this API to check if a personal meeting room with the given name exists or not. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read`,`user:write`,`user:read:admin`,`user:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read:pm_room`,`user:read:pm_room:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
GET /users/vanity_name - Read
Get a user
View a user's information on a Zoom account. For user-managed apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter. **Note:** The `user_info:read` scope is only available when you pass the `me` value for the `$userId` value. Users who have not activated their account will have a `pending` status. These users' `created_at` timestamp will also display the time at which the API call was made, **not** the account's creation date. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read`,`user:write`,`user:read:admin`,`user:write:admin`,`user_profile`,`user_info:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read:user`,`user:read:user:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /users/{userId} - Read
List user assistants
List a user's assistants. 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. Assistants are users who the current user has assigned [scheduling privilege](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege). These assistants can schedule meetings on behalf of the current user, as well as manage and act as an alternative host for all meetings if the admin has enabled the [co-host option](https://zoom.us/account/setting) on the account. **Prerequisites:** * Current user as well as the assistant must have Licensed or an On-prem license. * Assistants must be under the current user's account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read`,`user:write`,`user:read:admin`,`user:write:admin`,`user_profile` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read:list_assistants`,`user:read:list_assistants:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /users/{userId}/assistants - Read
List a user's collaboration devices
List a user's collaboration devices. 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. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read`,`user:write`,`user:read:admin`,`user:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read:list_collaboration_devices`,`user:read:list_collaboration_devices:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /users/{userId}/collaboration_devices - Read
Get collaboration device detail
Get collaboration device detail. 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. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read`,`user:write`,`user:read:admin`,`user:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read:collaboration_device`,`user:read:collaboration_device:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /users/{userId}/collaboration_devices/{collaborationDeviceId} - Read
Get meeting summary templates
List meeting summary templates. 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. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read`,`user:read:admin`,`user:write:admin`,`user:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read:settings`,`user:read:settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /users/{userId}/meeting_summary_templates - Read
Get meeting template detail
Retrieve a user's [meeting template](https://support.zoom.us/hc/en-us/articles/360036559151-Meeting-templates). 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. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read:admin`,`user:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
GET /users/{userId}/meeting_templates/{meetingTemplateId} - Read
Get user permissions
Get permissions that have been granted to the 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. Users can be assigned a set of permissions that allows them to access only the pages or information that a user needs to view or edit. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read`,`user:write`,`user:read:admin`,`user:write:admin`,`user_profile` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read:list_permissions`,`user:read:list_permissions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /users/{userId}/permissions - Read
Get a user presence status
Returns a user's current status. Users in the Zoom desktop client and mobile apps are assigned with a [presence status](https://support.zoom.us/hc/en-us/articles/360032554051-Status-Icons). The presence status displays the user's availability. The available statuses are: * **Away** * **Do not disturb** * **Available** * **In a calendar event** * **Presenting** * **In a Zoom meeting** * **On a call** * **Out of Office** * **Busy** * **Offline** If the presence status is **Do not disturb**, `end_time` and `remaining_time` properties are only visible if the user being queried is also the current user. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read`,`user:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read:presence_status`,`user:read:presence_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /users/{userId}/presence_status - Read
List user schedulers
List all of a user's schedulers. 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. Schedulers in this context are users who can schedule meetings for the current user. For example, if the current user, the user whose `userId` was passed in the `path` parameter, is **User A**, this API's response will list all users for whom **User A** can schedule and manage meetings. **User A** is the assistant of these users, and thus has scheduling privilege for these users. **Prerequisites** * Current user must be under the same account as the scheduler. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read`,`user:write`,`user:read:admin`,`user:write:admin`,`user_profile` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read:list_schedulers`,`user:read:list_schedulers:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
GET /users/{userId}/schedulers - Read
Get user settings
Retrieve a user's settings. 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. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read`,`user:write`,`user:read:admin`,`user:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read:settings`,`user:read:settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /users/{userId}/settings - Read
Get user sensitive label settings
Get user sensitive label settings. **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /users/{userId}/settings/sensitive_label - Read
Get a user's token
Gets a user's Zoom token or Zoom Access Key (ZAK). 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. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read`,`user:write`,`user:read:admin`,`user:write:admin`,`user_profile` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:read:token`,`user:read:token:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /users/{userId}/token - Read
List users
Get all the users in the account. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:read:list_users:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /workforce-management/users - Write
Create a user's profile
Create a Contact Center user. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:user:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/users - Write
Batch update user profiles
Batch update Contact Center users. **Note** For each user object in the users array, you must provide either `user_id` or `user_email`. If both `user_id` and `user_email` are provided for the same user object, only `user_id` will be used, while `user_email` will be ignored. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:batch_users:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /contact_center/users - Write
Batch create user profiles
Batch create Contact Center users. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:batch_users:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /contact_center/users/batch - Write
Batch update user status
Batch update Contact Center users' statuses. **Note** Uses all-or-nothing validation - if any user fails validation, no updates are applied and all errors are returned. Only one batch request per account is allowed at a time. Concurrent requests receive a 429 error. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:batch_users:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /contact_center/users/status - Write
Create a user template
Create a user template. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:user_templates:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/users/templates - Write
Update a user template
Update a user template. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:user_templates:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /contact_center/users/templates/{templateId} - Write
Update a user's profile
Update a Contact Center user. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:user:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/users/{userId} - Write
Opt-in or opt-out a user's queues
Change a Contact Center user's opt-in or opt-out status for queues assigned to the user. Opting out prevents the user from receiving engagements from that queue if they are an agent. If `channel_type` is provided, queues are processed based on the `channel_type`. Otherwise, queues are processed based on `queue_ids`. The request is invalid if neither `channel_type` nor `queue_ids` are provided. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:queue_agent:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/users/{userId}/opt_in_out_queues - Write
Assign a user's skills
Assign [skills](https://support.zoom.us/hc/en-us/articles/4423986613261) to a user. Skills are user traits that ensure that a given agent is the best person to handle a given customer interaction. Proficiency ratings indicate the user's level of expertise or knowledge of that skill. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_skill:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:user_skill:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /contact_center/users/{userId}/skills - Write
Update a user's status
Update a user's status. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:user:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/users/{userId}/status - Write
Batch add users
Adds phone users in batch. You can add up to 10 users at a time. **Prerequisites** * The users must be active in your [Zoom account](https://marketplace.zoom.us/docs/api-reference/zoom-api/methods#tag/Users/operation/users). * Pro or higher account plan with Zoom phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:batch_users:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /phone/users/batch - Write
Update a user's profile
Updates a user's [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051-Zoom-Phone) profile. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. To add, update or remove the shared access members for voicemail and call recordings, use the [Add](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Users/operation/addUserSetting)/[Update](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Users/operation/updateUserSetting)/[Delete](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Users/operation/deleteUserSetting) a user's shared access setting API. **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:user`,`phone:update:user:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/users/{userId} - Write
Add user call forward setting
Adds Zoom Phone call forwarding numbers for a user under a specific hour type. Call forwarding settings let users route their inbound calls to one or more external phone numbers or external contacts during business, closed, holiday, or break hours. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:user_call_handling_setting`,`phone:write:user_call_handling_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/users/{userId}/call_forward_settings/{hourType} - Write
Update user call handling setting
Updates a user's call handling settings for the specified hour type. **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:user_call_handling_setting:admin`,`phone:update:user_call_handling_setting` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/users/{userId}/call_handling/settings/{hourType} - Write
Assign calling plan to a user
Assigns a [calling plan](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) to a [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051-Zoom-Phone) 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. **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:calling_plan`,`phone:write:calling_plan:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/users/{userId}/calling_plans - Write
Add phone numbers for users' customized outbound caller ID
Adds users' customized outbound caller ID phone numbers. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:user_customized_number`,`phone:write:user_customized_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/users/{userId}/outbound_caller_id/customized_numbers - Write
Update user policy
Updates a user's [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051-Zoom-Phone) policy. **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:user_policy:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/users/{userId}/policies/{policyType} - Write
Add a user's profile setting
Adds the user setting according to the setting type. **Prerequisites** * Pro or a higher account with Zoom Phone license. * Account owner or admin permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:user_setting:admin`,`phone:write:user_setting` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/users/{userId}/profile_settings/{settingType} - Write
Update a user's profile settings
Updates the Zoom Phone [profile settings](https://support.zoom.us/hc/en-us/articles/360021325712-Configuring-Settings) of 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. **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:user_setting`,`phone:update:user_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/users/{userId}/settings - Write
Add a user's shared access setting
Adds the user setting according to the setting type, specifically for delegation, intercom and shared access for voicemail, and call recordings. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. To see the shared access settings in the Zoom web portal, go to **Admin > Phone System Management > Users & Rooms** . Choose **Users** and select **User Policy**. Go to **Voicemail, Automatic Call Recording and Ad Hoc Call Recording**. To view the delegation and intercom setting in your Zoom web portal, navigate to **Admin > Phone System Management > Users & Rooms**. Choose the **Users** tab and select **User Settings** **Prerequisites:** * A Business or Enterprise account **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:shared_setting`,`phone:write:shared_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/users/{userId}/settings/{settingType} - Write
Update a user's shared access setting
Updates the user setting according to the setting type, specifically for delegation, intercom and shared access for voicemail and call recordings. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. To see the shared access settings in the Zoom web portal, go to **Admin > Phone System Management > Users & Rooms** . Choose **Users** and select **User Policy**. Go to **Voicemail, Automatic Call Recording and Ad Hoc Call Recording**. To view the delegation and intercom setting in your Zoom web portal, navigate to **Admin > Phone System Management > Users & Rooms**. Choose the **Users** tab and select **User Settings** **Prerequisites:** * A Business or Enterprise account **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:shared_setting`,`phone:update:shared_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/users/{userId}/settings/{settingType} - Write
Create users
Add a new user to your Zoom account. **Note** These rate limits apply when you use the `create` value for the `action` field. * 50 requests per day for **Free** accounts. * 1,500 requests per day for **Pro** accounts. * 10,000 requests per day for **Business+** accounts. **Prerequisites** * A Pro or higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write`,`user:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write:user:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /users - Write
Bulk update features for users
Update multiple features for a user. **Note** This endpoint can process a maximum of 30 users at a time. Furthermore, the endpoint is rate-limited to one request every 10 seconds. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write`,`user:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write:feature:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /users/features - Write
Add assistants
Assign assistants to a user. In the request body, provide either the user's ID or the user's email address. 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. Assistants are the users to whom the current user has assigned [scheduling privileges](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege). Assistants can schedule meetings on behalf of the current user, and can also manage and act as an alternative host for all meetings if the admin has enabled the [co-host option](https://zoom.us/account/setting) on the account. **Prerequisites:** * The user as well as the assistant must have Licensed or an On-prem license. * Assistants must be under the current user's account, or the assistants' account must be in the same organization as the current user's account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write:admin`,`user:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write:assistant`,`user:write:assistant:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /users/{userId}/assistants - Write
Upload a user's profile picture
Upload a user's profile picture. 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. Provide `multipart/form-data` as the value of the `content-type` header for this request. This API supports `.jpeg` and `.png` file formats. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write:admin`,`user:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write:profile_picture`,`user:write:profile_picture:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
POST /users/{userId}/picture - Write
Update meeting Waiting Room branding
Sets Meeting Waiting Room branding (logo, background image, video, welcome title/description, and layout) for the user. To update the settings for a user in a sub account, use the account-scoped version of this API and pass the account ID in the `accountId` path parameter. **Prerequisites:** * The account must be a paid account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write`,`user:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write:waiting_room_branding:admin`,`user:write:waiting_room_branding` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /users/{userId}/settings/meeting_waiting_room_branding - Write
Upload Virtual Background files
Use this API to [upload a Virtual Background files](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background) to a user's profile. 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:** * A user profile cannot exceed more than 10 Virtual Background files. * You can only upload image files that are in JPG/JPEG, GIF or PNG format. * Video files must be in MP4 or MOV file format with a minimum resolution of 480 by 360 pixels (360p) and a maximum resolution of 1920 by 1080 pixels (1080p). * The Virtual Background file size cannot exceed 15 megabytes (MB). **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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write:admin`,`user:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write:virtual_background_files`,`user:write:virtual_background_files:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /users/{userId}/settings/virtual_backgrounds - Write
Update webinar Waiting Room branding
Sets the webinar Waiting Room branding (logo, background image, video, welcome title/description, and layout) for the user. To update the settings for a user in a sub account, use the account-scoped version of this API and pass the account ID in the `accountId` path parameter. **Prerequisites:** * The account must be a paid account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write`,`user:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write:waiting_room_branding`,`user:write:waiting_room_branding:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /users/{userId}/settings/webinar_waiting_room_branding - Destructive
Batch delete user profiles
Batch delete Contact Center users. **Note** Either `user_ids` or `user_emails` needs to be provided. If both `user_ids` and `user_emails` are provided, only `user_ids` will be used, while `user_emails` will be ignored. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:batch_users:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /contact_center/users - Destructive
Delete a user template
Delete a user template. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:user_templates:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
DELETE /contact_center/users/templates/{templateId} - Destructive
Delete a user's profile
Delete a Contact Center user. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:user:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/users/{userId} - Destructive
Delete a user's recordings
Delete **all** of a user's Contact Center recordings. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_recording:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:recording:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/users/{userId}/recordings - Destructive
Unassign a user's skill
Remove a skill from a Contact Center user. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_skill:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:user_skill:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/users/{userId}/skills/{skillId} - Destructive
Update multiple users' properties in batch
Updates multiple users' properties in batch. For example, you can update the users' [site](https://support.zoom.us/hc/en-us/articles/360020809672) when `batchType` is equal to `move_site`. You can update 10 users at a time. **Prerequisites:** * Business, or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:batch_users:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /phone/users/batch - Destructive
Delete user call forward setting
Delete Zoom Phone call forwarding numbers for a user under a specific hour type. Call forwarding settings let users route their inbound calls to one or more external phone numbers or external contacts during business, closed, holiday, or break hours. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:user_call_handling_setting`,`phone:delete:user_call_handling_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/users/{userId}/call_forward_settings/{hourType} - Destructive
Update user's calling plan
Switches the [calling plans](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) of a [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051-Zoom-Phone) 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. **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:calling_plan`,`phone:update:calling_plan:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /phone/users/{userId}/calling_plans - Destructive
Unassign user's calling plan
Unassigns a [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051) user's [calling plan](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans). For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:users_calling_plan`,`phone:delete:users_calling_plan:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/users/{userId}/calling_plans/{planType} - Destructive
Remove users' customized outbound caller ID phone numbers
Removes the users' customized outbound caller ID phone numbers. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:user_customized_number`,`phone:delete:user_customized_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/users/{userId}/outbound_caller_id/customized_numbers - Destructive
Delete a user's profile setting
Deletes a user setting based on the setting type. **Prerequisites** * Pro or higher account with Zoom Phone license. * Account owner or admin permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:user_setting`,`phone:delete:user_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/users/{userId}/profile_settings/{settingType} - Destructive
Delete a user's shared access setting
Removes the user setting according to the setting type, specifically for delegation, intercom and shared access for voicemail and call recordings. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. To see the shared access settings in the Zoom web portal, go to **Admin > Phone System Management > Users & Rooms** . Click **Users** and select **User Policy**. Go to **Voicemail, Automatic Call Recording and Ad Hoc Call Recording**. To view the delegation and intercom setting in your Zoom web portal, navigate to **Admin > Phone System Management > Users & Rooms**. Click the **Users** tab and select **User Settings** **Prerequisites:** * A Business or Enterprise account **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:shared_setting`,`phone:delete:shared_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/users/{userId}/settings/{settingType} - Destructive
Delete a user
**Disassociate** (unlink) a user or permanently **delete** a user. **Disassociating** a user unlinks the user from the associated Zoom account and provides the user their own basic free Zoom account. The disassociated user can then purchase their own Zoom licenses. An account owner or account admin can transfer the user's meetings, webinars, and cloud recordings to another user before disassociation. **Deleting** a user permanently removes the user and their data from Zoom. Users can create a new Zoom account using the same email address. An account owner or an account admin can transfer meetings, webinars, and cloud recordings to another Zoom user account before deleting. 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. **Note:** This API does not support the deletion requirements of a [Data Subject Access Request (DSAR)](https://dataprivacymanager.net/what-is-data-subject-access-request-dsar/). For a DSAR request, contact Zoom Support. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write:admin`,`user:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:delete:user`,`user:delete:user:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /users/{userId} - Destructive
Update a user
Updates a user's [Zoom profile](https://support.zoom.us/hc/en-us/articles/201363203-My-Profile) information. **Note**: If display_name is empty, the API endpoint derives the display_name from the first_name and last_name values. For user-level apps, pass [the `me` value](hhttps://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write:admin`,`user:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:update:user`,`user:update:user:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /users/{userId} - Destructive
Delete user assistants
Delete all of the current user's assistants. 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. Assistants are the users who the current user has assigned [scheduling privilege](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege). These assistants can schedule meeting on behalf of the current user, and manage and act as an alternative host for all meetings if the admin has enabled [co-host option](https://zoom.us/account/setting) on the account. **Prerequisites:** * The user as well as the assistant must have Licensed or an On-prem license. * Assistants must be under the current user's account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write:admin`,`user:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:delete:assistant`,`user:delete:assistant:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /users/{userId}/assistants - Destructive
Delete a user assistant
Delete a specific assistant of 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. Assistants are the users who the current user has assigned [scheduling privilege](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege). These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled [co-host option](https://zoom.us/account/setting) on the account. **Prerequisites:** * The user as well as the assistant must have Licensed or an On-prem license. * Assistants must be under the current user's account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write:admin`,`user:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:delete:assistant`,`user:delete:assistant:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /users/{userId}/assistants/{assistantId} - Destructive
Update a user's email
Change a user's [email address](https://support.zoom.us/hc/en-us/articles/201362563-How-Do-I-Change-the-Email-on-My-Account-) on a Zoom account that has managed domain set up. 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. * If the Zoom account in which the user belongs has multiple [managed domains](https://support.zoom.us/hc/en-us/articles/203395207-What-is-Managed-Domain-), then the email to be updated **must** match one of the managed domains. * A user's email address can be changed up to 3 times in any 24 hour period. **Prerequisites:** * Managed domain must be enabled in the account. * The new email address should not already exist in Zoom. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write:admin`,`user:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:update:email`,`user:update:email:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
PUT /users/{userId}/email - Destructive
Update a user's password
Update the [password](https://support.zoom.us/hc/en-us/articles/206344385-Change-a-User-s-Password) of a user using which the user can login to Zoom. 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. After this request is processed successfully, an email notification is sent to the user saying that the password was changed. **Prerequisites:** * Owner or admin of the Zoom account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write:admin`,`user:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:update:password`,`user:update:password:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
PUT /users/{userId}/password - Destructive
Delete a user's profile picture
Delete a user's profile picture. 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. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write:admin`,`user:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
DELETE /users/{userId}/picture - Destructive
Update a user's presence status
Update a user's presence status. 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. A user's status **cannot** be updated more than once per minute. For example, you can only submit a maximum of one update request per minute for a single user. Users in the Zoom desktop client and mobile apps are assigned with a [presence status](https://support.zoom.us/hc/en-us/articles/360032554051-Status-Icons). The presence status informs users of their contact's availability. Users can also change their own presence status to one the following: * **Away** * **Do not disturb** * **Available** * **In a calendar event** * **Presenting** * **In a Zoom meeting** * **On a call** * **Out of Office** * **Busy** Note that a user's presence status **cannot** be updated via this API if the user is not logged in to the Zoom client. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write`,`user:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:update:presence_status`,`user:update:presence_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PUT /users/{userId}/presence_status - Destructive
Delete user schedulers
Delete all of a user's schedulers. 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. Schedulers are users on whose behalf the current user (assistant) can schedule meetings for. By calling this API, the current user will no longer be a scheduling assistant of any user. **Prerequisites:** * Current user (assistant) must be under the same account as the scheduler. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write:admin`,`user:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:delete:scheduler`,`user:delete:scheduler:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /users/{userId}/schedulers - Destructive
Delete a scheduler
Delete a scheduler. 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. Schedulers are users who the current user (assistant) can schedule meetings on their behalf. By calling this API, the current user will no longer be a scheduling assistant of this scheduler. **Prerequisites:** * Current user must be under the same account as the scheduler. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write:admin`,`user:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:delete:scheduler`,`user:delete:scheduler:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /users/{userId}/schedulers/{schedulerId} - Destructive
Update user settings
Update a user's settings. For user-level apps, pass the [me](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) value, instead of the `userId` parameter. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write:admin`,`user:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:update:settings`,`user:update:settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /users/{userId}/settings - Destructive
Delete Virtual Background files
Use this API to delete a user's Virtual Background files. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. **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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write:admin`,`user:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:delete:virtual_background_files`,`user:delete:virtual_background_files:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /users/{userId}/settings/virtual_backgrounds - Destructive
Update user status
[Deactivate](https://support.zoom.us/hc/en-us/articles/115005269946-Remove-User-from-your-Account#h_6a9bc1c3-d739-4945-b1f2-00b3b88fb5cc) an active user or to [reactivate](https://support.zoom.us/hc/en-us/articles/115005269946-Remove-User-from-your-Account#h_16319724-d120-4be6-af5d-31582d134ea0) a deactivated 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. An account owner or admins can deactivate as well as activate a user in a Zoom account. Deactivating a user removes all licenses associated with a user, and prevents the deactivated user from logging into their Zoom account. A deactivated user can be reactivated. Reactivating a user grants the user access to log in to their Zoom account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write:admin`,`user:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:update:status`,`user:update:status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /users/{userId}/status - Destructive
Revoke a user's SSO token
Revokes a user's SSO token. 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. After calling this API, the SSO user will be logged out of their current Zoom session. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:write:admin`,`user:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `user:delete:token`,`user:delete:token:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /users/{userId}/token
Variables
- Read
List variable logs
Return a list of variable logs. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_variable_log:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_variable_logs:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /contact_center/variable_logs - Read
Get a variable log
Gets information about a variable log. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_variable_log:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:variable_log:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/variable_logs/{variableLogId} - Read
List variables
Returns a list of variables for a specific variable group. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_variable:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_variables:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/variables - Read
List variable groups
Returns a list of variable groups. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_variable:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:list_variable_groups:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contact_center/variables/groups - Read
Get a variable group
Gets information about a variable group. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_variable:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:variable_group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/variables/groups/{variableGroupId} - Read
Get a variable
Retrieve a variable. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_variable:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:variable:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /contact_center/variables/{variableId} - Write
Create a variable
Create a new variable. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_variable:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:variable:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/variables - Write
Create a variable group
Create a custom variable group. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_variable:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:write:variable_group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /contact_center/variables/groups - Write
Update a variable group
Update a variable group. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_variable:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:variable_group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/variables/groups/{variableGroupId} - Write
Update a variable
Update a variable. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_variable:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:update:variable:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /contact_center/variables/{variableId} - Destructive
Delete a variable log
Delete a variable log. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_variable_log:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:variable_log:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/variable_logs/{variableLogId} - Destructive
Delete a variable group
Delete a specified variable group. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_variable:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:variable_group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/variables/groups/{variableGroupId} - Destructive
Delete a variable
Delete a variable. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_variable:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:delete:variable:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /contact_center/variables/{variableId}
Account
- Read
Get Cisco/Polycom Room Account Setting
Retrieves details of the managed Cisco or Polycom rooms account profile settings. To get information on an individual room profile, use the Get managed room profile API. **Prerequisites** * The Zoom account must have a CRC subscription **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc_account:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc:read:rooms_account_settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /crc/managed_rooms/account_setting - Write
Update Cisco/Polycom Room Account Setting
Updates details of the managed Cisco/Polycom rooms account profile settings. **Prerequisites**: * The Zoom account must have a CRC subscription. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc_account:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc:update:rooms_account_settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /crc/managed_rooms/account_setting
Api Connector
- Read
List API Connectors
Returns the Enhanced API Connectors for Cisco or Polycom Rooms. **Prerequisites**: * The Zoom account must have a CRC subscription. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `apiconnector:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc:read:list_apiconnectors:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /crc/api_connectors - Read
Get an API Connector
Returns the details of an enhanced API connector. **Prerequisites**: * The Zoom account must have a CRC subscription. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `apiconnector:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc:read:apiconnector:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /crc/api_connectors/{connectorId} - Read
Get an API Connector's private key
Retrieves the private key of an Enhanced API Connector. **Prerequisites**: * The Zoom account must have a CRC subscription. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `apiconnector:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc:read:apiconnector_private_key:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /crc/api_connectors/{connectorId}/private_key - Write
Create an API Connector
Creates an Enhanced API Connector. **Prerequisites**: * The Zoom account must have a CRC subscription. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `apiconnector:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc:write:apiconnector:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /crc/api_connectors - Write
Update an API Connector
Updates the settings of an Enhanced API Connector. **Prerequisites**: * The Zoom account must have a CRC subscription. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `apiconnector:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc:update:apiconnector:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /crc/api_connectors/{connectorId} - Write
Update an API Connector's private key
Regenerates the enhanced API connector's private key. **Prerequisites**: * The Zoom account must have a CRC subscription. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `apiconnector:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc:update:apiconnector_private_key:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /crc/api_connectors/{connectorId}/private_key - Destructive
Delete an API Connector
Deletes an enhanced API connector. **Prerequisites**: * The Zoom account must have a CRC subscription. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `apiconnector:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc:delete:apiconnector:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /crc/api_connectors/{connectorId}
Cisco/Polycom Rooms
- Read
List Managed Rooms
Returns the Managed Cisco/Polycom rooms. **Prerequisites**: * The Zoom account must have a CRC subscription. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc_rooms:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc:read:list_rooms:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /crc/managed_rooms - Read
Get a Managed Room
Returns the details of a managed room. **Prerequisites** * The Zoom account must have a CRC subscription **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc_rooms:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc:read:room:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /crc/managed_rooms/{deviceId} - Write
Create a Managed Room
Creates a Managed Cisco/Poly Room. **Prerequisites**: * The Zoom account must have a CRC subscription. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc_rooms:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc:write:room:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /crc/managed_rooms - Write
Update a Managed Room
Updates the settings of a Cisco or Polycom Room. **Prerequisites** * The Zoom account must have a CRC subscription **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc_rooms:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc:update:room:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /crc/managed_rooms/{deviceId} - Destructive
Delete a managed room
Deletes a managed Cisco/Poly Room. **Prerequisites**: * The Zoom account must have a CRC subscription. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc_rooms:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc:delete:room:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /crc/managed_rooms/{deviceId}
Participant
- Read
Get participant identifier code
Authenticate CRC meetings. **Prerequisites** * The Zoom account must have a CRC subscription **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc:read:admin`,`crc:master` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc:read:participant_identifier_code:admin`,`crc:read:participant_identifier_code:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /crc/participant_identifier_code
Room Template
- Read
List Room Templates
Returns the Managed Cisco/Polycom rooms Templates. **Prerequisites**: * The Zoom account must have a CRC subscription. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc_rooms:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc:read:list_rooms_templates:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /crc/room_templates - Read
Get a Room Template
Returns the details of a Cisco/Polycom room template. **Prerequisites** * The Zoom account must have a CRC subscription **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc_rooms:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc:read:rooms_template:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /crc/room_templates/{templateId} - Write
Create a Room Template
Creates a Managed Cisco/Poly Room. **Prerequisites** * The Zoom account must have a CRC subscription **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc_rooms:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc:write:rooms_template:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /crc/room_templates - Write
Update a Room Template
Updates the settings of a Cisco/Polycom Room Template. **Prerequisites** * The Zoom account must have a CRC subscription **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc_rooms:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc:update:rooms_template:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /crc/room_templates/{templateId} - Destructive
Delete a room template
Deletes a Managed Cisco/Poly Room Template. **Prerequisites**: * The Zoom account must have a CRC subscription. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc_rooms:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `crc:delete:rooms_template:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /crc/room_templates/{templateId}
KeyConnector Archival API
- Read
Key connector archival API
Get the plain key by a key ID and encrypt context. See [Zoom Customer Managed Key](https://www.zoom.com/en/products/cmk/) and [Key connector archival API authentication](/docs/api/references/key-connector-archival-auth/) for details. **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
POST /kms/cse/archival/datakey/decrypt
Attendee Actions
- Read
List event attendee actions
Retrieves the attendee actions performed by the host for an event. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_attendee_actions:read`,`zoom_events_attendee_actions:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_attendee_actions`,`zoom_events:read:list_attendee_actions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId}/attendee_action - Read
List session attendee actions
Retrieves the attendee actions performed by the host for an event session. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_attendee_actions:read`,`zoom_events_attendee_actions:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_session_attendee_actions`,`zoom_events:read:list_session_attendee_actions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId}/sessions/{sessionId}/attendee_action - Write
Update event attendee actions
Retrieves attendee onsite action for an event. You can perform actions such as onsite check-in for a single attendee or up to 300 attendees in a batch operation. In the case of a batch operation, the API response can be a partial success. Any errors are returned in the **errors** object. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_attendee_actions:write`,`zoom_events_attendee_actions:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:batch_attendee_actions`,`zoom_events:update:batch_attendee_actions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /zoom_events/events/{eventId}/attendee_action - Write
Update session attendee actions
Performs attendee onsite action for an event session. You can perform actions such as onsite check-in for a single attendee or up to 300 attendees in a batch operation. In the case of a batch operation, the API response can be a partial success. Any errors are returned in the **errors** object. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_attendee_actions:write`,`zoom_events_attendee_actions:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:batch_session_attendee_actions`,`zoom_events:update:batch_session_attendee_actions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /zoom_events/events/{eventId}/sessions/{sessionId}/attendee_action
Co Editors
- Read
List coeditors
Retrieves the list of co-editors and their edit permissions for an event. Co-editors can make changes to the event details. Co-editors have view permission to all sections of the event. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_coeditors:read`,`zoom_events_coeditors:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_coeditors`,`zoom_events:read:list_coeditors:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId}/coeditors - Destructive
Add or remove event co-editors
Adds or removes event co-editor actions. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_coeditor:write`,`zoom_events_coeditor:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:coeditor`,`zoom_events:write:coeditor:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /zoom_events/events/{eventId}/coeditors
Emails
- Read
List event email types
Get the list of email types defined for an event. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_email:read`,`zoom_events_email:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_email_types`,`zoom_events:read:list_email_types:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId}/email_types - Read
List event emails sent status
Get the list of email sent status for an event email type. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_email:read`,`zoom_events_email:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_emails_status`,`zoom_events:read:list_emails_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId}/email_types/{emailTypeId}/send_status
Event Access
- Read
List event access links
Retrieves a list of all the event's access links associated with the event. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_access_links:read:admin`,`zoom_events_access_links:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_access_links`,`zoom_events:read:list_access_links:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId}/access_links - Read
Get event access link
Retrieves event access link information. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_access_links:read`,`zoom_events_access_links:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:access_links`,`zoom_events:read:access_links:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId}/access_links/{accessLinkId} - Write
Create event access link
Creates an access link for an event. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_access_links:write`,`zoom_events_access_links:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:access_links`,`zoom_events:write:access_links:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /zoom_events/events/{eventId}/access_links - Write
Update event access
Updates the event access for an event ID. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_access_links:write`,`zoom_events_access_links:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:access_links`,`zoom_events:update:access_links:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /zoom_events/events/{eventId}/access_links/{accessLinkId} - Destructive
Delete event access link
Deletes an event access link. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_access_links:write`,`zoom_events_access_links:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:delete:access_links`,`zoom_events:delete:access_links:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /zoom_events/events/{eventId}/access_links/{accessLinkId}
Events
- Read
List events
Retrieves all events associated with the user. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_basic:read`,`zoom_events_basic:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_events`,`zoom_events:read:list_events:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events - Read
Get an event
Returns information on a specified event. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_basic:read`,`zoom_events_basic:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:event`,`zoom_events:read:event:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId} - Write
Create an event
Creates an event. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_basic:write`,`zoom_events_basic:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:event`,`zoom_events:write:event:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /zoom_events/events - Write
Update an event
Updates an event. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_basic:write`,`zoom_events_basic:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:event`,`zoom_events:update:event:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /zoom_events/events/{eventId} - Destructive
Delete an event
Delete a draft event. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_basic:write`,`zoom_events_basic:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:delete:event`,`zoom_events:delete:event:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /zoom_events/events/{eventId} - Destructive
Event actions
Updates the event actions that the host performs for an event. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_basic:write`,`zoom_events_basic:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:event`,`zoom_events:write:event:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /zoom_events/events/{eventId}/event_actions
Exhibitors
- Read
List exhibitors
Lists all exhibitors associated with an event. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_exhibitors:read:admin`,`zoom_events_exhibitors:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_exhibitors`,`zoom_events:read:list_exhibitors:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId}/exhibitors - Read
Get an exhibitor
Returns the exhibitor information of a specified event. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_exhibitors:read`,`zoom_events_exhibitors:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:exhibitor`,`zoom_events:read:exhibitor:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId}/exhibitors/{exhibitorId} - Read
List sponsor tiers
Lists all sponsor tiers associated with an event. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_exhibitors:read:admin`,`zoom_events_exhibitors:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_sponsor_tiers`,`zoom_events:read:list_sponsor_tiers:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId}/sponsor_tiers - Write
Create an exhibitor
Creates an exhibitor for a multi-session and conference-type event. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_exhibitors:write`,`zoom_events_exhibitors:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:exhibitor`,`zoom_events:write:exhibitor:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /zoom_events/events/{eventId}/exhibitors - Write
Update exhibitor for an event
Updates the exhibitor for an event ID. This operation is only allowed for a multi-session event type. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_exhibitors:write`,`zoom_events_exhibitors:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:exhibitor`,`zoom_events:update:exhibitor:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /zoom_events/events/{eventId}/exhibitors/{exhibitorId} - Destructive
Delete an exhibitor
Deletes an exhibitor. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_exhibitors:write`,`zoom_events_exhibitors:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:delete:exhibitor`,`zoom_events:delete:exhibitor:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /zoom_events/events/{eventId}/exhibitors/{exhibitorId}
Hubs
- Read
List hubs
Retrieves a list of event hubs. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_hubs:read`,`zoom_events_hubs:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_hubs`,`zoom_events:read:list_hubs:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/hubs - Read
List hub Hosts
Retrieves a list of hub hosts. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus/Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_hubs:read:admin`,`zoom_events_hubs:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_hub_hosts`,`zoom_events:read:list_hub_hosts:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/hubs/{hubId}/hosts - Read
List hub videos
Lists the video/recording resources of a hub. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_hubs:read`,`zoom_events_hubs:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_hub_videos`,`zoom_events:read:list_hub_videos:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/hubs/{hubId}/videos - Write
Creates a new hub host
Add a host to the hub. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_hub:write`,`zoom_events_hub:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:hub_host`,`zoom_events:write:hub_host:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /zoom_events/hubs/{hubId}/hosts - Destructive
Remove hub host
Delete a host from the hub. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_hub:write`,`zoom_events_hub:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:delete:hub_host`,`zoom_events:delete:hub_host:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /zoom_events/hubs/{hubId}/hosts/{hostUserId}
Insights
- Read
Get attendee engagement data
Retrieves engagement data for a specific attendee in a Zoom Events hub. **Scoping** - Omit `event_id` → hub-scoped (aggregated across all events in the hub) - Provide `event_id` → event-scoped (single event within the hub) **Engagement types** - `Certification` — Certification completion status and progress **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_insights:read`,`zoom_events_insights:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:attendee_engagement`,`zoom_events:read:attendee_engagement:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/hubs/{hubId}/attendee_insights/engagement
Registrants
- Read
List registrants
Retrieves event registrants. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_registrants:read`,`zoom_events_registrants:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_registrants`,`zoom_events:read:list_registrants:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId}/registrants - Read
List session attendees
Retrieves session attendees. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_registrants:read`,`zoom_events_registrants:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_session_attendees`,`zoom_events:read:list_session_attendees:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId}/sessions/{sessionId}/attendees
Speakers
- Read
List speakers
Retrieves a list of speakers for an event. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_speakers:read`,`zoom_events_speakers:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_speakers`,`zoom_events:read:list_speakers:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId}/speakers - Read
Get a speaker
Returns information on a specific speaker. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_speakers:read`,`zoom_events_speakers:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:speaker`,`zoom_events:read:speaker:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId}/speakers/{speakerId} - Write
Create a speaker
Creates a speaker for an event. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_speakers:write`,`zoom_events_speakers:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:speaker`,`zoom_events:write:speaker:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /zoom_events/events/{eventId}/speakers - Write
Update a speaker
Updates the speaker information. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_speakers:write`,`zoom_events_speakers:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:speaker`,`zoom_events:update:speaker:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /zoom_events/events/{eventId}/speakers/{speakerId} - Destructive
Delete a speaker
Deletes a speaker. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_speakers:write`,`zoom_events_speakers:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:delete:speaker`,`zoom_events:delete:speaker:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /zoom_events/events/{eventId}/speakers/{speakerId}
Ticket Types
- Read
List registration questions for an event
List registration questions and fields that are to be answered by users while registering for an event. These questions are setup during the event level. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_ticket_types:read`,`zoom_events_ticket_types:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_registration_questions`,`zoom_events:read:list_registration_questions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId}/questions - Read
List ticket types
Lists all ticket types associated with an event. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_ticket_types:read`,`zoom_events_ticket_types:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_ticket_types`,`zoom_events:read:list_ticket_types:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId}/ticket_types - Read
List registration questions for ticket type
List registration questions and fields that are to be answered by users while registering for an event. These questions are setup at ticket_type level. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_ticket_types:read`,`zoom_events_ticket_types:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_registration_questions`,`zoom_events:read:list_registration_questions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId}/ticket_types/{ticketTypeId}/questions - Write
Create an event ticket type
Creates a ticket type for the event ID that is not allowed for single session and recurring event types. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_ticket_types:write`,`zoom_events_ticket_types:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:ticket_type`,`zoom_events:write:ticket_type:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /zoom_events/events/{eventId}/ticket_types - Write
Update ticket type for an event
Updates the ticket type for an event ID not allowed for a single session event type. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_ticket_types:write`,`zoom_events_ticket_types:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:ticket_type`,`zoom_events:update:ticket_type:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /zoom_events/events/{eventId}/ticket_types/{ticketTypeId} - Destructive
Update registration questions for an event
Updates registration questions and fields that are to be answered by users while registering for an event. These questions are setup at event level. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_ticket_types:write`,`zoom_events_ticket_types:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:registraion_question`,`zoom_events:update:registraion_question:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /zoom_events/events/{eventId}/questions - Destructive
Delete a ticket type
Deletes a ticket type of an event that is not allowed for a single session event type. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_ticket_types:write`,`zoom_events_ticket_types:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:delete:ticket_type`,`zoom_events:delete:ticket_type:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /zoom_events/events/{eventId}/ticket_types/{ticketTypeId} - Destructive
Update registration questions for ticket type
Updates registration questions and fields that are to be answered by users while registering for an event. These questions are setup at ticket_type level. This API is not allowed for single session event type. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_ticket_types:write`,`zoom_events_ticket_types:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:registraion_question`,`zoom_events:update:registraion_question:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /zoom_events/events/{eventId}/ticket_types/{ticketTypeId}/questions
Tickets
- Read
List tickets
Retrieves the ticket information of an event. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus/ Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_tickets:read`,`zoom_events_tickets:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_tickets`,`zoom_events:read:list_tickets:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId}/tickets - Read
Get a ticket
Retrieves information on a specific ticket. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_tickets:read`,`zoom_events_tickets:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:ticket`,`zoom_events:read:ticket:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/events/{eventId}/tickets/{ticketId} - Write
Create tickets
Creates tickets for an event. You can add a single ticket or up to 30 tickets in a batch operation. Please note that this request uses the [`pre-registration`](https://support.zoom.us/hc/en-us/articles/13475985512973-Pre-registering-Zoom-Events-guests) flow. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_tickets:write`,`zoom_events_tickets:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:ticket`,`zoom_events:write:ticket:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /zoom_events/events/{eventId}/tickets - Write
Update ticket
Updates ticket questions for the given ticket ID and event ID. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_tickets:write`,`zoom_events_tickets:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:ticket`,`zoom_events:write:ticket:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /zoom_events/events/{eventId}/tickets/{ticketId} - Destructive
Delete a ticket
Deletes a ticket. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_tickets:write`,`zoom_events_tickets:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:delete:ticket`,`zoom_events:delete:ticket:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /zoom_events/events/{eventId}/tickets/{ticketId}
Video On-Demand
- Read
List channels
Retrieves the channel information for a hub. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_channels:read`,`zoom_events_vod_channels:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_all_vod_channels`,`zoom_events:read:list_all_vod_channels:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/hubs/{hubId}/vod_channels - Read
Get VOD channel details
Returns VOD channel details. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_channels:read`,`zoom_events_vod_channels:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:vod_channel`,`zoom_events:read:vod_channel:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/hubs/{hubId}/vod_channels/{channelId} - Read
List VOD channel videos
Lists VOD channel videos. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_channels:read`,`zoom_events_vod_channels:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:list_vod_channel_videos`,`zoom_events:read:list_vod_channel_videos:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/hubs/{hubId}/vod_channels/{channelId}/videos - Write
Create VOD channel
Creates a channel for managing hub videos. Please check this support page for details about a [video channel](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057579#h_01HBVW2WZ06MFH7KHGPSJC9YKG). **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_channels:write`,`zoom_events_vod_channels:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:vod_channel`,`zoom_events:write:vod_channel:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /zoom_events/hubs/{hubId}/vod_channels - Write
Update VOD channel
Updates a hub video channel. Please check this support page for details about a [video channel](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057579#h_01HBVW2WZ06MFH7KHGPSJC9YKG). **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_channels:write`,`zoom_events_vod_channels:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:vod_channel`,`zoom_events:update:vod_channel:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /zoom_events/hubs/{hubId}/vod_channels/{channelId} - Write
VOD channel actions
Returns VOD channel action result. **Prerequisites**: * A Pro or higher account plan. * A Zoom Webinars Plus or Events license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_channels:write`,`zoom_events_vod_channels:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:vod_channel`,`zoom_events:update:vod_channel:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /zoom_events/hubs/{hubId}/vod_channels/{channelId}/actions - Write
Add VOD channel videos
Adds videos to the VOD channel. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_channels:write`,`zoom_events_vod_channels:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:vod_channel_videos`,`zoom_events:write:vod_channel_videos:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /zoom_events/hubs/{hubId}/vod_channels/{channelId}/videos - Destructive
Delete VOD Channel
Deletes a video channel. Please check this support page for details about a [video channel](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057579#h_01HBVW2WZ06MFH7KHGPSJC9YKG). **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus / Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_channels:write`,`zoom_events_vod_channels:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:delete:vod_channel`,`zoom_events:delete:vod_channel:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /zoom_events/hubs/{hubId}/vod_channels/{channelId} - Destructive
Delete VOD channel video
Removes video from the VOD channel. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_channels:write`,`zoom_events_vod_channels:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:delete:vod_channel_videos`,`zoom_events:delete:vod_channel_videos:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /zoom_events/hubs/{hubId}/vod_channels/{channelId}/videos/{videoId}
Video On-Demand Registrations
- Read
Get VOD Registration Questions
List registration questions and fields that are to be answered by users while registering for a vod channel. These questions are configured for the VOD channel after or before publishing the channel. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_registration:read`,`zoom_events_vod_registration:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:vod_registration_questions`,`zoom_events:read:vod_registration_questions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/hubs/{hubId}/vod_channels/{channelId}/registration_questions - Read
List VOD Registration
Retrieves the VOD registration information of a channel. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_registration:read`,`zoom_events_vod_registration:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:vod_registrations`,`zoom_events:read:vod_registrations:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/hubs/{hubId}/vod_channels/{channelId}/registrations - Write
VOD channel registration
Creates registrations for a VOD channel. You can add a single registrant or up to 30 registrants in a batch operation. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_registration:write`,`zoom_events_vod_registration:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:write:vod_registration`,`zoom_events:write:vod_registration:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /zoom_events/hubs/{hubId}/vod_channels/{channelId}/registrations - Destructive
update VOD channel registration questions
Updates registration questions and fields that are to be answered by users while registering for a VOD channel. These questions are setup at VOD channel level. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_vod_registration:write`,`zoom_events_vod_registration:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:vod_registration_questions`,`zoom_events:update:vod_registration_questions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /zoom_events/hubs/{hubId}/vod_channels/{channelId}/registration_questions
Videos
- Read
Get metadata for a specific video
Retrieves metadata for a specific video, including title, description, duration, creation time, last updated time, and associated tags. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_videos:read`,`zoom_events_videos:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:read:video_metadata`,`zoom_events:read:video_metadata:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zoom_events/videos/{videoId}/metadata - Read
List channel videos
Gets a list of the channel's videos. **Prerequisites**: * A [Pro or higher account plan](https://www.zoom.us/pricing?). * A Zoom Video Management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt_channels:read`,`video_mgmt_channels:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt:read:list_channel_videos`,`video_mgmt:read:list_channel_videos:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /video_management/channels/{channelId}/videos - Read
List playlist videos
Gets the playlist's list of videos. **Prerequisites**: * A [Pro or higher account plan](https://www.zoom.us/pricing?). * A Zoom Video Management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt_playlists:read`,`video_mgmt_playlists:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt:read:list_playlist_videos`,`video_mgmt:read:list_playlist_videos:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /video_management/playlists/{playlistId}/videos - Read
List all videos
Retrieves the list of videos or recordings added by the user. **Prerequisites**: * A [Pro or higher account plan](https://www.zoom.us/pricing?). * A Zoom Video Management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt_videos:read`,`video_mgmt_videos:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt:read:list_videos`,`video_mgmt:read:list_videos:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /video_management/videos - Read
Get metadata for a specific video
Retrieves metadata such as the name, description, and notes for a specific video. **Prerequisites**: * A [Pro or higher account plan](https://www.zoom.us/pricing?). * A Zoom Video Management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt_videos:read`,`video_mgmt_videos:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt:read:video_metadata`,`video_mgmt:read:video_metadata:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /video_management/videos/{videoId}/metadata - Write
Update metadata for a specific video
Updates video metadata. **Prerequisites** * A Pro or higher account plan * A Zoom Webinars Plus or Events license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events_videos:write`,`zoom_events_videos:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_events:update:video_metadata`,`zoom_events:update:video_metadata:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /zoom_events/videos/{videoId}/metadata - Write
Add channel videos
Adds videos to the channel. **Prerequisites**: * A [Pro or higher account plan](https://www.zoom.us/pricing?). * A Zoom Video Management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt_channels:write`,`video_mgmt_channels:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt:write:channel_videos`,`video_mgmt:write:channel_videos:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /video_management/channels/{channelId}/videos - Write
Add playlist videos
Adds videos to a playlist. **Prerequisites**: * A [Pro or higher account plan](https://www.zoom.us/pricing?). * A Zoom Video Management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt_playlists:write`,`video_mgmt_playlists:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt:write:playlist_videos`,`video_mgmt:write:playlist_videos:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /video_management/playlists/{playlistId}/videos - Destructive
Delete channel videos
Removes videos from the channel. **Prerequisites**: * A [Pro or higher account plan](https://www.zoom.us/pricing?). * A Zoom Video Management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt_channels:write`,`video_mgmt_channels:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt:delete:channel_videos`,`video_mgmt:delete:channel_videos:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /video_management/channels/{channelId}/videos - Destructive
Delete playlist videos
Deletes videos from a playlist. **Prerequisites**: * A [Pro or higher account plan](https://www.zoom.us/pricing?). * A Zoom Video Management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt_playlists:write`,`video_mgmt_playlists:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt:delete:playlist_videos`,`video_mgmt:delete:playlist_videos:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /video_management/playlists/{playlistId}/videos - Destructive
Update metadata for a specific video.
Updates video metadata. **Prerequisites**: * A [Pro or higher account plan](https://www.zoom.us/pricing?). * A Zoom Video Management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt_videos:write`,`video_mgmt_videos:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt:update:video_metadata`,`video_mgmt:update:video_metadata:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /video_management/videos/{videoId}/metadata
clinicalnotes
- Read
List clinical notes
Retrieves a list of clinical notes. The data returned depends on the parameters you provide. If you provide: - Only `note_owner_user_id` - returns all clinical notes owned by that user. - Only `meeting_id` - returns all clinical notes associated with that meeting. - Both `note_owner_user_id` and `meeting_id` - returns only the clinical notes from the specified meeting owned by the specified user. - Neither `note_owner_user_id` nor `meeting_id` - returns all clinical notes available to the requesting user within the account. Prerequisites: - Host user type must have a Pro or higher plan. - Enable the Clinical Notes feature in the host's account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clinical_note:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `healthcare:read:list_clinical_notes:admin`,`healthcare:read:list_clinical_notes:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /clinical_notes/notes - Read
Get a Clinical Note
Gets a single clinical note identified by `noteId`. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clinical_note:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `healthcare:read:clinical_notes:admin`,`healthcare:read:clinical_notes:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /clinical_notes/notes/{noteId} - Write
Update a Clinical Note
Updates a clinical note associated with the `noteId`. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `clinical_note:update:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `healthcare:update:clinical_notes:admin`,`healthcare:update:clinical_notes:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /clinical_notes/notes/{noteId}
Shared folder
Conversations
- Read
List conversations [Deprecated] (deprecated)
List all conversations. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_conversation:read`,`iq_conversation:write`,`iq_conversation:read:admin`,`iq_conversation:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:list_conversations`,`zra:read:list_conversations:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /iq/conversations - Read
Get conversation information [Deprecated] (deprecated)
Get information for a specific conversation. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_conversation:read`,`iq_conversation:write`,`iq_conversation:read:admin`,`iq_conversation:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:conversations:admin`,`zra:read:conversations` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /iq/conversations/{conversationId} - Read
Get conversation comments [Deprecated] (deprecated)
Get comments for a specific conversation. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_comment:read`,`iq_comment:write`,`iq_comment:read:admin`,`iq_comment:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:list_conversation_comments`,`zra:read:list_conversation_comments:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /iq/conversations/{conversationId}/comments - Read
Get conversation content analysis [Deprecated] (deprecated)
Get the content analysis for a specific conversation. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_conversation:read`,`iq_conversation:write`,`iq_conversation:read:admin`,`iq_conversation:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:conversation_analysis`,`zra:read:conversation_analysis:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /iq/conversations/{conversationId}/content_analysis - Read
Get conversation interactions [Deprecated] (deprecated)
Get interactions for a specific conversation. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_conversation:read`,`iq_conversation:write`,`iq_conversation:read:admin`,`iq_conversation:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:conversation_participants`,`zra:read:conversation_participants:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /iq/conversations/{conversationId}/interactions - Read
Get conversation scorecards [Deprecated] (deprecated)
Get scorecards for a specific conversation. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_coaching:read:admin`,`iq_coaching:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:conversation_scorecards`,`zra:read:conversation_scorecards:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /iq/conversations/{conversationId}/scorecards - Read
Get a user's playlist [Deprecated] (deprecated)
Get all playlists for a user. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_playlist:read`,`iq_playlist:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:list_conversation_playlists`,`zra:read:list_conversation_playlists` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /iq/users/{userId}/conversations/playlists - Read
List conversations
List all conversations. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_conversation:read`,`iq_conversation:write`,`iq_conversation:read:admin`,`iq_conversation:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:list_conversations`,`zra:read:list_conversations:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /zra/conversations - Read
Get conversation information
Get information for a specific conversation. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_conversation:read`,`iq_conversation:write`,`iq_conversation:read:admin`,`iq_conversation:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:conversations:admin`,`zra:read:conversations` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zra/conversations/{conversationId} - Read
Get conversation comments
Get comments for a specific conversation. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_comment:read`,`iq_comment:write`,`iq_comment:read:admin`,`iq_comment:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:list_conversation_comments`,`zra:read:list_conversation_comments:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /zra/conversations/{conversationId}/comments - Read
Get conversation content analysis
Get the content analysis for a specific conversation. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_conversation:read`,`iq_conversation:write`,`iq_conversation:read:admin`,`iq_conversation:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:conversation_analysis`,`zra:read:conversation_analysis:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /zra/conversations/{conversationId}/content_analysis - Read
Get conversation interactions
Get interactions for a specific conversation. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_conversation:read`,`iq_conversation:write`,`iq_conversation:read:admin`,`iq_conversation:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:conversation_participants`,`zra:read:conversation_participants:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /zra/conversations/{conversationId}/interactions - Read
Get conversation scorecards
Get scorecards for a specific conversation. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_coaching:read`,`iq_coaching:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:conversation_scorecards`,`zra:read:conversation_scorecards:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /zra/conversations/{conversationId}/scorecards - Read
Get a user's playlist
Get all playlists for a user. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_playlist:read:admin`,`iq_playlist:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:list_conversation_playlists`,`zra:read:list_conversation_playlists` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /zra/users/{userId}/conversations/playlists - Write
Add conversation by file id or download url. [Deprecated] (deprecated)
Add conversation by file ID or third party download URL. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_conversation:write:admin`,`iq_conversation:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:write:conversation`,`zra:write:conversation:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /iq/conversations - Write
Add new comments to the conversation [Deprecated] (deprecated)
Add new comments to a specific conversation. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_comment:write`,`iq_comment:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:write:conversation_comment`,`zra:write:conversation_comment:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /iq/conversations/{conversationId}/comments - Write
Edit conversation comment [Deprecated] (deprecated)
Edit a comment for a specific conversation. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_comment:write`,`iq_comment:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:update:conversation_comment`,`zra:update:conversation_comment:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /iq/conversations/{conversationId}/comments/{commentId} - Write
Update conversation host id to new host id by conversation id [Deprecated] (deprecated)
Update the conversation host id. **Prerequisite**: You must have either `iq_conversation:write:admin` or `iq_conversation:write` permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_conversation:write:admin`,`iq_conversation:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:update:conversation_host`,`zra:update:conversation_host:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /iq/conversations/{conversationId}/update_host - Write
Upload IQ file [Deprecated] (deprecated)
Upload a file to Zoom Revenue Acclerator. **Prerequisite:** The caller must be a Zoom Revenue Acclerator-licensed user. **Note:** * Base URL: `https://fileapi.zoom.us/v2/`. * Rate limit: 20 requests per second per user or 2000 requests per second per IP address. * The caller must support HTTP 30x redirects. * The caller must retain the Authorization header when redirected to a different hostname. * Supported video formats: `.mov`, `.mp4`, `.avi`, `.wmv` or `H.264`. * Supported transcript and file attachment format: `.json` . The `fileName` must end with `transcript.json`. * Supported metadata and file attachment format: `.json`. The fileName must end with `metadata.json`. * Required file upload sequence: main file, transcript file (if necessary), metadata file (if necessary). * When your object size reaches 2 GB, you should use multipart uploads instead of uploading the object in a single operation. * For an **account-level** [OAuth app](https://developers.zoom.us/docs/integrations/create/), this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.) with **Edit** permission for **All Conversations**. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_conversation:write:admin`,`iq_conversation:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:write:file`,`zra:write:file:admin`
POST /iq/files - Write
Upload iq multipart file. [Deprecated] (deprecated)
Use this API to upload a multipart file. **Note:** * The base URL for this API is `https://fileapi.zoom.us/v2/`. * The rate limit of this API is 20 requests per second or 2000 requests per day per IP address. * The caller must support HTTP 30x redirects. * The caller must retain the authorization header when redirected to a different hostname. * Video can be in `.mov`, `.mp4`, `.avi`, `.wmv` or `H.264` format. * Transcript can be in `.vtt`, `.json` format. * In general, when your object size reaches 2 GB, you should use multipart uploads instead of uploading the object in a single operation. * The caller must be a iq_listened user. * For an **account-level** [OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app), this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.) that has the **Edit** permission for **All Conversations**. * **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_conversation:write:admin`,`iq_conversation:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:write:file`,`zra:write:file:admin`
POST /iq/files/multipart - Write
Initiate and complete a multipart upload. [Deprecated] (deprecated)
Initiate or complete a multipart upload. **Note:** * The base URL for this API is `https://fileapi.zoom.us/v2/`. * The rate limit is 20 requests per second or 2000 requests per day per IP address. * The caller must support HTTP 30x redirects. * The caller must retain the authorization header when redirected to a different hostname. * Once initiated the multipart upload must complete within 7 days. * The caller must be an iq_listened user. * For **account-level** [OAuth apps](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app), this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.) with **Edit** permission for **All Conversations**. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_conversation:write:admin`,`iq_conversation:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:write:file`,`zra:write:file:admin`
POST /iq/files/multipart/upload_events - Write
Add conversation by meeting record url or meeting UUID. [Deprecated] (deprecated)
Add new conversation by meeting recording URL or meeting UUID. If both recording URL and meeting UUID are passed in the request but refer to different meetings, we use the recording URL and ignore the meeting UUID. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_conversation:write:admin`,`iq_conversation:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:write:conversation`,`zra:write:conversation:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /iq/users/{userId}/conversations - Write
Add conversation by file id or download url.
Add conversation by file ID or third party download URL. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_conversation:write:admin`,`iq_conversation:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:write:conversation`,`zra:write:conversation:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /zra/conversations - Write
Add new comments to the conversation
Add new comments to a specific conversation. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_comment:write`,`iq_comment:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:list_conversation_comments`,`zra:read:list_conversation_comments:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /zra/conversations/{conversationId}/comments - Write
Edit conversation comment
Edit a comment for a specific conversation. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_comment:write`,`iq_comment:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:update:conversation_comment`,`zra:update:conversation_comment:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /zra/conversations/{conversationId}/comments/{commentId} - Write
Update conversation host id
Update the conversation host id to a new host id by conversation id. **Prerequisite**: You must have either `iq_conversation:write:admin` or `iq_conversation:write` permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_conversation:write:admin`,`iq_conversation:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:update:conversation_host`,`zra:update:conversation_host:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /zra/conversations/{conversationId}/update_host - Write
Upload IQ file
Upload a file to Zoom Revenue Acclerator. **Prerequisite:** The caller must be a Zoom Revenue Acclerator-licensed user. **Note:** * Base URL: `https://fileapi.zoom.us/v2/`. * Rate limit: 20 requests per second per user or 2000 requests per second per IP address. * The caller must support HTTP 30x redirects. * The caller must retain the Authorization header when redirected to a different hostname. * Supported video formats: `.mov`, `.mp4`, `.avi`, `.wmv` or `H.264`. * Supported transcript and file attachment format: `.json` . The `fileName` must end with `transcript.json`. * Supported metadata and file attachment format: `.json`. The fileName must end with `metadata.json`. * Required file upload sequence: main file, transcript file (if necessary), metadata file (if necessary). * When your object size reaches 2 GB, you should use multipart uploads instead of uploading the object in a single operation. * For an **account-level** [OAuth app](https://developers.zoom.us/docs/integrations/create/), this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.) with **Edit** permission for **All Conversations**. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_conversation:write:admin`,`iq_conversation:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:write:file`,`zra:write:file:admin`
POST /zra/files - Write
Upload iq multipart file.
Use this API to upload a multipart file. **Note:** * The base URL for this API is `https://fileapi.zoom.us/v2/`. * The rate limit of this API is 20 requests per second or 2000 requests per day per IP address. * The caller must support HTTP 30x redirects. * The caller must retain the authorization header when redirected to a different hostname. * Video can be in `.mov`, `.mp4`, `.avi`, `.wmv` or `H.264` format. * Transcript can be in `.vtt`, `.json` format. * In general, when your object size reaches 2 GB, you should use multipart uploads instead of uploading the object in a single operation. * The caller must be a iq_listened user. * For an **account-level** [OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app), this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.) that has the **Edit** permission for **All Conversations**. * **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_conversation:write:admin`,`iq_conversation:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:write:file`,`zra:write:file:admin`
POST /zra/files/multipart - Write
Initiate and complete a multipart upload.
Initiate or complete a multipart upload. **Note:** * The base URL for this API is `https://fileapi.zoom.us/v2/`. * The rate limit is 20 requests per second or 2000 requests per day per IP address. * The caller must support HTTP 30x redirects. * The caller must retain the authorization header when redirected to a different hostname. * Once initiated the multipart upload must complete within 7 days. * The caller must be an iq_listened user. * For **account-level** [OAuth apps](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app), this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.) with **Edit** permission for **All Conversations**. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_conversation:write:admin`,`iq_conversation:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:write:file`,`zra:write:file:admin`
POST /zra/files/multipart/upload_events - Write
Add conversation by meeting record url or meeting UUID.
Add new conversations by meeting record URL or meeting UUID. If both recording URL and meeting UUID are passed in the request and refer to different meetings, we ignore meeting UUID. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_conversation:write:admin`,`iq_conversation:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:write:conversation`,`zra:write:conversation:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /zra/users/{userId}/conversations - Destructive
Delete conversation by conversation ID [Deprecated] (deprecated)
Delete conversation by conversation ID. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_conversation:write:admin`,`iq_conversation:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:delete:conversations`,`zra:delete:conversations:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /iq/conversations/{conversationId} - Destructive
Delete conversation's comment [Deprecated] (deprecated)
Delete comment from a specific conversation. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_comment:write`,`iq_comment:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:delete:conversation_comment`,`zra:delete:conversation_comment:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /iq/conversations/{conversationId}/comments/{commentId} - Destructive
Delete conversation by conversation ID
Delete conversation by conversation ID. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_conversation:write:admin`,`iq_conversation:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:delete:conversations`,`zra:delete:conversations:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /zra/conversations/{conversationId} - Destructive
Delete conversation's comment
Delete comment from a specific conversation. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_comment:write`,`iq_comment:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:delete:conversation_comment`,`zra:delete:conversation_comment:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /zra/conversations/{conversationId}/comments/{commentId}
Custom CRM
- Read
Get imported CRM accounts
Retrieve CRM account objects by their CRM IDs. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_crm:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:crm_account:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /zra/crm/accounts - Read
Get imported CRM contacts
Retrieve CRM contact objects by their CRM IDs. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_crm:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:crm_contact:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /zra/crm/contacts - Read
Get imported CRM deals
Retrieve CRM deal objects by their CRM IDs. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_crm:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:crm_deal:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /zra/crm/deals - Read
Get imported CRM leads
Retrieve CRM lead objects by their CRM IDs. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_crm:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:crm_lead:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /zra/crm/leads - Read
Get current CRM API registration
Retrieves the current CRM API registration information. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_crm:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:crm_registration:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zra/crm/settings - Read
Poll async task result
Retrieve the execution result of asynchronous task. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_crm:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:crm_task:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /zra/crm/tasks/{taskId} - Write
Register CRM API connection
Register new CRM API integration **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_crm:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:write:crm_registration:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
POST /zra/crm/settings - Destructive
Bulk import CRM accounts
Bulk import CRM account objects asynchronously. We recommend you upload account objects in this order: **account** → **contact** → **deal**. CRM account object references are validated in advance when importing contacts and deals. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_crm:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:write:crm_accounts:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `RESOURCE-INTENSIVE`
POST /zra/crm/accounts - Destructive
Bulk import CRM contacts
Bulk import CRM contact objects asynchronously. We recommend you upload CRM contact objects in this order: **account** → **contact** → **deal**. ZRA validates CRM account object references in advance when importing contacts and deals. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_crm:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:write:crm_contact:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `RESOURCE-INTENSIVE`
POST /zra/crm/contacts - Destructive
Bulk import CRM deals
Bulk import CRM deal objects asynchronously. We recommend you upload CRM contact objects in this order: **account** → **contact** → **deal**. ZRA validates CRM account object references in advance when importing contacts and deals. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_crm:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:write:crm_deal:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `RESOURCE-INTENSIVE`
POST /zra/crm/deals - Destructive
Bulk import CRM leads
Bulk import CRM lead objects asynchronously. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_crm:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:write:crm_lead:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `RESOURCE-INTENSIVE`
POST /zra/crm/leads - Destructive
Unregister CRM API connection
Unregister the current CRM API integration. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_crm:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:delete:crm_registration:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
DELETE /zra/crm/settings
Deals
- Read
List deals [Deprecated] (deprecated)
List all deals. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_deal:read`,`iq_deal:read:admin`,`iq_deal:write`,`iq_deal:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:list_deals`,`zra:read:list_deals:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /iq/deals - Read
Get deal information [Deprecated] (deprecated)
Get information for a specific deal. (deprecated) **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_deal:read`,`iq_deal:read:admin`,`iq_deal:write`,`iq_deal:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:deal`,`zra:read:deal:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /iq/deals/{dealId} - Read
Get deal activities [Deprecated] (deprecated)
Get activities for a specific deal. (deprecated) **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_deal:read`,`iq_deal:read:admin`,`iq_deal:write`,`iq_deal:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:list_deal_activities`,`zra:read:list_deal_activities:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /iq/deals/{dealId}/activities - Read
List deals
List all deals. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_deal:read`,`iq_deal:read:admin`,`iq_deal:write`,`iq_deal:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:list_deals`,`zra:read:list_deals:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /zra/deals - Read
Get deal information
Get information for a specific deal. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_deal:read`,`iq_deal:read:admin`,`iq_deal:write`,`iq_deal:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:deal`,`zra:read:deal:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /zra/deals/{dealId} - Read
Get deal activities
Get activities for a specific deal. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_deal:read`,`iq_deal:read:admin`,`iq_deal:write`,`iq_deal:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:list_deal_activities`,`zra:read:list_deal_activities:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /zra/deals/{dealId}/activities - Destructive
Delete activity from the deal [Deprecated] (deprecated)
Delete specific activity from the deal. Either <b>conversation_id</b> or <b>message_id</b> would be required. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_deal:write:admin`,`iq_deal:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:delete:deal_activity`,`zra:delete:deal_activity:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /iq/deals/{dealId}/activities - Destructive
Delete activity from the deal
Delete specific activity from a deal. Use either <b>conversation_id</b> or <b>message_id</b>. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_deal:write`,`iq_deal:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:delete:deal_activity`,`zra:delete:deal_activity:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /zra/deals/{dealId}/activities
ScheduleMeetings
- Read
List scheduled meetings
List all scheduled meetings for a user. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `iq_conversation:read:admin`,`iq_conversation:read`,`iq_conversation:write`,`iq_conversation:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zra:read:list_conversations`,`zra:read:list_conversations:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /zra/scheduled
Drafts
- Read
List emails from draft folder
Lists the draft messages in the mailbox. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:read`,`mail:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:read:list_drafts`,`email:read:list_drafts:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
GET /emails/mailboxes/{email}/drafts - Read
Get the specified draft email
Retrieves the specified draft. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:read`,`mail:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:read:draft`,`email:read:draft:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /emails/mailboxes/{email}/drafts/{draftId} - Write
Create a new draft email
Creates a new draft email message. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:write`,`mail:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:write:draft`,`email:write:draft:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
POST /emails/mailboxes/{email}/drafts - Write
Send out a draft email
Sends the specified draft. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:write`,`mail:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:write:send_draft`,`email:write:send_draft:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
POST /emails/mailboxes/{email}/drafts/send - Destructive
Update the specified draft email
Replaces a draft email's content. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:write`,`mail:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:update:draft`,`email:update:draft:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
PUT /emails/mailboxes/{email}/drafts/{draftId} - Destructive
Delete an existing draft email
Immediately and permanently deletes the specified draft. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:write`,`mail:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:delete:draft`,`email:delete:draft:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
DELETE /emails/mailboxes/{email}/drafts/{draftId}
History
- Read
List history of events for mailbox
Lists the history of the changes to the given mailbox. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:read`,`mail:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:read:history`,`email:read:history:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /emails/mailboxes/{email}/history
Labels
- Read
List labels in the mailbox
Lists all labels in the mailbox. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:read`,`mail:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:read:list_labels`,`email:read:list_labels:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
GET /emails/mailboxes/{email}/labels - Read
Get the specified label in mailbox
Retrieves the specified label. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:read`,`mail:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:read:label`,`email:read:label:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /emails/mailboxes/{email}/labels/{labelId} - Write
Create a new label in mailbox
Creates a new label. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:write`,`mail:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:write:label`,`email:write:label:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
POST /emails/mailboxes/{email}/labels - Write
Patch the specified label in mailbox
Patch the specified label. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:write`,`mail:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:update:label`,`email:update:label:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
PATCH /emails/mailboxes/{email}/labels/{labelId} - Destructive
Update the specified label in mailbox
Updates the specified label. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:write`,`mail:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:update:label`,`email:update:label:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
PUT /emails/mailboxes/{email}/labels/{labelId} - Destructive
Delete an existing label from mailbox
Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:write`,`mail:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:delete:label`,`email:delete:label:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
DELETE /emails/mailboxes/{email}/labels/{labelId}
Mailbox
- Read
Get the mailbox profile
Get the mailbox profile. **Prerequisites**: * Account must have Workplace Business or higher license type * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow * Mail service End-To-End Encryption is disabled * Requested mailbox must have been provisioned **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:read`,`mail:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:read:profile`,`email:read:profile:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /emails/mailboxes/{email}/profile
Messages
- Read
List emails from the mailbox
Lists the messages in the user's mailbox. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:read`,`mail:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:read:list_msgs`,`email:read:list_msgs:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
GET /emails/mailboxes/{email}/messages - Read
Get the specified email
Retrieves the specified message. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:read`,`mail:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:read:msg`,`email:read:msg:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /emails/mailboxes/{email}/messages/{messageId} - Write
Create a new email
Directly inserts a message into this mailbox. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:write`,`mail:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:write:msg`,`email:write:msg:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
POST /emails/mailboxes/{email}/messages - Write
Send out an email
Sends the specified message to the recipients as specified in the email. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:write`,`mail:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:write:send_msg`,`email:write:send_msg:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
POST /emails/mailboxes/{email}/messages/send - Write
Move the specified email to TRASH folder
Moves the specified message to the TRASH folder. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:write`,`mail:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:write:trash_msg`,`email:write:trash_msg:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
POST /emails/mailboxes/{email}/messages/{messageId}/trash - Write
Move the specified email out of TRASH folder
Moves a message out of TRASH folder. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:write`,`mail:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:write:untrash_msg`,`email:write:untrash_msg:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
POST /emails/mailboxes/{email}/messages/{messageId}/untrash - Destructive
Batch delete the specified emails
Deletes multiple messages specified in request body. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:write`,`mail:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:write:batch_delete_msgs`,`email:write:batch_delete_msgs:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
POST /emails/mailboxes/{email}/messages/batchDelete - Destructive
Batch modify the specified emails
Modifies the labels on the specified messages. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:write`,`mail:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:write:batch_modify_msgs`,`email:write:batch_modify_msgs:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY` **Not supported in Gov cluster**
POST /emails/mailboxes/{email}/messages/batchModify - Destructive
Delete an existing email
Immediately and permanently deletes the specified message. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:write`,`mail:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:delete:msg`,`email:delete:msg:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
DELETE /emails/mailboxes/{email}/messages/{messageId} - Destructive
Update the specified email
Modifies the labels on the specified message. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:write`,`mail:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:write:modify_msg`,`email:write:modify_msg:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
POST /emails/mailboxes/{email}/messages/{messageId}/modify
Messages.Attachments
- Read
Get the specified attachment for an email
Retrieves the specified message attachment. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:read`,`mail:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:read:attachment`,`email:read:attachment:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
GET /emails/mailboxes/{email}/messages/{messageId}/attachments/{attachmentId}
Settings
- Read
Get mailbox vacation response setting
Gets vacation respondes settings. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:read`,`mail:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:read:setting_vacation`,`email:read:setting_vacation:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /emails/mailboxes/{email}/settings/vacation - Read
Get account policy details
Returns the account policy details. **Prerequisites** * Pro or higher account plan with Zoom phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:policy:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/policies/{policyType} - Read
List ported numbers (deprecated)
Use this API to list ported numbers in a Zoom account. **Prerequisites:** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_peering:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_ported_numbers:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/ported_numbers/orders - Read
Get ported numbers details (deprecated)
Returns details on the ported numbers by specifying `order_id`. **Prerequisites:** * A Pro or higher account plan * A Zoom phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_peering:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:ported_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/ported_numbers/orders/{orderId} - Read
Get phone account settings
Returns an account's settings. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
GET /phone/settings - Read
List SIP groups (deprecated)
Returns a list of SIP (Session Initiation Protocol) groups. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_sip_groups:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/sip_groups - Read
List BYOC SIP trunks (deprecated)
Returns a list of an account's assigned [BYOC (Bring Your Own Carrier) SIP (Session Initiation Protocol) trunks](https://zoom.us/docs/doc/Zoom-Bring%20Your%20Own%20Carrier.pdf). **Prerequisites** * A Business or Enterprise account **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_sip_trunks:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/sip_trunk/trunks - Write
Update account policy
Updates the account's [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051-Zoom-Phone) policy. **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:policy:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `RESOURCE-INTENSIVE`
PATCH /phone/policies/{policyType} - Write
Update phone account settings
Updates Zoom Phone [account settings](https://support.zoom.us/hc/en-us/articles/360025846692). **Prerequisites:** * A Business or Enterprise account **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:settings:admin`
PATCH /phone/settings - Destructive
Update mailbox vacation response setting
Updates vacation responder settings. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:write`,`mail:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:update:setting_vacation`,`email:update:setting_vacation:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
PUT /emails/mailboxes/{email}/settings/vacation
Settings.Delegates
- Read
List delegates on the mailbox
Lists the delegates on the mailbox. Managing delegate operations must be done by the mailbox owner. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:read`,`mail:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:read:list_setting_delegates`,`email:read:list_setting_delegates:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
GET /emails/mailboxes/{email}/settings/delegates - Read
Get the specified delegate on the mailbox
Retrieves the specified delegate. Managing delegate operations must be done by the mailbox owner. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:read`,`mail:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:read:setting_delegate`,`email:read:setting_delegate:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /emails/mailboxes/{email}/settings/delegates/{delegateEmail} - Write
Grant a new delegate access on the mailbox
Creates a delegate on the mailbox. Managing delegate operations must be done by the mailbox owner. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:write`,`mail:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:write:setting_delegate`,`email:write:setting_delegate:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
POST /emails/mailboxes/{email}/settings/delegates - Destructive
Revoke an existing delegate access from the mailbox
Removes the specified delegate. Managing delegate operations must be done by the mailbox owner. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:write`,`mail:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:delete:setting_delegate`,`email:delete:setting_delegate:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
DELETE /emails/mailboxes/{email}/settings/delegates/{delegateEmail}
Settings.Filters
- Read
List email filters
Lists the message filters of a mailbox. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:read`,`mail:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:read:list_setting_filters`,`email:read:list_setting_filters:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
GET /emails/mailboxes/{email}/settings/filters - Read
Get the specified email filter
Retrieves the specified filter. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:read`,`mail:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:read:setting_filter`,`email:read:setting_filter:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /emails/mailboxes/{email}/settings/filters/{filterId} - Destructive
Create an email filter
Creates a message filter. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:write`,`mail:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:write:setting_filter`,`email:write:setting_filter:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
POST /emails/mailboxes/{email}/settings/filters - Destructive
Delete the specified email filter
Immediately and permanently deletes the specified filter. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:write`,`mail:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:delete:setting_filter`,`email:delete:setting_filter:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
DELETE /emails/mailboxes/{email}/settings/filters/{filterId}
Threads
- Read
List email threads from the mailbox
Lists the threads in the mailbox. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:read`,`mail:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:read:list_threads`,`email:read:list_threads:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
GET /emails/mailboxes/{email}/threads - Read
Get the specified email thread
Retrieves the specified thread. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:read`,`mail:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:read:thread`,`email:read:thread:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /emails/mailboxes/{email}/threads/{threadId} - Write
Update the specified thread
Modifies the labels applied to the thread. This applies to all messages in the thread. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:write`,`mail:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:write:thread`,`email:write:thread:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
POST /emails/mailboxes/{email}/threads/{threadId}/modify - Write
Move the specified thread to TRASH folder
Moves the specified thread to the trash. Any messages that belong to the thread are also moved to the trash. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:write`,`mail:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:write:trash_thread`,`email:write:trash_thread:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
POST /emails/mailboxes/{email}/threads/{threadId}/trash - Write
Move the specified thread out of TRASH folder
Moves the specified thread out of the trash folder. Any messages that belong to the thread are also removed from the trash. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:write`,`mail:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:write:untrash_thread`,`email:write:untrash_thread:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
POST /emails/mailboxes/{email}/threads/{threadId}/untrash - Destructive
Delete an existing email thread
Immediately and permanently deletes the specified thread. Any messages that belong to the thread are also deleted. This operation cannot be undone. **Prerequisites**: * Account must have Workplace Business or higher license type. * Account must have enabled Zoom Mail Service and finished Mail Service Onboarding Flow. * Mail service End-To-End Encryption is disabled. * Requested mailbox must have been provisioned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `mail:write`,`mail:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `email:delete:thread`,`email:delete:thread:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
DELETE /emails/mailboxes/{email}/threads/{threadId}
App
- Read
Get user's custom field values
Get custom field values for user. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace_custom_fields:read`,`marketplace_custom_fields:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace:read:custom_fields:admin`,`marketplace:read:custom_fields` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /marketplace/app/custom_fields - Read
Get user or account event subscription
Returns event subscriptions for users or accounts. **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /marketplace/app/event_subscription - Read
List apps
List all active and past app requests, or list all approved public and private apps. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace_app:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace:read:list_apps:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /marketplace/apps - Read
Get information about an app
Use this API to get app information. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace_app:read:admin`,`marketplace_app:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace:read:app`,`marketplace:read:app:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /marketplace/apps/{appId} - Read
Get API call logs
Get log of app's API calls. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace:read:list_api_logs:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /marketplace/apps/{appId}/api_call_logs - Read
Get an app's user requests
Use this API to get an app's user requests and the status of their approval. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace_app:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace:read:app_request:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /marketplace/apps/{appId}/requests - Read
Get webhook logs
Get users' webhook call logs and query records from the past 7 days. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace_app:read`,`marketplace_app:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /marketplace/apps/{appId}/webhook_logs - Read
Get app user entitlements
Get the app user's entitlements information. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace_entitlement:read:admin`,`marketplace_entitlement:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace:read:list_user_entitlements`,`marketplace:read:list_user_entitlements:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /marketplace/monetization/entitlements - Read
Get a user's app requests
Use this API to get all of a user's app requests. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace_app:read:admin`,`marketplace_app:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace:read:list_user_app_requests:admin`,`marketplace:read:list_user_app_requests` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /marketplace/users/{userId}/apps - Read
Get a user's entitlements
Get a user's entitlements. **Prerequisites** - An existing, authorized application. - A valid access token obtained using the client_credentials authorization grant_type. See [documentation](/docs/api/webhooks/#step-1-request-an-access-token) for details. **Note** These endpoints use app-specific scopes that won't appear in your Marketplace build flow, but will be included in the access token payload. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace_entitlement:read`,`marketplace_entitlement:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace:read:list_user_entitlements`,`marketplace:read:list_user_entitlements:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /marketplace/users/{userId}/entitlements - Write
Send app notifications
Send app notifications to the Zoom Activity Center. (Note: This API endpoint only supports OAuth 2.0.) **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `app:notification:read`,`app:notification:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace:write:notifications` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /app/notifications - Write
Create an event subscription
Programmatically create event subscriptions for an authorized application. **Prerequisites** - An existing, authorized application. - A valid access token obtained using the `client_credentials` authorization `grant_type`. See [documentation](/docs/api/webhooks/#step-1-request-an-access-token) for details. **Note** These endpoints use app-specific scopes that won't appear in your Marketplace build flow, but will be included in the access token payload. **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
POST /marketplace/app/event_subscription - Write
Update an event subscription
Update an event subscription. **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /marketplace/app/event_subscription - Write
Subscribe to an event subscription
Subscribe to an event subscription. **Prerequisites** - An existing, authorized application. - A valid access token obtained using the `client_credentials` authorization `grant_type`. See [documentation](https://developers.zoom.us/docs/api/webhooks/#step-1-request-an-access-token) for details. **Note** These endpoints use app-specific scopes that won't appear in your Marketplace build flow, but will be included in the access token payload. **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /marketplace/app/event_subscription/{eventSubscriptionId} - Write
Create apps
Create `Server to Server OAuth`, `Meeting SDK` or `General` apps in the Zoom Marketplace. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace_app:write`,`marketplace_app:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace:write:app`,`marketplace:write:app:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
POST /marketplace/apps - Write
Generate Zoom App Deeplink
Create a Zoom App Deeplink. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace_app:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace:write:app_deeplink:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /marketplace/apps/{appId}/deeplink - Write
Add app allow requests for users
Use this API to add app allow requests for all users, groups of users, or specific users. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace_app:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace:write:app_request:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /marketplace/apps/{appId}/requests - Write
Update app's request status
Use this API to update an app's request status or update app status. Administrators can only agree to user-level apps. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace_app:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace:update:app_request:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /marketplace/apps/{appId}/requests - Destructive
Unsubscribe to an app event subscription
Use this API endpoint to unsubscribe an event subscription. **Prerequisites** - An existing, authorized application. - A valid access token obtained using the `client_credentials` authorization `grant_type`. See [documentation](/docs/api/webhooks/#step-1-request-an-access-token) for details. **Note** These endpoints use app-specific scopes that won't appear in your Marketplace build flow, but will be included in the access token payload. **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /marketplace/app/event_subscription - Destructive
Delete an event subscription
Delete an event subscription. **Prerequisites** - An existing, authorized application. - A valid access token obtained using the client_credentials authorization grant_type. See [documentation](/docs/api/webhooks/#step-1-request-an-access-token) for details. **Note:** These endpoints use app-specific scopes that won't appear in your Marketplace build flow, but will be included in the access token payload. **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /marketplace/app/event_subscription/{eventSubscriptionId} - Destructive
Deletes an app
Permanently delete an app on behalf of a user. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace_app:write`,`marketplace_app:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace:write:app`,`marketplace:write:app:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
DELETE /marketplace/apps/{appId} - Destructive
Update app pre approval setting
This API supports modifying the pre approval configuration of the app, including turning on the setting to the account, to specified users, to specified user groups, and turning off the pre approval. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace_app:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace:write:app_pre_approve:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /marketplace/apps/{appId}/preApprove - Destructive
Rotate client secret
Create or update a marketplace application's client secret rotating schedule. To call this API, users need to use an OAuth token. The token's `grant_type` should be `client_credentials`. Users can only change client secret rotate schedule 3 times in 15 minutes. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace:update:client_secret` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /marketplace/apps/{appId}/rotate_client_secret - Destructive
Enable or disable user app subscription
Enable or disable a user's app subscription. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace_app:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace:write:app:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /marketplace/users/{userId}/apps/{appId}/subscription
Apps
- Write
Generate an app deeplink
Create an app deeplink. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `app:deeplink:write`,`app:deeplink:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
POST /zoomapp/deeplink
Manifest
- Read
Validate an app manifest
Validates an app manifest. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace_app:read`,`marketplace_app:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace:read:app`,`marketplace:read:app:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /marketplace/apps/manifest/validate - Read
Export an app manifest from an existing app
Exports an app's manifest file. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace_app:read`,`marketplace_app:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace:read:app`,`marketplace:read:app:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /marketplace/apps/{appId}/manifest - Destructive
Update an app by manifest
Updates an app from an app manifest **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace_app:write`,`marketplace_app:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `marketplace:write:app`,`marketplace:write:app:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
PUT /marketplace/apps/{appId}/manifest
Cloud Recording
- Read
Get meeting recordings
Returns all of a meeting's [recordings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062627#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 `download_access_token` or the user's [OAuth access token](/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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:read`,`phone_recording:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:read:list_recording_files:admin`,`cloud_recording:read:list_recording_files`,`cloud_recording:read:list_recording_files:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /meetings/{meetingId}/recordings - Read
Get a meeting or webinar recording's analytics details
Retrieve a meeting or webinar 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. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:read:recording_analytics_details`,`cloud_recording:read:recording_analytics_details:master`,`cloud_recording:read:recording_analytics_details:admin`
GET /meetings/{meetingId}/recordings/analytics_details - Read
Get a meeting or webinar recording's analytics summary
Retrieve 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. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:read:recording_analytics_summary`,`cloud_recording:read:recording_analytics_summary:master`,`cloud_recording:read:recording_analytics_summary:admin`
GET /meetings/{meetingId}/recordings/analytics_summary - Read
List recording registrants
Get a list of 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](/api-reference/zoom-api/methods#operation/meetingRecordingRegistrantCreate) to view the recordings. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:read:admin`,`recording:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:read:list_recording_registrants`,`cloud_recording:read:list_recording_registrants:admin`,`cloud_recording:read:list_recording_registrants:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /meetings/{meetingId}/recordings/registrants - Read
Get registration questions
Retrieve a list of questions that are displayed for users to complete when registering to view the recording of a specific meeting. 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. Learn more about [enabling cloud recordings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063923) and [managing cloud recording settings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065362). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:read:admin`,`recording:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:read:registration_questions`,`cloud_recording:read:registration_questions:master`,`cloud_recording:read:registration_questions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /meetings/{meetingId}/recordings/registrants/questions - Read
Get meeting recording settings
Retrieve settings applied to a meeting's [cloud recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording). Response includes recording content access information, which requires the current user to have the `View the recording content` permission to access it. Learn more about [enabling cloud recordings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063923) and [managing cloud recording settings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065362). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:read:admin`,`recording:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:read:recording_settings`,`cloud_recording:read:recording_settings:admin`,`cloud_recording:read:recording_settings:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /meetings/{meetingId}/recordings/settings - Read
List all recordings
Lists 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 passcode 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. Learn more about [enabling cloud recordings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063923) and [managing cloud recording settings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065362). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:read:admin`,`recording:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:read:list_user_recordings`,`cloud_recording:read:list_user_recordings:master`,`cloud_recording:read:list_user_recordings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /users/{userId}/recordings - Read
List recordings of an account
List **Video SDK Cloud Recordings** available on an account. All recording files except individual participant audio files (the "Record a separate audio file of each participant" account option) will be tabulated in the `recording_count` and listed in the `recording_files` array. To get the list of individual participant audio files, use the [List session's recordings](https://developers.zoom.us/docs/api/video-sdk/#tag/cloud-recording/get/videosdk/sessions/{sessionId}/recordings) API. To access a password-protected cloud recording, add an `access_token` parameter to the download URL and provide your [Video SDK API JWT](https://developers.zoom.us/docs/video-sdk/auth/) as the value of the `access_token`. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:read:list_account_recordings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /videosdk/recordings - Read
List session's recordings
Get all the **recordings** from a session instance. The recording files can be downloaded via the `download_url` property listed in the response. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:read:list_session_recordings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /videosdk/sessions/{sessionId}/recordings - Write
Create a recording registrant
Register a user to gain access to **On-demand cloud recordings** of a previous meeting. 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](/api-reference/zoom-api/methods#operation/meetingRecordingRegistrantCreate) to view these recordings. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write:admin`,`recording:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:write:recording_registrant`,`cloud_recording:write:recording_registrant:master`,`cloud_recording:write:recording_registrant:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /meetings/{meetingId}/recordings/registrants - Write
Update registration questions
Update registration questions for users to answer while registering to view a recording. 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. Learn more about [enabling cloud recordings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063923) and [managing cloud recording settings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065362). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write:admin`,`recording:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:update:registration_questions:admin`,`cloud_recording:update:registration_questions`,`cloud_recording:update:registration_questions:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /meetings/{meetingId}/recordings/registrants/questions - Destructive
Delete meeting or webinar recordings
Delete all of a meeting's or webinar's recording files. **Prerequisites** * Enable Cloud Recording on the user's account. Learn more about [enabling cloud recordings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063923) and [managing cloud recording settings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065362). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write:admin`,`recording:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:delete:meeting_recording`,`cloud_recording:delete:meeting_recording:admin`,`cloud_recording:delete:meeting_recording:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /meetings/{meetingId}/recordings - Destructive
Update a registrant's status
Update a 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. Learn more about [enabling cloud recordings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063923) and [managing cloud recording settings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065362). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write:admin`,`recording:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:update:registrant_status`,`cloud_recording:update:registrant_status:master`,`cloud_recording:update:registrant_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PUT /meetings/{meetingId}/recordings/registrants/status - Destructive
Update meeting recording settings
Update settings applied to a meeting's [cloud recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording). The request contains the recording content access information, which requires the current user to have the `view recording content` and `recording editing` permissions to access. Learn more about [enabling cloud recordings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063923) and [managing cloud recording settings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065362). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write:admin`,`recording:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:update:recording_settings`,`cloud_recording:update:recording_settings:master`,`cloud_recording:update:recording_settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /meetings/{meetingId}/recordings/settings - Destructive
Delete a recording file for a meeting or webinar
Delete a specific recording file from a meeting or webinar. Note: To use this API, you must enable the **The host can delete cloud recordings** setting. Find this setting in the **Recording** tab of the **Settings** interface in the [Zoom web portal](https://zoom.us/). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write:admin`,`recording:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:delete:recording_file`,`cloud_recording:delete:recording_file:admin`,`cloud_recording:delete:recording_file:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /meetings/{meetingId}/recordings/{recordingId} - Destructive
Recover a single recording
Recover a single recording file from the meeting. Zoom lets users recover recordings from trash for up to 30 days from the deletion date. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write:admin`,`recording:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:update:recover_single_recording`,`cloud_recording:update:recover_single_recording:master`,`cloud_recording:update:recover_single_recording:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /meetings/{meetingId}/recordings/{recordingId}/status - Destructive
Recover meeting recordings
Recover all deleted [cloud recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) of a specific meeting. Zoom lets users recover recordings from trash for up to 30 days from the deletion date. **Prerequisites**: * A Pro user with Cloud Recording enabled. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write:admin`,`recording:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:update:recover_meeting_recordings`,`cloud_recording:update:recover_meeting_recordings:master`,`cloud_recording:update:recover_meeting_recordings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /meetings/{meetingUUID}/recordings/status - Destructive
Delete session's recordings
Delete all recording files of a session. **Prerequisites**: * Cloud Recording should be enabled on the user's account. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:delete:session_recordings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /videosdk/sessions/{sessionId}/recordings - Destructive
Recover session's recordings
Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. **Prerequisites**: * Video SDK account with Cloud Recording enabled. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:update:recover_session_recordings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /videosdk/sessions/{sessionId}/recordings/status - Destructive
Delete session's recording file
Delete a specific recording file from a session. **Note:** To use this API, you must enable the **The host can delete cloud recordings** setting. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:delete:recording_file:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /videosdk/sessions/{sessionId}/recordings/{recordingId} - Destructive
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 session. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:update:recover_recording_file:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /videosdk/sessions/{sessionId}/recordings/{recordingId}/status
Devices
- Read
List devices
This API lets you list devices. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:read:admin`,`device:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /devices - Read
Get ZDM group info
Get Zoom Device Manager (ZDM) group information for an account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:read:list_groups:admin`,`device:read:list_groups:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /devices/groups - Read
Get Zoom Phone Appliance settings by user ID
Get a user's Zoom Phone Appliance (ZPA) device profile settings. For user-level apps, pass the `me` value instead of the `userId` parameter. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:read:user_setting:admin`,`device:read:user_setting:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /devices/zpa/settings - Read
Get ZPA version info
Get ZPA firmware and app version information that can be upgraded for devices. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:read:list_zpa_versions:admin`,`device:read:list_zpa_versions:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /devices/zpa/zdm_groups/{zdmGroupId}/versions - Read
Get device detail
Retrieve a device's details. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:read:admin`,`device:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /devices/{deviceId} - Write
Add a new device
Add a new device to Zoom account. **Scope:** `device:write:admin` **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium` **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /devices - Write
Upgrade ZPA firmware or app
Upgrade ZPA firmware or app by Zoom Device Manager (ZDM) group ID. **Prerequisites:** * Account owner or admin permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:zpa_os_app:admin`,`device:write:zpa_os_app:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
POST /devices/zpa/upgrade - Write
Change device
Change device name. **Prerequisites:** * Device must be enrolled in ZMD (Zoom Device Management) **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /devices/{deviceId} - Write
Assign a device to a group
Assign a device to a new group. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:group:admin`,`device:write:group:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /devices/{deviceId}/assign_group - Write
Change device association
Change a device's association from one Zoom Room to another. **Prerequisites** Device must be enrolled in ZDM (Zoom Device Management). \n\n**Note** Currently, only Poly TC10’s may make Zoom Room assignments. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:update:zdm_device_assignment:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /devices/{deviceId}/assignment - Destructive
Assign a device to a user or commonarea
Assign a device to a user or common area, or move a device to another user or common area, or remove a device. **Prerequisites:** * Device must be enrolled in Zoom Device Management (ZDM). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:zpa_device:admin`,`device:write:zpa_device:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /devices/zpa/assignment - Destructive
Delete ZPA device by vendor and mac address
Remove a ZPA device from the device manager, by vendor and mac address. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `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`
DELETE /devices/zpa/vendors/{vendor}/mac_addresses/{macAddress} - Destructive
Delete device
Delete a device from a Zoom account. **Prerequisites:** * Device must be enrolled in ZMD (Zoom Device Management) **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
DELETE /devices/{deviceId}
H323 Devices
- Read
List H.323/SIP devices
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 list all H.323/SIP Devices on a Zoom account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `h323:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `h323_device:read:list_devices:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /h323/devices - Write
Create 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 add a H.323/SIP device to your Zoom account **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `h323:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `h323_device:write:device:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /h323/devices - Write
Update a H.323/SIP device
Edit information for a H.323/SIP device from your Zoom account. 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. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `h323:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `h323_device:update:device:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /h323/devices/{deviceId} - Destructive
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `h323:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `h323_device:delete:device:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /h323/devices/{deviceId}
In Meeting Apps
- Write
Add a meeting app
Add an auto-open app in a meeting. This endpoint lets a developer auto-open an app in a specific meeting. This is only for configuring an app to automatically open before a given session. This can't open the app while a meeting or webinar is in session. **Prerequisites**: * The meeting must not be a live meeting. * The **Zoom Apps Quick Launch Button** setting enabled in the Zoom web portal. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:open_app`,`meeting:write:open_app:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /meetings/{meetingId}/open_apps - Destructive
Delete a meeting app
Delete a meeting auto-open app. **Prerequisites**: * The meeting must not be a live meeting. * The **Zoom Apps Quick Launch Button** setting enabled in the Zoom web portal. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:delete:open_app`,`meeting:delete:open_app:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /meetings/{meetingId}/open_apps
In Meeting Features
- Read
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting_token:read:admin:local_recording`,`meeting_token:read:local_recording` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:local_recording_token`,`meeting:read:local_recording_token:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /meetings/{meetingId}/jointoken/local_recording - Read
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 third-party closed captioning services** setting enabled. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:token`,`meeting:read:token:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /meetings/{meetingId}/token - Write
Update a live meeting message
Update 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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:live_meeting_chat_message`,`meeting:update:live_meeting_chat_message:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /live_meetings/{meetingId}/chat/messages/{messageId} - Destructive
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:delete:live_meeting_chat_message`,`meeting:delete:live_meeting_chat_message:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /live_meetings/{meetingId}/chat/messages/{messageId} - Destructive
In-meeting controls
[In-meeting](https://support.zoom.us/hc/en-us/articles/360021921032-In-Meeting-Controls) controls include starting, stopping, pausing, and resuming a recording; inviting participants; updating the waiting room with a custom message; and starting, stopping, or disabling Zoom AI. **Note:** This API's recording control only works for cloud recordings, **not** for local recordings. **Prerequisites:** * The user calling this API must be the host or an alternative meeting host. * The meeting must be a live meeting, except when inviting participants to the meeting through [call out (phone)](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062038)/[call out (room system)](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065721). * The [Cloud recording](https://support.zoom.us/hc/en-us/articles/360060231472-Enabling-cloud-recording) control must be enabled. * The [Zoom AI](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057623) control must be enabled. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`,`meeting:master` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:in_meeting_controls`,`meeting:update:in_meeting_controls:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /live_meetings/{meetingId}/events
Invitation & Registration
- Read
Get meeting invitation
Retrieve the meeting invitation note for a specific meeting. **Prerequisites**: * Host user must have a Zoom Meetings Basic license or higher. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:invitation`,`meeting:read:invitation:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /meetings/{meetingId}/invitation - Read
List meeting registrants
List users that have registered for a meeting. 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). **Prerequisites**: * Host user type must be **Pro** or higher plan. * Registration must be enabled for the meeting. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_registrants`,`meeting:read:list_registrants:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /meetings/{meetingId}/registrants - Read
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). **Prerequisites**: * Host user type must be **Pro** or higher plan. * Registration must be enabled for the meeting. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_registration_questions`,`meeting:read:list_registration_questions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /meetings/{meetingId}/registrants/questions - Read
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:registrant`,`meeting:read:registrant:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /meetings/{meetingId}/registrants/{registrantId} - Write
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:batch_registrants`,`meeting:write:batch_registrants:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
POST /meetings/{meetingId}/batch_registrants - Write
Create a meeting's invite links
Create a batch of invitation links for a meeting. **Prerequisites**: * The `ttl` value, in seconds, defines the invite link's expiration time. It must be between `0` or no expiration and `7776000` or 90 days, and has a default value of `7200` or 2 hours. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:invite_links`,`meeting:write:invite_links:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /meetings/{meetingId}/invite_links - Write
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:registrant`,`meeting:write:registrant:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /meetings/{meetingId}/registrants - Write
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). **Prerequisites**: * Host user type must be **Pro** or higher plan. * Registration must be enabled for the meeting. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:registration_question`,`meeting:update:registration_question:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /meetings/{meetingId}/registrants/questions - Destructive
Update registrant's status
Update a meeting registrant's status by either approving, cancelling or denying a registrant from joining the meeting. **Prerequisites**: * Host user type must be **Pro** or higher plan. * Registration must be enabled for the meeting. This API has an additional rate limit of requests per registrant, per 24-hour period. [See the Rate Limits page](/docs/api/rate-limits/) for more information. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:registrant_status`,`meeting:update:registrant_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PUT /meetings/{meetingId}/registrants/status - Destructive
Delete a meeting registrant
Delete a meeting registrant. **Prerequisites**: * Host user type must be Pro or higher plan. * Registration must be enabled for the meeting. * For recurring meetings: * The `registration_type` must be 2 or 3 to require the `occurrence_id` field. * If the `registration_type` is 1, the `occurrence_id` is not needed, as registrants can attend any occurrence. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:delete:registrant`,`meeting:delete:registrant:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /meetings/{meetingId}/registrants/{registrantId}
Live streaming
- Read
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting_token:read:admin:live_streaming`,`meeting_token:read:live_streaming` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:live_streaming_token`,`meeting:read:live_streaming_token:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /meetings/{meetingId}/jointoken/live_streaming - Read
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:livestream`,`meeting:read:livestream:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /meetings/{meetingId}/livestream - Write
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:livestream`,`meeting:update:livestream:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /meetings/{meetingId}/livestream - Write
Update livestream 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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:livestream_status`,`meeting:update:livestream_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /meetings/{meetingId}/livestream/status
Meeting Transcript
- Read
Get a meeting transcript
Return a meeting's [transcript](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0076632) information. Use the `download_url` property listed in the response to download the transcript content. To download the trancript, send the user's [OAuth access token](/docs/integrations/oauth/) as a Bearer token in the Authorization header. `curl -H 'Authorization: Bearer <ACCESS_TOKEN>' https://{{base-domain}}//rec/meeting/transcript/download/xyz` **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:read`,`recording:write`,`recording:read:admin`,`recording:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:read:meeting_transcript`,`cloud_recording:read:meeting_transcript:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /meetings/{meetingId}/transcript - Destructive
Delete a meeting or webinar transcript
Delete a transcript for a meeting or webinar. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write`,`recording:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:delete:meeting_transcript`,`cloud_recording:delete:meeting_transcript:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /meetings/{meetingId}/transcript
Meetings
- Read
Get a meeting
Retrieve the given meeting's details. **Prerequisites** * Host user must have a Zoom Meetings Basic license or higher. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:meeting`,`meeting:read:meeting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /meetings/{meetingId} - Read
Get a meeting SIP URI with passcode
Get a meeting's SIP URI. The URI consists of the meeting ID, and may include the 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. **Prerequisites**: * The SIP URI is valid for 2 hours, or 7200 seconds, by default. After this period, the URI will expire and the API must be called again to retrieve a new one. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:sip_dialing`,`meeting:write:admin:sip_dialing` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:sip_dialing`,`meeting:write:sip_dialing:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /meetings/{meetingId}/sip_dialing - Read
Get past meeting details
Get information about a past meeting. **Prerequisites** * The meeting must have ended before you can retrieve the data. * You cannot access a meeting that occurred more than one year ago. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:past_meeting`,`meeting:read:past_meeting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /past_meetings/{meetingId} - Read
List past meeting instances
Return a list of past meeting instances. **Prerequisites** * The meeting must have already occurred at least once. This endpoint only returns instances of meetings that have ended. * You cannot retrieve instances for meetings that occurred more than 15 months ago. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_past_instances`,`meeting:read:list_past_instances:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /past_meetings/{meetingId}/instances - Read
Get past meeting participants
Retrieve participant information for a past meeting. **Prerequisites:** * A paid account with a Pro plan or higher. * If the meeting UUID starts with `/` or contains `//`, you must double-encode the UUID before sending the request. * The meeting must be within the last 15 months. Participant data is not available for meetings older than 15 months. * By default, this endpoint does not return participant data for meetings with only one participant. To include one-participant meetings, enable the account setting **Show one person meetings and webinars on Dashboard and Reports**. * For meetings with hundreds of participants, attendance data may take time to be generated. If participant durations are returned as `0`, the request may have been made before processing completed. Wait briefly and retry. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_past_participants`,`meeting:read:list_past_participants:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /past_meetings/{meetingId}/participants - Read
List past meetings' Q&A
List Q&A of a specific 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. **Prerequisites**: * Q&A must be enabled for the meeting. * The meeting must have ended before you can retrieve the data. * You cannot retrieve Q&A data for meetings that occurred more than 15 months ago. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:past_qa`,`meeting:read:past_qa:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /past_meetings/{meetingId}/qa - Read
List meetings
List a meeting host user's scheduled meetings. For user-level apps, pass [the `me` value](/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter. **Prerequisites:** * 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). * When `type` is set to `upcoming`, `upcoming_meetings`, or `previous_meetings`, only a maximum of 6 months of meeting data will be returned. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_meetings`,`meeting:read:list_meetings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /users/{userId}/meetings - Read
List upcoming meetings
List a Zoom user's upcoming meetings. For user-level apps, pass [the `me` value](/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter. **Notes**: * This API includes the meetings that Zoom users schedule and the meetings they are invited to join. * This API only includes upcoming meetings within the next 24 hours. **Prerequisites**: * To retrieve data for Zoom meetings that the user has been invited to from a third-party calendar (Google, Exchange, Office 365, Apple iCloud), the [**Calendar and Contacts Integration**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0069503) must be enabled in the Zoom Web Portal. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_upcoming_meetings`,`meeting:read:list_upcoming_meetings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /users/{userId}/upcoming_meetings - Write
Update participant Real-Time Media Streams (RTMS) app status
Update the Real-Time Media Streams (RTMS) status for a specific participant in an ongoing meeting. Zoom lets individuals control their own RTMS during a meeting. **Prerequisites:** * The meeting must be in progress. * Contact [Developer Support](https://developers.zoom.us/support/) to enable RTMS features. * The **Allow apps to access meeting content** setting enabled in the Zoom web portal. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:participant_rtms_app_status`,`meeting:update:participant_rtms_app_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /live_meetings/{meetingId}/rtms_app/status - Write
Update a meeting
Updates meeting details. **Prerequisites** * The `start_time` value must be a future date. If the value is omitted or a date is in the past, the API ignores this value and does not update any recurring meetings. * The `recurrence` object is required only when updating the entire series of a recurring meeting with `type=8`. * This API has a rate limit of **100 requests per day**. You can update a meeting for a maximum of 100 times within a 24-hour period. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:meeting:admin`,`meeting:update:meeting` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /meetings/{meetingId} - Write
Create a meeting
[Creates 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/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter. **Prerequisites:** * A meeting's `start_url` value is the URL a host or an alternative host can use to start a meeting. The `start_url` value's expiration time is **two hours** for all regular users. * For `custCreate` meeting hosts - users created with the `custCreate` parameter via the [**Create users**](/docs/api/users/#tag/users/POST/users) API - the expiration time of the `start_url` parameter is **90 days** from the generation of the `start_url`. * For security reasons, the recommended way to programmatically get the updated `start_url` value after expiry is to call the [**Get a meeting**](/docs/api/meetings/#tag/meetings/GET/meetings/{meetingId}) 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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:meeting`,`meeting:write:meeting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /users/{userId}/meetings - Destructive
Delete a meeting
Delete a meeting. **Prerequisites**: * For recurring meetings, the `occurrence_id` is required to delete a specific occurrence. If not provided, the entire recurring series will be deleted. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:delete:meeting`,`meeting:delete:meeting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /meetings/{meetingId} - Destructive
Update meeting status
Update the status of a meeting. **Prerequisites**: * Host user must have a Zoom Meetings Basic license or higher. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:status`,`meeting:update:status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /meetings/{meetingId}/status
PAC
- Read
List a user's PAC accounts
Retrieve a list of 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://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) 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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `pac:read:admin`,`pac:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `pac:read:list_pac_accounts`,`pac:read:list_pac_accounts:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /users/{userId}/pac
Polls
- Read
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_polls`,`meeting:read:list_polls:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /meetings/{meetingId}/polls - Read
Get a meeting poll
Retrieves information about a specific meeting [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings). **Prerequisites**: * Host must have Pro or higher plan. * Enable the **Meeting Polls/Quizzes** setting in the Zoom web portal. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:poll`,`meeting:read:poll:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /meetings/{meetingId}/polls/{pollId} - Read
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_poll_results`,`meeting:read:list_poll_results:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /past_meetings/{meetingId}/polls - Write
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:batch_polls`,`meeting:write:batch_polls:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /meetings/{meetingId}/batch_polls - Write
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:poll`,`meeting:write:poll:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /meetings/{meetingId}/polls - Destructive
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). **Prerequisites**: * Host user type must be **Pro** or higher plan. * The **Meeting Polls/Quizzes** setting enabled in the Zoom web portal. * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:poll`,`meeting:update:poll:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /meetings/{meetingId}/polls/{pollId} - Destructive
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:delete:poll`,`meeting:delete:poll:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /meetings/{meetingId}/polls/{pollId}
SIP Phone
- Read
List SIP phones
List SIP phones on an account. Zoom's Phone System Integration (PSI), also referred as SIP phones, enables an organization to leverage the Zoom client to complete a Softphone registration to supported premise based PBX system. End users will have the ability to have Softphone functionality within a single client while maintaining a comparable interface to Zoom Phone. **Prerequisites**: * Currently only supported on Cisco and Avaya PBX systems. * User must enable SIP Phone Integration by contacting the [Sales](https://zoom.us/contactsales) team. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:read:list_sip_phones:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /sip_phones/phones - Write
Enable SIP phone
Enable a user to use a SIP phone. Zoom's Phone System Integration (PSI), also referred as SIP phones, enables an organization to leverage the Zoom client to complete a softphone registration to supported premise based PBX system. End users will have the ability to have softphone functionality within a single client while maintaining a comparable interface to Zoom Phone. **Prerequisites**: * Currently only supported on Cisco and Avaya PBX systems. * The account owner or account admin must first enable SIP Phone Integration by contacting the [Sales](https://zoom.us/contactsales) team. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:write:sip_phone:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /sip_phones/phones - Write
Update SIP phone
Update the information of a specific SIP phone on a Zoom account. Zoom's Phone System Integration (PSI), also referred as SIP phones, lets an organization leverage the Zoom client to complete a softphone registration to supported premise based PBX system. End users can have softphone functionality within a single client while maintaining a comparable interface to a Zoom Phone. **Prerequisites**: * Currently only supported on Cisco and Avaya PBX systems. * The account owner or account admin must first enable SIP Phone Integration by contacting the [Sales](https://zoom.us/contactsales) team. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:update:sip_phone:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /sip_phones/phones/{phoneId} - Destructive
Delete SIP phone
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:delete:sip_phone:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /sip_phones/phones/{phoneId}
Summaries
- Read
List an account's meeting or webinar summaries
Retrieve a list of all meeting or webinar summaries available for an account. **Prerequisites** * The host must have a Pro, Business, or higher subscription plan. * For meetings - the host's **Meeting Summary with AI Companion** user setting must be enabled. * For webinars - the host's **Webinar Summary with AI Companion** user setting must be enabled. * End-to-End Encrypted (E2EE) meetings do not support summaries. Learn more about [enabling or disabling AI Companion meeting summaries](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057960). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting_summary:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_summaries:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /meetings/meeting_summaries - Read
Get a meeting or webinar summary
Retrieve the summary of a meeting or webinar. **Prerequisites** - The host must have a Pro, Business, or higher subscription plan. - For meetings - the host's **Meeting Summary with AI Companion** user setting must be enabled. - For webinars - the host's **Webinar Summary with AI Companion** user setting must be enabled. - End-to-End Encrypted (E2EE) meetings do not support summaries. Learn more about [enabling or disabling AI Companion meeting summaries](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057960). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting_summary:read`,`meeting_summary:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:summary`,`meeting:read:summary:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /meetings/{meetingId}/meeting_summary - Read
List a user's meeting or webinar summaries
Retrieve a list of meeting or webinar summaries hosted by the specified user. **Prerequisites** * The host must have a Pro, Business, or higher subscription plan. * For meetings - the host's **Meeting Summary with AI Companion** user setting must be enabled. * For webinars - the host's **Webinar Summary with AI Companion** user setting must be enabled. * End-to-End Encrypted (E2EE) meetings do not support summaries. The specified user must belong to the current account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting_summary:read`,`meeting_summary:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_summaries`,`meeting:read:list_summaries:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /users/{userId}/meeting_summaries - Destructive
Delete a meeting or webinar summary
Delete the summary of a meeting or webinar. **Prerequisites** * The host must have a Pro, Business, or higher subscription plan. * For meetings - the host's **Meeting Summary with AI Companion** user setting must be enabled. * For webinars - the host's **Webinar Summary with AI Companion** user setting must be enabled. * End-to-End Encrypted (E2EE) meetings do not support summaries. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting_summary:write`,`meeting_summary:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:delete:summary`,`meeting:delete:summary:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /meetings/{meetingId}/meeting_summary
Surveys
- Read
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:survey`,`meeting:read:survey:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /meetings/{meetingId}/survey - Write
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:survey`,`meeting:update:survey:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /meetings/{meetingId}/survey - Destructive
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:delete:survey`,`meeting:delete:survey:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /meetings/{meetingId}/survey
TSP
- Read
Get account's TSP information
Get information on Telephony Service Provider (TSP) on an account level. **Prerequisites** * TSP audio must be enabled on the Zoom account before using this API. * The Zoom account must have a Pro or higher subscription plan to enable TSP. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:read:tsp:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /tsp - Read
List user's TSP accounts
List all of a user's TSP accounts. A user can have a maximum of two TSP accounts. **Prerequisites** * TSP (Telephony Service Provider) audio must be enabled on the Zoom account before using this API. * The Zoom account must have a Pro or higher subscription plan to enable TSP. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:read:admin`,`tsp:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:read:list_tsp_accounts`,`tsp:read:list_tsp_accounts:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /users/{userId}/tsp - Read
Get a user's TSP account
Retrieve details of a specific TSP account enabled for a specific user. Each user can have a maximum of two TSP accounts. **Prerequisites** * TSP (Telephony Service Provider) audio must be enabled on the Zoom account before using this API. * The Zoom account must have a Pro or higher subscription plan to enable TSP. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:read:admin`,`tsp:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:read:tsp_account`,`tsp:read:tsp_account:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /users/{userId}/tsp/{tspId} - Write
Update an account's TSP information
Update information of the Telephony Service Provider (TSP) set up on an account. **Prerequisites** * Enable TSP on the Zoom account before using this API. * A Pro or higher subscription plan to enable TSP. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:update:tsp:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /tsp - Write
Add a user's TSP account
Add a user's TSP account. **Prerequisites** * TSP (Telephony Service Provider) audio must be enabled on the Zoom account before using this API. * The Zoom account must have a Pro or higher subscription plan to enable TSP. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:write:admin`,`tsp:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:write:tsp_account`,`tsp:write:tsp_account:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /users/{userId}/tsp - Write
Set global dial-in URL for a TSP user
Set the URL for a global dial-in page of a user whose Zoom account has TSP and special TSP with third-party audio conferencing options enabled. A global dial-in page can provide a list of global access numbers to use to conduct audio conferencing. **Prerequisites** * TSP (Telephony Service Provider) audio must be enabled on the Zoom account before using this API. * The Zoom account must have a Pro or higher subscription plan to enable TSP. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:write:admin`,`tsp:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:update:tsp_settings`,`tsp:update:tsp_settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /users/{userId}/tsp/settings - Write
Update a TSP account
Update a user's Telephony Service Provider (TSP) account. **Prerequisites** * TSP audio enabled on the Zoom account before using this API. * A Pro or higher subscription plan to enable TSP. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:write:admin`,`tsp:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:update:tsp_account`,`tsp:update:tsp_account:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /users/{userId}/tsp/{tspId} - Destructive
Delete a user's TSP account
Delete a user's TSP account. **Prerequisites** * TSP (Telephony Service Provider) audio must be enabled on the Zoom account before using this API. * The Zoom account must have a Pro or higher subscription plan to enable TSP. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:write:admin`,`tsp:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:delete:tsp_account`,`tsp:delete:tsp_account:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /users/{userId}/tsp/{tspId}
Templates
- Read
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](/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter. **Prerequisites**: * Host user must have a Zoom Meetings Basic license or higher. [Learn more about creating and managing meeting templates](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067229). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_templates`,`meeting:read:list_templates:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /users/{userId}/meeting_templates - Destructive
Create a meeting template from an existing meeting
Create a meeting template from an existing meeting. **Prerequisites** * Host user must have a Zoom Meetings Basic license or higher. * You can only create up to 40 meeting templates. [Learn more about creating and managing meeting templates](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067229). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:template`,`meeting:write:template:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /users/{userId}/meeting_templates
Tracking Field
- Read
List tracking fields
List all the [tracking fields](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) on your Zoom account. Tracking fields let you analyze usage by various fields within an organization. **Prerequisites:** * A Business, Education, API or higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_fields:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_field:read:list_tracking_fields:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /tracking_fields - Read
Get a tracking field
Use this API to return information about a [tracking field](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields). **Prerequisites:** * A Business, Education, API or higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_fields:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_field:read:tracking_field:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /tracking_fields/{fieldId} - Write
Create a tracking field
Use this API to create a new [tracking field](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields). Tracking fields let you analyze usage by various fields within an organization. When scheduling a meeting, tracking fields will be included in the meeting options. **Prerequisites:** * A Business, Education, API or higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_fields:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_field:write:tracking_field:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /tracking_fields - Write
Update a tracking field
Update a [tracking field](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields). **Prerequisites:** * A Business, Education, API or higher plan. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_fields:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_field:update:tracking_field:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /tracking_fields/{fieldId} - Destructive
Delete a tracking field
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_fields:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_field:delete:tracking_field:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /tracking_fields/{fieldId}
Webinars
- Read
Get webinar absentees
List absentees of a webinar. **Prerequisites** * A Pro or higher plan with a [Webinar plan](https://zoom.us/webinar) add-on. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_absentees`,`webinar:read:list_absentees:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /past_webinars/{webinarId}/absentees - Read
List past webinar instances
List past webinar instances. **Prerequisites** * A Pro or higher plan with a [Webinar plan](https://zoom.us/webinar) add-on. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_past_instances`,`webinar:read:list_past_instances:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /past_webinars/{webinarId}/instances - Read
List webinar participants
Retrieve a list of all the participants who attended a webinar hosted in the past. **Prerequisites:** * A Pro or higher plan with a webinar add-on. **NOTE:** After meetings with hundreds of participants, the attendance data takes some time to be generated. If you receive a duration of 0 for users' time in the meeting, you may have called the endpoint before the data is fully processed. Implement a short delay or retry logic before fetching participant data. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_past_participants:admin`,`webinar:read:list_past_participants` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /past_webinars/{webinarId}/participants - Read
List past webinar poll results
The polling feature for webinar lets you create single-choice or multiple-choice polling questions for your webinars. This API endpoint retrieves the results for webinar polls of a specific webinar. **Prerequisites:** * [Webinar license](https://zoom.us/webinar) **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_past_polls`,`webinar:read:list_past_polls:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /past_webinars/{webinarId}/polls - Read
List Q&As of a past webinar
List the Q&A of a specific past webinar. The [question and answer (Q&A)](https://support.zoom.us/hc/en-us/articles/203686015-Getting-Started-with-Question-Answer) feature for webinars lets attendees ask questions during the webinar and for the panelists, co-hosts and host to answer their questions. **Prerequisites** * [Webinar license](https://zoom.us/webinar) **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:past_qa`,`webinar:read:past_qa:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /past_webinars/{webinarId}/qa - Read
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read`,`webinar:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_templates`,`webinar:read:list_templates:admin`
GET /users/{userId}/webinar_templates - Read
List webinars
List all the webinars scheduled by or on behalf a 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 let a host 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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_webinars`,`webinar:read:list_webinars:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /users/{userId}/webinars - Read
Get a webinar
Get details for a scheduled Zoom webinar. **Prerequisites** * Pro or higher plan with a Webinar add-on. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:webinar`,`webinar:read:webinar:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /webinars/{webinarId} - Read
Get webinar's session branding
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 a [Webinar plan](https://zoom.us/webinar) add-on. * Enable the **Webinar Session Branding** setting. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read`,`webinar:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:branding`,`webinar:read:branding:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /webinars/{webinarId}/branding - Read
Get a webinar's join token for live streaming
Retrieve a webinar's archive token to allow live streaming. The join token lets a recording bot implemented using Zoom meeting SDK 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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar_token:read:admin:live_streaming`,`webinar_token:read:live_streaming` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:live_streaming_token`,`webinar:read:live_streaming_token:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /webinars/{webinarId}/jointoken/live_streaming - Read
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar_token:read:admin:local_archiving` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:local_archiving_token:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /webinars/{webinarId}/jointoken/local_archiving - Read
Get a webinar's join token for local recording
Retrieve a webinar's join token to allow for local recording. The join token lets a recording bot implemented using Zoom Meeting SDK connect to a Zoom webinar. The recording bot can then automatically start locally recording. This supports both regular and raw local recording. **Prerequisites:** * A Pro or higher plan with a Webinar add-on. * The **Local recording** user setting enabled in the Zoom web portal. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar_token:read:admin:local_recording`,`webinar_token:read:local_recording` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:local_recording_token`,`webinar:read:local_recording_token:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /webinars/{webinarId}/jointoken/local_recording - Read
Get live stream details
Get a webinar's live stream configuration details, such as Stream URL, Stream Key and Page URL. 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. **Prerequisites:** * Pro or higher plan with the 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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:livestream`,`webinar:read:livestream:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /webinars/{webinarId}/livestream - Read
List panelists
List all of a webinar's panelists. Webinar panelists can view and send video, screen share, annotate, and do much more compared to webinar attendees. **Prerequisites:** * Pro or a higher plan with [Webinar Add-on](https://zoom.us/webinar). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_panelists`,`webinar:read:list_panelists:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /webinars/{webinarId}/panelists - Read
List a webinar's polls
Lists all the [polls](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) of a webinar. **Prerequisites** * A Pro or higher plan with a [Webinar plan](https://zoom.us/webinar) add-on. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_polls`,`webinar:read:list_polls:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /webinars/{webinarId}/polls - Read
Get a webinar poll
Returns a webinar's [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) details. **Prerequisites** * A Pro or higher plan with a [Webinar plan](https://zoom.us/webinar) add-on. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:poll`,`webinar:read:poll:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /webinars/{webinarId}/polls/{pollId} - Read
List webinar registrants
List all users that have registered for a given webinar. Zoom users with a [webinar plan](https://zoom.us/webinar) have access to creating and managing webinars. The webinar functionality lets a host 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** * Pro or higher plan with a Webinar add-on. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_registrants`,`webinar:read:list_registrants:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /webinars/{webinarId}/registrants - Read
List registration questions
List registration questions and fields that are to be answered by users while registering for a webinar. 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. **Prerequisites:** * Pro or higher plan with the webinar add-on. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_registration_questions`,`webinar:read:list_registration_questions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /webinars/{webinarId}/registrants/questions - Read
Get a webinar registrant
Zoom users with a [webinar plan](https://zoom.us/webinar) have access to creating and managing webinars. The webinar feature lets a host 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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:registrant`,`webinar:read:registrant:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /webinars/{webinarId}/registrants/{registrantId} - Read
Get a webinar SIP URI with passcode
Get a webinar's SIP URI. The URI consists of the webinar ID, an 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. **Prerequisites** * A Pro or higher plan with a [Webinar plan](https://zoom.us/webinar) add-on. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:sip_dialing`,`webinar:write:admin:sip_dialing` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:sip_dialing`,`webinar:write:sip_dialing:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /webinars/{webinarId}/sip_dialing - Read
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:survey`,`webinar:read:survey:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /webinars/{webinarId}/survey - Read
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read`,`webinar:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:token`,`webinar:read:token:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /webinars/{webinarId}/token - Read
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_tracking_sources`,`webinar:read:list_tracking_sources:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /webinars/{webinarId}/tracking_sources - Write
Create a webinar
Schedule a webinar for a user who is a webinar host. For user-level apps, pass [the `me` value](/docs/api/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter. Webinars allow a host to broadcast a Zoom meeting to up to 10,000 attendees. **Rate limit** Up to a maximum of **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 plan](https://zoom.us/webinar) add-on. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:webinar`,`webinar:write:webinar:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /users/{userId}/webinars - Write
Update a webinar
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:webinar`,`webinar:update:webinar:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /webinars/{webinarId} - Write
Perform batch registration
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 type `5`, a scheduled webinar. Other types of webinars are not supported by this API. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:batch_registrants`,`webinar:write:batch_registrants:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
POST /webinars/{webinarId}/batch_registrants - Write
Create a webinar's branding name tag
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:branding_name_tag`,`webinar:write:branding_name_tag:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /webinars/{webinarId}/branding/name_tags - Write
Update a webinar's branding name tag
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:branding_name_tag`,`webinar:update:branding_name_tag:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /webinars/{webinarId}/branding/name_tags/{nameTagId} - Write
Upload a webinar's branding virtual background
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 these 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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:branding_virtual_background`,`webinar:write:branding_virtual_background:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /webinars/{webinarId}/branding/virtual_backgrounds - Write
Set webinar's default branding virtual background
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:branding_virtual_background`,`webinar:update:branding_virtual_background:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /webinars/{webinarId}/branding/virtual_backgrounds - Write
Upload a webinar's branding wallpaper
Upload a webinar's session branding wallpaper file. Webinar branding wallpaper files have these 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. * The wallpaper file size cannot exceed 15 megabytes. **Prerequisites:** * The **Webinar Session Branding** setting enabled. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:branding_wallpaper`,`webinar:write:branding_wallpaper:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /webinars/{webinarId}/branding/wallpaper - Write
Create webinar's invite links
Create a batch of invitation links for a webinar. **Prerequisites:** * Business, Education or API Plan with the Webinar add-on. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:invite_links`,`webinar:write:invite_links:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /webinars/{webinarId}/invite_links - Write
Update a live stream
Update a webinar's live stream information. **Prerequisites:** * Pro or higher plan with the webinar add-on. * Live streaming details must be [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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:livestream`,`webinar:update:livestream:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /webinars/{webinarId}/livestream - Write
Update live stream status
Lets users [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. Update the status of a webinar's live stream. **Prerequisites:** * Pro or higher plan with a Webinar Add-on. * Live streaming details must be [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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:livestream_status`,`webinar:update:livestream_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /webinars/{webinarId}/livestream/status - Write
Add panelists
Panelists in a webinar can view and send video, screen share, annotate, and do much more compared to attendees in a webinar. [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 the [Webinar Add-on](https://zoom.us/webinar). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:panelist`,`webinar:write:panelist:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /webinars/{webinarId}/panelists - Write
Create a webinar's poll
Creates a [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) for a webinar. **Prerequisites** * A Pro or higher plan with a [Webinar plan](https://zoom.us/webinar) add-on. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:poll`,`webinar:write:poll:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /webinars/{webinarId}/polls - Write
Add a webinar registrant
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:registrant`,`webinar:write:registrant:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /webinars/{webinarId}/registrants - Write
Update registration questions
Update registration questions and fields of a scheduled webinar for users to answer during webinar registration. 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. **Prerequisites:** * Pro or higher plan with a Webinar Add-on. * Registration option for Webinar should be set as required to use this API. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:registration_question`,`webinar:update:registration_question:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /webinars/{webinarId}/registrants/questions - Write
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:survey`,`webinar:update:survey:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /webinars/{webinarId}/survey - Destructive
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:live_webinar_chat_message`,`webinar:delete:live_webinar_chat_message:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /live_webinars/{webinarId}/chat/messages/{messageId} - Destructive
Create a webinar template
Create a webinar template from an existing webinar. **Prerequisites** * A Pro or higher plan with a [Webinar plan](https://zoom.us/webinar) add-on. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:template`,`webinar:write:template:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /users/{userId}/webinar_templates - Destructive
Delete a webinar
Delete a webinar. **Prerequisites:** * Pro or higher plan with the webinar add-on. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:webinar`,`webinar:delete:webinar:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /webinars/{webinarId} - Destructive
Delete a webinar's branding name tag
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:branding_name_tag`,`webinar:delete:branding_name_tag:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /webinars/{webinarId}/branding/name_tags - Destructive
Delete a webinar's branding virtual backgrounds
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:branding_virtual_background`,`webinar:delete:branding_virtual_background:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /webinars/{webinarId}/branding/virtual_backgrounds - Destructive
Delete a webinar's branding wallpaper
Delete a webinar's session branding wallpaper file. **Prerequisites:** * The **Webinar Session Branding** setting enabled. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:branding_wallpaper`,`webinar:delete:branding_wallpaper:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /webinars/{webinarId}/branding/wallpaper - Destructive
Remove all panelists
Remove all the panelists from a webinar. **Prerequisites:** * Pro or a higher plan with the [webinar add-on](https://zoom.us/webinar). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:panelist`,`webinar:delete:panelist:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /webinars/{webinarId}/panelists - Destructive
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:panelist`,`webinar:delete:panelist:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /webinars/{webinarId}/panelists/{panelistId} - Destructive
Update a webinar poll
Updates a webinar's [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars). **Prerequisites** * A Pro or higher plan with a [Webinar plan](https://zoom.us/webinar) add-on. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:poll`,`webinar:update:poll:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /webinars/{webinarId}/polls/{pollId} - Destructive
Delete a webinar poll
Delete a webinar's [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars). **Prerequisites** * A Pro or higher plan with a [Webinar plan](https://zoom.us/webinar) add-on. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:poll`,`webinar:delete:poll:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /webinars/{webinarId}/polls/{pollId} - Destructive
Update registrant's status
Update webinar registrants' registration status. You can approve or deny a registrant, or revoke a registrant's approval. **Prerequisites** * A Pro or higher plan with a [Webinar plan](https://zoom.us/webinar) add-on. This API has an additional rate limit of requests per registrant, per 24-hour period. [See the Rate Limits page](/docs/api/rate-limits/) for more information. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:registrant_status`,`webinar:update:registrant_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PUT /webinars/{webinarId}/registrants/status - Destructive
Delete a webinar registrant
Delete a webinar registrant. **Prerequisites** * A Pro or higher plan with a [Webinar plan](https://zoom.us/webinar) add-on. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:registrant`,`webinar:delete:registrant:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /webinars/{webinarId}/registrants/{registrantId} - Destructive
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:status`,`webinar:update:status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /webinars/{webinarId}/status - Destructive
Delete a webinar survey
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:survey`,`webinar:delete:survey:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /webinars/{webinarId}/survey
My Notes Management
- Read
List my notes
Retrieves the user's notes associated with a specific meeting. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `my_notes:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `my_notes:read:note` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /my_notes/notes - Read
Get My Notes content and transcript
Retrieve a note from My Notes, including its metadata and note content. Optionally include the associated meeting transcript by setting `include=transcript`. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `my_notes_content:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `my_notes:read:content` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
GET /my_notes/notes/{noteId}/content
Cloud Peering Provider Exchange
- Read
List peering phone numbers for provider
Returns phone numbers the carrier pushes to different customers. **Prerequisites** * [Enable Number Management](https://zoom.us/cpw/page/phoneNumbers#/number-list) * Developer is a provider exchange partner, with the cloud peering infrastructure established with Zoom. * Zoom account needs to have a Zoom Phone license or a Zoom Contact Center license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:read:list_carrier_peering_numbers:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /number_management/carrier/peering_numbers - Read
List peering phone numbers
Returns the details associated with a specific phone number, or all the phone numbers the partner previously provisioned for the Zoom customer account. **Prerequisites:** * [Enable Number Management](https://zoom.us/cpw/page/phoneNumbers#/number-list) * Developer is a provider exchange partner, with the cloud peering infrastructure established with Zoom. * Zoom account needs to have a Zoom Phone license or a Zoom Contact Center license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:read:list_peering_numbers:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /number_management/peering_numbers - Write
Add peering phone numbers
Enables provider exchange partners to add phone numbers to a Zoom account. **Prerequisites** * [Enable Number Management](https://zoom.us/cpw/page/phoneNumbers#/number-list) * Developer is a provider exchange partner, with the cloud peering infrastructure established with Zoom. * Zoom account needs to have a Zoom Phone license or a Zoom Contact Center license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:write:peering_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /number_management/peering_numbers - Write
Update peering phone numbers
Allows partners to update the status or details associated with the phone numbers. **Prerequisites** * [Enable Number Management](https://zoom.us/cpw/page/phoneNumbers#/number-list) * Developer is a provider exchange partner, with the cloud peering infrastructure established with Zoom. * Zoom account needs to have a Zoom Phone license or a Zoom Contact Center license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:update:peering_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /number_management/peering_numbers - Destructive
Remove peering phone numbers
Removes the phone number from the Zoom customer account. Partners can remove only the phone numbers they have previously added to Zoom account. **Prerequisites:** * [Enable Number Management](https://zoom.us/cpw/page/phoneNumbers#/number-list) * Developer is a provider exchange partner, with the cloud peering infrastructure established with Zoom. * Zoom account needs to have a Zoom Phone license or a Zoom Contact Center license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:delete:peering_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /number_management/peering_numbers
Phone Numbers
- Read
List phone numbers
Returns a list of phone numbers in an account. See section <b>Information in the phone number table</b> of [Using Number Management for managing phone numbers](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0074457#h_60222313850311712763891581) for more details. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:read:list_numbers:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /number_management/numbers - Read
Get a phone number
Returns information about an account's phone number. For more details, see the section <b>Information in the phone number table</b> in [Using Number Management for managing phone numbers](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0074457#h_60222313850311712763891581). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:read:numbers:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /number_management/numbers/{phoneNumberId} - Read
List account emergency number pool phone numbers
Returns phone numbers in the account-level [Emergency Number Pool](https://support.zoom.us/hc/en-us/articles/360062110192-Routing-emergency-calls). **This endpoint can only be used for accounts where Multiple Sites is disabled.** For accounts with Multiple Sites enabled, use **List site emergency number pool phone numbers** instead. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:emergency_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/emergency_number_pools/phone_numbers - Read
List phone numbers (deprecated)
Returns a list all Zoom Phone numbers in a Zoom account. **Prerequisites:** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_numbers:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/numbers - Read
Get a phone number (deprecated)
Returns information about an account's Zoom Phone number. **Prerequisites:** * A Pro or higher account plan * A Zoom phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:numbers:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/numbers/{phoneNumberId} - Read
List site emergency number pool phone numbers
Returns phone numbers in the site-level [Emergency Number Pool](https://support.zoom.us/hc/en-us/articles/360062110192-Routing-emergency-calls). **This endpoint can only be used for accounts where Multiple Sites is enabled.** For accounts with Multiple Sites disabled, use **List account emergency number pool phone numbers** instead. **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_sites_emergency_numbers:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/sites/{siteId}/emergency_number_pools/phone_numbers - Write
Allocate/Unallocate phone numbers
Allocates or unallocates phone numbers for those with CPL routing. <p>Note: When allocating phone numbers, if there are any native numbers, they must belong to the same country or region, and have the same number plan.</p> **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:write:numbers:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
PATCH /number_management/allocation - Write
Add BYOC phone numbers
Adds BYOC (Bring Your Own Carrier) phone numbers to Zoom Phone. **Prerequisites:** * A Business or Enterprise plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:write:byoc_numbers:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /number_management/byoc_numbers - Write
Update a phone number
Updates a phone number's information. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:update:numbers:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /number_management/numbers/{phoneNumberId} - Write
Move Operator Connect Number Microsoft tenant
Update the tenant of an Operator Connect phone number. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:update:move_number_ms_tenant:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /number_management/numbers/{phoneNumberId}/move_ms_tenant - Write
Add BYOC phone numbers (deprecated)
Adds BYOC (Bring Your Own Carrier) phone numbers to Zoom Phone. **Prerequisites** * A Business or Enterprise plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:byo_carrier_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/byoc_numbers - Write
Assign phone numbers to the emergency number pool
Assigns phone numbers to the [Emergency Number Pool](https://support.zoom.us/hc/en-us/articles/360062110192-Routing-emergency-calls). Only full PSTN numbers (numbers that support both incoming and outgoing calls) with a stable (`normal`) status can be assigned. You can assign up to 300 numbers per request (`phone_numbers`), and up to a total of 1,000 numbers per pool per assignment operation. **Prerequisites** * A Business or Enterprise account * A Zoom Phone license * [Route emergency calls to PSAP](https://support.zoom.us/hc/en-us/articles/360062110192) must be enabled, and the **Caller ID method** for Emergency Service Routing — for the site if Multiple Sites is enabled, or for the account if Multiple Sites is disabled — must already be set to **Temporary number from local emergency pool**. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:emergency_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/emergency_number_pools/phone_numbers - Write
Update a site's unassigned phone numbers
Updates a site's unassigned [phone numbers](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers#h_38ba8b01-26e3-4b1b-a9b5-0717c00a7ca6). Up to 20 phone numbers can be updated in a single request. **Prerequisites:** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:site_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
PATCH /phone/numbers/sites/{siteId} - Write
Update a phone number (deprecated)
Updates a Zoom Phone number's information. **Prerequisites:** * A Paid account **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/numbers/{phoneNumberId} - Write
Assign a phone number to a user
Assigns a [phone number](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers) to a user who has already enabled Zoom Phone.**Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:user_number`,`phone:write:user_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/users/{userId}/phone_numbers - Destructive
Delete phone numbers
Deletes phone numbers. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:master` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:delete:numbers:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /number_management/numbers - Destructive
Unassign phone numbers from the emergency number pool
Unassigns phone numbers from the [Emergency Number Pool](https://support.zoom.us/hc/en-us/articles/360062110192-Routing-emergency-calls). **Prerequisites** * A Business or Enterprise account * A Zoom Phone license * If the Caller ID method for Emergency Service Routing — for the site if Multiple Sites is enabled, or for the account if Multiple Sites is disabled — is currently set to **Temporary number from local emergency pool**, at least one number must remain assigned to the pool; unassigning the last remaining number fails with a `400` error (see Responses below). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:emergency_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/emergency_number_pools/phone_numbers/{phoneNumberId} - Destructive
Delete unassigned phone numbers (deprecated)
Deletes unassigned [phone numbers](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers#h_38ba8b01-26e3-4b1b-a9b5-0717c00a7ca6). Up to 20 phone numbers can be removed in a single request. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license * The user must have been previously assigned a Zoom Phone number **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /phone/numbers - Destructive
Unassign a phone number
Unassigns Zoom Phone user's [phone number](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers#h_38ba8b01-26e3-4b1b-a9b5-0717c00a7ca6). After assigning a phone number, you can remove it if you do not want it to be assigned to anyone. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license * The user must have been previously assigned a Zoom Phone number **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:user_number`,`phone:delete:user_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/users/{userId}/phone_numbers/{phoneNumberId}
Phone Plan
- Read
List phone number plan information
Retrieves an account's phone number plan information, phone number usage, and availability. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:read:numbers_plan:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /number_management/plan
SMS Campaigns
- Read
List SMS campaigns
Returns a list of all SMS campaigns in a Zoom account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:read:list_sms_campaigns:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /number_management/sms_campaigns - Read
Get an SMS campaign
Returns a specific SMS campaign. **Prerequisites** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:read:sms_campaign:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /number_management/sms_campaigns/{smsCampaignId} - Write
Assign a phone number to SMS campaign
[Assigns a phone number to the SMS campaign](https://support.zoom.us/hc/en-us/articles/5016496738445-SMS-MMS-10DLC-Compliance-for-Zoom-Phone-and-Zoom-Contact-Center#h_01FYVVQM1WMW5JD48YNY3J581B). **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:update:numbers:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /number_management/sms_campaigns/{smsCampaignId}/phone_numbers - Destructive
Unassign phone number from SMS campaign
[Unassigns a phone number from an SMS campaign](https://support.zoom.us/hc/en-us/articles/5016496738445-SMS-MMS-10DLC-Compliance-for-Zoom-Phone-and-Zoom-Contact-Center#h_01FYVVSPVM8MZN4Y9EW5690QHH). **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license * The campaign must have been previously assigned a Zoom Phone number **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:update:numbers:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /number_management/sms_campaigns/{smsCampaignId}/phone_numbers
SMS Consent
- Read
List SMS consent policies
Returns a paginated list of SMS consent policies for the account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:read:sms_consent:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /number_management/sms_consent - Read
Get an SMS consent policy
Returns a specific SMS consent policy by ID. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:read:sms_consent:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /number_management/sms_consent/{consentId} - Read
List phone numbers assigned to SMS consent policy
Returns a paginated list of phone numbers assigned to a specific SMS consent policy. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:read:sms_consent:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /number_management/sms_consent/{consentId}/phone_numbers - Read
List opt statuses of phone numbers assigned to SMS consent
Returns the opt statuses of phone numbers that are assigned to SMS consent. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:sms_consent_number_opt_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/sms_consent/{consentId}/phone_numbers/opt_status - Write
Create an SMS consent policy
Creates a new SMS consent management policy to define opt-in, opt-out, and help message configurations for SMS communications. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:write:sms_consent:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /number_management/sms_consent - Write
Update an SMS consent policy
Updates an existing SMS consent policy. Only provided fields will be updated. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:update:sms_consent:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /number_management/sms_consent/{consentId} - Write
Assign phone numbers to SMS consent policy
Assigns one or more phone numbers to an SMS consent policy. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:write:numbers:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /number_management/sms_consent/{consentId}/phone_numbers - Destructive
Delete SMS consent policies
Deletes one or more SMS consent policies. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:delete:sms_consent:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /number_management/sms_consent - Destructive
Unassign phone numbers from SMS consent policy
Unassigns one or more phone numbers from an SMS consent policy. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:delete:numbers:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /number_management/sms_consent/{consentId}/phone_numbers
Setting
- Read
List ported numbers
Returns a list of ported numbers in a Zoom account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:read:list_ported_numbers:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /number_management/ported_numbers/orders - Read
Get ported numbers details
Returns the details on the ported numbers by specifying `order_id`. **Prerequisites** * A Pro or higher account plan * A Zoom phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:read:ported_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /number_management/ported_numbers/orders/{orderId} - Read
List SIP groups
Returns a list of SIP (Session Initiation Protocol) groups. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:read:list_sip_groups:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /number_management/sip_groups - Read
List BYOC SIP trunks
Returns a list of an account's assigned BYOC (Bring Your Own Carrier) SIP (Session Initiation Protocol) trunks. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:read:list_sip_trunks:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /number_management/sip_trunks
Alerts
- Read
List alert settings with paging query
Gets [alert settings](https://support.zoom.us/hc/en-us/articles/7146944434445) for an account with paging query. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_alert_settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/alert_settings - Read
Get alert setting details
Returns detailed information about a specific [alert setting](https://support.zoom.us/hc/en-us/articles/7146944434445). **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:alert_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/alert_settings/{alertSettingId} - Write
Add an alert setting
[Adds an alert setting](https://support.zoom.us/hc/en-us/articles/7146944434445). **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:alert_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/alert_settings - Write
Update an alert setting
Updates information of an [Alert setting](https://support.zoom.us/hc/en-us/articles/7146944434445). **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:patch:alert_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/alert_settings/{alertSettingId} - Destructive
Delete an alert setting
Deletes an [alert setting](https://support.zoom.us/hc/en-us/articles/7146944434445). **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:alert_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/alert_settings/{alertSettingId}
Audio Library
- Read
Get an audio item
Returns an audio item. Only the admin or user can access your audio. **Prerequisites:** * Business or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:audio`,`phone:read:audio:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/audios/{audioId} - Read
List audio items
Returns personal audios. Only the admin or user can query your audios and directly pass the `me` value instead of the `userId` parameter. **Prerequisites:** * Business or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_audios`,`phone:read:list_audios:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/users/{userId}/audios - Write
Update an audio item
Updates an audio item. Only the admin or user can update your audio. **Prerequisites:** * Business or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:audio`,`phone:update:audio:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/audios/{audioId} - Write
Add an audio item for text-to-speech conversion
Adds an audio item for [text-to-speech conversion](https://support.zoom.us/hc/en-us/articles/4402414203533-Using-the-audio-library-to-customize-audio#h_01F8B0D2ZJBKEDH10DFZ7J2CM7). Only the admin or user can add your audio and directly pass the `me` value instead of the `userId` parameter. **Prerequisites:** * Business or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:audio`,`phone:write:audio:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/users/{userId}/audios - Write
Add audio items
Adds the audio items. You can only upload voice files at this time. Only the admin or user can add your audio and directly pass the `me` value instead of the `userId` parameter. **Prerequisites:** * Business or Education account * Zoom Phone license **Size and quantity limits for audio attachments:** * Up to 5 attachments * Each file size should be no more than 1MB **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:batch_audios`,`phone:write:batch_audios:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
POST /phone/users/{userId}/audios/batch - Destructive
Delete an audio item
Deletes an audio item. Only the admin or user can delete your audio. **Prerequisites:** * Business, or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:audio`,`phone:delete:audio:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/audios/{audioId}
Auto Receptionists
- Read
List auto receptionists
Returns a list of auto receptionists. **Prerequisites:** * Pro or a higher account with Zoom Phone license. * Account owner or admin permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_auto_receptionists:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
GET /phone/auto_receptionists - Read
Get an auto receptionist
Returns information on a specific auto receptionist. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:auto_receptionist:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/auto_receptionists/{autoReceptionistId} - Read
Get auto receptionist call handling setting
Returns the call handling setting of an auto receptionist for the specified hour type. **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:auto_receptionist_call_handling_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/auto_receptionists/{autoReceptionistId}/call_handling/settings - Read
Get an auto receptionist policy
Returns the policy setting of a specific [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-). **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:auto_receptionist_policy:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/auto_receptionists/{autoReceptionistId}/policies - Read
Get auto receptionist settings
Returns auto receptionist settings. **Prerequisites:** * A Pro or higher account with a Zoom Phone license. * Account owner or admin permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:auto_receptionist_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/auto_receptionists/{autoReceptionistId}/settings - Write
Add an auto receptionist
Adds an [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-) to a Zoom Phone. Auto receptionists answer calls with a personalized recording and routes calls to a phone user, call queue, common area, voicemail or an IVR system. **Prerequisites:** * Pro or higher account with Zoom Phone license. * Account owner or admin privileges **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:auto_receptionist:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
POST /phone/auto_receptionists - Write
Update an auto receptionist
[Changes information](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-#h_1d5ffc56-6ba3-4ce5-9d86-4a1a1ee743f3) such as the display name and the extension number assigned to the main auto receptionist. An auto receptionist answers calls with a personalized recording. And it routes calls to a phone user, call queue, common area, or voicemail. An auto receptionist can also be set up so that it routes calls to an interactive voice response (IVR) system to allow callers to select the routing options. **Prerequisites:** * Pro or higher account with Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:auto_receptionist:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/auto_receptionists/{autoReceptionistId} - Write
Update auto receptionist call handling setting
Update the call handling setting of an auto receptionist for the specified hour type. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:auto_receptionist_call_handling_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/auto_receptionists/{autoReceptionistId}/call_handling/settings/{hourType} - Write
Assign phone numbers
Assigns available phone numbers to an [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-). The available numbers can be retrieved using the List Phone Numbers API with `type` query parameter set to "unassigned". **Prerequisites:** * Pro or higher account plan with Zoom Phone License * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:auto_receptionist_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
POST /phone/auto_receptionists/{autoReceptionistId}/phone_numbers - Write
Add a policy subsetting
Adds a policy subsetting for a specific [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-) according to the `policyType`. For example, you can use this API to set up shared access members.<br><br>**Prerequisites:** * Pro or higher account plan with Zoom Phone License * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:auto_receptionist_policy:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/auto_receptionists/{autoReceptionistId}/policies/{policyType} - Write
Update a policy subsetting
Updates the policy subsetting of a specific [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-) according to the `policyType`. For example, you can use this API to update shared access members. **Prerequisites** * Pro or higher account plan with Zoom Phone License * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:auto_receptionist_policy:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/auto_receptionists/{autoReceptionistId}/policies/{policyType} - Write
Add auto receptionist setting
Adds the auto receptionist setting according to the setting type. **Prerequisites** * A Pro or higher account with a Zoom Phone license. * Account owner or admin permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:auto_receptionist_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/auto_receptionists/{autoReceptionistId}/settings/{settingType} - Write
Update auto receptionist setting
Updates the auto receptionist setting according to the setting type. **Prerequisites** * Pro or a higher account with Zoom Phone license. * Account owner or admin permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:auto_receptionist_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/auto_receptionists/{autoReceptionistId}/settings/{settingType} - Destructive
Delete a non-primary auto receptionist
[Deletes a non-primary auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-#h_1d5ffc56-6ba3-4ce5-9d86-4a1a1ee743f3). An auto receptionist answers calls with a personalized recording and routes calls to a phone user, call queue, common area (phone), or to a voicemail. An auto receptionist can also be set up so that it routes calls to an interactive voice response (IVR) system to allow callers to select the routing options. **Prerequisites:** * Pro or higher account with Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:auto_receptionist:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/auto_receptionists/{autoReceptionistId} - Destructive
Unassign all phone numbers
Unassigns all phone numbers that were previously assigned to an [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-). **Prerequisites:** * Pro or higher account plan with Zoom Phone License * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:auto_receptionist_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/auto_receptionists/{autoReceptionistId}/phone_numbers - Destructive
Unassign a phone number
Unassigns a specific phone number that was previously assigned to an [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-). **Prerequisites:** * Pro or higher account plan with Zoom Phone License * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:auto_receptionist_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/auto_receptionists/{autoReceptionistId}/phone_numbers/{phoneNumberId} - Destructive
Update an auto receptionist policy
Updates the policy setting of a specific [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-). **Prerequisites:** * Pro or higher account plan with Zoom Phone License * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:auto_receptionist_policy:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/auto_receptionists/{autoReceptionistId}/policies - Destructive
Delete a policy subsetting
Removes the policy subsetting for a specific [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-) according to the `policyType`. For example, you can use this API to remove shared access members. **Prerequisites:** * Pro or higher account plan with Zoom Phone License * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:auto_receptionist_policy:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/auto_receptionists/{autoReceptionistId}/policies/{policyType} - Destructive
Delete auto receptionist setting
Delete the auto receptionist setting according to the setting type. **Prerequisites** * A Pro or higher account with a Zoom Phone license. * Account owner or admin permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:auto_receptionist_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/auto_receptionists/{autoReceptionistId}/settings/{settingType}
Billing Account
- Read
List billing accounts
Retrieves a list of available billing accounts for a Zoom account owner or a user with admin privileges. If the [multiple sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites) option has been enabled for the account, then `field(site_id)` is required. **Prerequisites:** * Pro or higher account plan with Zoom phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_billing_accounts:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/billing_accounts - Read
Get billing account details
A Zoom account owner or a user with admin privilege can use this API to get information about a billing account. **Prerequisites:** * Pro or higher account plan with Zoom phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:billing_account:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
GET /phone/billing_accounts/{billingAccountId}
Blocked List
- Read
List blocked lists
Returns all the blocked lists in an acccount. A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers). Blocked callers will hear a generic message stating that the person they are calling is not available. **Prerequisites:** * Pro or higher account plan with Zoom phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_blocked_lists:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/blocked_list - Read
Get blocked list details
Returns the information about a specific blocked list. A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers). Blocked callers will hear a generic message stating that the person they are calling is not available. **Prerequisites:** * Pro or higher account plan with Zoom phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:blocked_list:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/blocked_list/{blockedListId} - Write
Create a blocked list
Creates a block list and add a number to the list. A Zoom account owner or a user with the admin privilege can block phone numbers for phone users in an account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers). Blocked callers will hear a generic message stating that the person they are calling is not available. **Prerequisites:** * Pro or higher account plan with Zoom phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:blocked_list:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/blocked_list - Write
Update a blocked list
Updates the information in the blocked list. A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers). Blocked callers hear a generic message stating that the person they are calling is not available. **Prerequisites:** * Pro or higher account plan with Zoom phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:blocked_list:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/blocked_list/{blockedListId} - Destructive
Delete a blocked list
Deletes a blocked list, which removes the associated number from the blocked list. The number will be unblocked after the deletion. A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers). **Prerequisites:** * Pro or higher account plan with Zoom phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:blocked_list:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/blocked_list/{blockedListId}
Call Handling
- Read
Get call handling settings (deprecated)
Returns information about a Zoom Phone call handling settings. Call handling settings let you control how your system routes calls during business, closed, or holiday hours. For more information, read our [API guide](https://developers.zoom.us/docs/zoom-phone/call-handling/) or Zoom support article [Customizing call handling settings](https://support.zoom.us/hc/en-us/articles/360059966372-Customizing-call-handling-settings). **Applicable to user, call queue, auto receptionist, or shared line group call handling at this time.** **Prerequisites:** * Pro or a higher account with Zoom Phone enabled **Deprecation notice:** This API is planned for deprecation. Use the resource-specific APIs instead: * For user call handling settings, use `GET /phone/users/{userId}/call_handling/settings`. * For common area call handling settings, use `GET /phone/common_areas/{commonAreaId}/call_handling/settings`. * For auto receptionist call handling settings, use `GET /phone/auto_receptionists/{autoReceptionistId}/call_handling/settings`. * For call queue call handling settings, use `GET /phone/call_queues/{callQueueId}/call_handling/settings`. * For shared line group call handling settings, use `GET /phone/shared_line_groups/{sharedLineGroupId}/call_handling/settings`. * For user profile, holiday hour, custom hour, or other user setting data, use `GET /phone/users/{userId}/settings`. * For common area holiday hour, custom hour, or other setting data, use `GET /phone/common_areas/{commonAreaId}/settings`. * For auto receptionist holiday hour, custom hour, or other setting data, use `GET /phone/auto_receptionists/{autoReceptionistId}/settings`. * For call queue holiday hour, custom hour, or other setting data, use `GET /phone/call_queues/{callQueueId}/settings`. * For shared line group holiday hour, custom hour, or other setting data, use `GET /phone/shared_line_groups/{sharedLineGroupId}/settings`. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_handling_settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/extension/{extensionId}/call_handling/settings - Write
Add a call handling setting (deprecated)
Adds Zoom Phone call handling subsettings for your phone system. Call handling settings allow you to control how your system routes calls during business, closed, or holiday hours. For more information, see our [API guide](https://developers.zoom.us/docs/api/phone/) or Zoom support article [Customizing call handling settings](https://support.zoom.us/hc/en-us/articles/360059966372-Customizing-call-handling-settings). **Applicable to user, call queue, auto receptionist, or shared line group call handling at this time.** **Prerequisites:** * A Pro or higher account with Zoom Phone enabled **Deprecation notice:** This API is planned for deprecation. Use the resource-specific APIs instead: * To add user call forwarding settings, use `POST /phone/users/{userId}/call_forward_settings/{hourType}`. * To add holiday hour settings for users, use `POST /phone/users/{userId}/profile_settings/{settingType}`. * To add holiday hour or break hour settings for common areas, use `POST /phone/common_areas/{commonAreaId}/settings/{settingType}`. * To add holiday hour or break hour settings for auto receptionists, use `POST /phone/auto_receptionists/{autoReceptionistId}/settings/{settingType}`. * To add holiday hour or break hour settings for call queues, use `POST /phone/call_queues/{callQueueId}/settings/{settingType}`. * To add holiday hour or break hour settings for shared line groups, use `POST /phone/shared_line_groups/{sharedLineGroupId}/settings/{settingType}`. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:call_handling_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/extension/{extensionId}/call_handling/settings/{settingType} - Write
Update a call handling setting (deprecated)
Updates a Zoom Phone call handling setting. Call handling settings allow you to control how your system routes calls during business, closed, or holiday hours. For more information, read our [Call Handling API guide](https://developers.zoom.us/docs/zoom-phone/call-handling/) or Zoom support article [Customizing call handling settings](https://support.zoom.us/hc/en-us/articles/360059966372-Customizing-call-handling-settings). **Applicable to user, call queue, auto receptionist, or shared line group call handling at this time.** **Prerequisites:** * Pro or a higher account with Zoom Phone enabled **Deprecation notice:** This API is planned for deprecation. Use the resource-specific APIs instead: * For user call handling settings, including user call forwarding settings, use `PATCH /phone/users/{userId}/call_handling/settings/{hourType}`. * For common area call handling settings, use `PATCH /phone/common_areas/{commonAreaId}/call_handling/settings/{hourType}`. * For auto receptionist call handling settings, use `PATCH /phone/auto_receptionists/{autoReceptionistId}/call_handling/settings/{hourType}`. * For call queue call handling settings, use `PATCH /phone/call_queues/{callQueueId}/call_handling/settings/{hourType}`. * For shared line group call handling settings, use `PATCH /phone/shared_line_groups/{sharedLineGroupId}/call_handling/settings/{hourType}`. * For user profile, holiday hour, custom hour, or other settings, use `PATCH /phone/users/{userId}/settings`. * For common area holiday hour, custom hour, or other settings, use `PATCH /phone/common_areas/{commonAreaId}/settings/{settingType}`. * For auto receptionist holiday hour, custom hour, or other settings, use `PATCH /phone/auto_receptionists/{autoReceptionistId}/settings/{settingType}`. * For call queue holiday hour, custom hour, or other settings, use `PATCH /phone/call_queues/{callQueueId}/settings/{settingType}`. * For shared line group holiday hour, custom hour, or other settings, use `PATCH /phone/shared_line_groups/{sharedLineGroupId}/settings/{settingType}`. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_handling_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/extension/{extensionId}/call_handling/settings/{settingType} - Destructive
Delete a call handling setting
Deletes a Zoom Phone call handling settings. Call handling settings let you control how your system routes calls during business, closed, or holiday hours. For more information, read our [API guide](https://marketplace.zoom.us/docs/guides/zoom-phone/call-handling/) or Zoom support article [Customizing call handling settings](https://support.zoom.us/hc/en-us/articles/360059966372-Customizing-call-handling-settings). **Applicable to user, call queue, auto receptionist, or shared line group call handling at this time.** **Prerequisites:** * Pro or a higher account with Zoom Phone enabled **Deprecation notice:** This API is planned for deprecation. Use the resource-specific APIs instead: * To delete user call forwarding settings, use `DELETE /phone/users/{userId}/call_forward_settings/{hourType}`. * To delete holiday hour settings for users, use `DELETE /phone/users/{userId}/profile_settings/{settingType}`. * To delete holiday hour or break hour settings for common areas, use `DELETE /phone/common_areas/{commonAreaId}/settings/{settingType}`. * To delete holiday hour or break hour settings for auto receptionists, use `DELETE /phone/auto_receptionists/{autoReceptionistId}/settings/{settingType}`. * To delete holiday hour or break hour settings for call queues, use `DELETE /phone/call_queues/{callQueueId}/settings/{settingType}`. * To delete holiday hour or break hour settings for shared line groups, use `DELETE /phone/shared_line_groups/{sharedLineGroupId}/settings/{settingType}`. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_handling_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/extension/{extensionId}/call_handling/settings/{settingType}
Call Logs
- Read
Get call element
Returns the call element for a given call element ID. **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone_call_log:read`,`phone_call_log:read:admin`,`phone:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_log:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/call_element/{callElementId} - Read
Get account's call history
Returns an account's new edition of [call logs](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-Call-Logs). **Prerequisites** * A Business or Enterprise account * A Zoom Phone license * Account owner or a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) with Zoom Phone management **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_call_log:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_logs:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /phone/call_history - Read
Get call history
Returns information about a [call log](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs). **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_call_log:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_log:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/call_history/{callHistoryUuid} - Read
Get call history detail (deprecated)
Returns the call history details for a given call log ID [call history](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs). **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone_call_log:read`,`phone_call_log:read:admin`,`phone:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_log:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/call_history_detail/{callHistoryId} - Read
Get account's call logs (deprecated)
Returns an account's [call logs](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-Call-Logs). **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license * Account owner or a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) with Zoom Phone management **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_call_log:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_logs:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /phone/call_logs - Read
Get call log details (deprecated)
Returns information about a [call log](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs). **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_call_log:read:admin`,`phone:read`,`phone_call_log:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_log:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/call_logs/{callLogId} - Read
Get User AI Call Summary Detail
Returns AI call summary details. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:ai_call_summary`,`phone:read:ai_call_summary:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/user/{userId}/ai_call_summary/{aiCallSummaryId} - Read
Get user's call history
Returns a user's [Zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) call history. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_call_log:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_logs:admin`,`phone:read:list_call_logs` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/users/{userId}/call_history - Read
Sync user's call history
Syncs a user's [Zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) call history. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_logs`,`phone:read:list_call_logs:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/users/{userId}/call_history/sync - Read
Get user's call logs (deprecated)
Returns a user's [Zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) call logs. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin`,`phone_call_log:read`,`phone_call_log:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_logs`,`phone:read:list_call_logs:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/users/{userId}/call_logs - Read
Sync user's call logs (deprecated)
Syncs a user's [Zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) call logs. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_logs`,`phone:read:list_call_logs:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/users/{userId}/call_logs/sync - Write
Add a client code to a call history
Adds a client code to a [call log](https://support.zoom.us/hc/en-us/articles/360040999352-Assigning-client-codes-to-phone-calls). You can track call logs with a client code. **Prerequisites** * Business or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_log:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/call_history/{callElementId}/client_code - Destructive
Add a client code to a call log (deprecated)
Adds a client code to a [call log](https://support.zoom.us/hc/en-us/articles/360040999352-Assigning-client-codes-to-phone-calls). You can track call logs with a client code. **Prerequisites:** * Business or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_log:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /phone/call_logs/{callLogId}/client_code - Destructive
Delete a user's call history
Deletes a user's [call history](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs). For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. **Prerequisites** * Belong to a Business or Enterprise account * Have a Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin`,`phone_call_log:write`,`phone_call_log:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_log`,`phone:delete:call_log:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/users/{userId}/call_history/{callElementId} - Destructive
Delete a user's call log (deprecated)
Deletes a user's [call log](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs). For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. **Prerequisites:** * User must belong to a Business or Enterprise account * User must have a Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin`,`phone_call_log:write`,`phone_call_log:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_log`,`phone:delete:call_log:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/users/{userId}/call_logs/{callLogId}
Call Queues
- Read
List call queue analytics
Returns the call queue analytics overview. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_queues:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/call_queue_analytics - Read
List call queues
Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc. Use this API to list Call queues. **Prerequisites:** * Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_queues:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/call_queues - Read
Get call queue details
Routes incoming calls to a group of users and returns information on a specific call queue. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service, and so on. **Prerequisites:** * Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/call_queues/{callQueueId} - Read
Get call queue call handling setting
Returns the call handling setting of a call queue for the specified hour type. **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_queue_call_handling_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/call_queues/{callQueueId}/call_handling/settings - Read
List custom groups of a call queue
Returns a list of custom groups for a call queue. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_queue_custom_group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/call_queues/{callQueueId}/custom_groups - Read
Get call queue custom group detail
**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:master` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_queue_custom_group:admin`,`phone:read:call_queue_custom_group:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/call_queues/{callQueueId}/custom_groups/{customGroupId} - Read
List call queue members
Returns a list of call queue members. **Prerequisites:** * Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_queue_members:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/call_queues/{callQueueId}/members - Read
Get call queue policy
Returns the policy setting of a specific [call queue]. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_queue_policy:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/call_queues/{callQueueId}/policies - Read
Get call queue recordings
Use this API to view [call recordings](https://support.zoom.us/hc/en-us/articles/360038521091#h_cbc9f2a3-e06c-4daa-83d4-ddbceef9c77b) from the call queue. **Prerequisites:** * Pro or higher account with Zoom Phone license. * [Automatic call recordings](https://support.zoom.us/hc/en-us/articles/360033511872#h_fcb297bb-14e8-4094-91ca-dc61e1a18734) must be enabled in the Policy Settings for call queues. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_queue_recordings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
GET /phone/call_queues/{callQueueId}/recordings - Read
Get call queue settings
Returns call queue settings. **Prerequisites:** * Pro or higher account with Zoom Phone license. * Account owner or admin permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_queue_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/call_queues/{callQueueId}/settings - Write
Create a call queue
[Creates a call queue](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues#h_e81faeeb-9184-429a-aaea-df49ff5ff413). Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service, and so on. You can add phone users or common areas to call queues. **Prerequisites:** * Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:call_queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/call_queues - Write
Update call queue details
Updates information of a specific call queue. Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service, and so on. **Prerequisites:** * Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/call_queues/{callQueueId} - Write
Create a custom group in a call queue
**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:call_queue_custom_group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/call_queues/{callQueueId}/custom_groups - Write
Update a custom group
Update a custom group. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_queue_custom_group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/call_queues/{callQueueId}/custom_groups/{customGroupId} - Write
Add members to a custom group
Adds call queue members to a custom group. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:call_queue_custom_group_member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/call_queues/{callQueueId}/custom_groups/{customGroupId}/members - Write
Add members to a call queue
Adds phone users or [common areas](https://support.zoom.us/hc/articles/4481136653709) as members to a specific call queue. **Prerequisites:** * Pro or higher account plan. * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:call_queue_member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/call_queues/{callQueueId}/members - Write
Assign numbers to a call queue
Assigns numbers to a call queue. After [buying phone number(s)](https://support.zoom.us/hc/en-us/articles/360020808292#h_007ec8c2-0914-4265-8351-96ab23efa3ad), you can assign it and allow callers to directly dial a number to reach a [call queue](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues). **Prerequisites:** - Pro or higher account plan * Account owner or admin permissions - Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:call_queue_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/call_queues/{callQueueId}/phone_numbers - Write
Add a policy subsetting to a call queue
Adds the policy subsetting for a specific [call queue](https://support.zoom.us/hc/en-us/articles/360021524831) according to the `policyType`. For example, you can use set up shared access members. **Prerequisites** * Pro or higher account with Zoom Phone license. * Account owner or admin privileges **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:call_queue_policy:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/call_queues/{callQueueId}/policies/{policyType} - Write
Update a call queue's policy subsetting
Updates the policy subsetting for a specific [call queue](https://support.zoom.us/hc/en-us/articles/360021524831) according to the `policyType`. For example, you can use this API to update shared access members. **Prerequisites:** * Pro or higher account with Zoom Phone license. * Account owner or admin privileges **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_queue_policy:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/call_queues/{callQueueId}/policies/{policyType} - Write
Add call queue setting
Adds a call queue setting according to the setting type. **Prerequisites** * A Pro or higher account with a Zoom Phone license. * Account owner or admin permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:call_queue_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/call_queues/{callQueueId}/settings/{settingType} - Write
Update call queue setting
Update the call queue setting according to the setting type. **Prerequisites** * A Pro or higher account with a Zoom Phone license. * Account owner or admin permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_queue_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/call_queues/{callQueueId}/settings/{settingType} - Destructive
Delete a call queue
Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc. Use this API to delete a Call Queue. **Prerequisites:** * Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_queue:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/call_queues/{callQueueId} - Destructive
Update call queue call handling setting
Updates the call handling setting of a call queue for the specified hour type. Only the fields included in the request body are updated; omitted fields are left unchanged. Display-only fields (extension number/name, audio name, external contact name/email, Zoom Contact Center / Microsoft Teams display names) are derived on the server side and must not be sent in the request body. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_queue_call_handling_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/call_queues/{callQueueId}/call_handling/settings/{hourType} - Destructive
Delete a custom group
Delete a custom group. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_queue_custom_group:admin`,`phone:delete:call_queue_custom_group:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/call_queues/{callQueueId}/custom_groups/{customGroupId} - Destructive
Remove a member from a custom group
**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_queue_custom_group_member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/call_queues/{callQueueId}/custom_groups/{customGroupId}/members/{extensionId} - Destructive
Unassign all members
Removes all members from a call queue who were previously assigned to that call queue. The members could be phone users or [common areas](https://support.zoom.us/hc/articles/4481136653709). **Prerequisites:** * Pro or higher account plan. * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_queue_member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/call_queues/{callQueueId}/members - Destructive
Unassign a member
Removes a member who was previously added to a call queue. The member could be a phone user or common area. Note that you cannot use this API to unassign a call queue manager. **Prerequisites:** * Pro or higher account plan. * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_queue_member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/call_queues/{callQueueId}/members/{memberId} - Destructive
Unassign all phone numbers
Unbinds all phone numbers that are assigned to a [call queue](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues). After successful unbinding, the numbers will appear in the [Unassigned tab](https://zoom.us/signin#/numbers/unassigned). If you only need to unassign a specific phone number, use the Unassign a Phone Number API instead. **Prerequisites:** * Pro or higher account palan * Account owner or admin permissions * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_queue_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/call_queues/{callQueueId}/phone_numbers - Destructive
Unassign a phone number
Unbinds a phone number from a call queue. After assigning a phone number, you can unbind it if you don't want it to be assigned to a [call queue](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues). After successful unbinding, the number will appear in the [Unassigned tab](https://zoom.us/signin#/numbers/unassigned). **Prerequisites:** * Pro or higher account palan * Account owner or admin permissions * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_queue_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/call_queues/{callQueueId}/phone_numbers/{phoneNumberId} - Destructive
Update call queue policy
Updates a call queue's policy settings. **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_queue_policy:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/call_queues/{callQueueId}/policies - Destructive
Delete a CQ policy setting
Use this API to remove the policy sub-setting for a specific [call queue](https://support.zoom.us/hc/en-us/articles/360021524831) according to the `policyType`. For example, you can use this API to remove shared access members. **Prerequisites:** * Pro or higher account with Zoom Phone license. * Account owner or admin privileges **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_queue_policy:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/call_queues/{callQueueId}/policies/{policyType} - Destructive
Delete call queue setting
Delete the call queue setting by the setting type. **Prerequisites** * A Pro or higher account with a Zoom Phone license. * Account owner or admin permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_queue_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/call_queues/{callQueueId}/settings/{settingType}
Carrier Reseller
- Read
List phone numbers (deprecated)
Lists phone numbers in a carrier reseller (master) account that can be pushed to its subaccounts.**Prerequisites:** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_carrier_numbers:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/carrier_reseller/numbers - Write
Create phone numbers (deprecated)
Adds phone numbers to a carrier reseller (master) account. Up to 200 numbers at a time. If this API is called in MA mode, it also has functions of distribution. **Prerequisites:** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:carrier_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/carrier_reseller/numbers - Write
Activate phone numbers (deprecated)
Changes the phone number status to `active` in a carrier reseller's master account. It can change up to 200 numbers at a time. **Prerequisites:** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:carrier_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/carrier_reseller/numbers - Destructive
Delete a phone number (deprecated)
Deletes or unassigns a phone number from a carrier reseller account. **Prerequisites:** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:carrier_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/carrier_reseller/numbers/{number}
Common Areas
- Read
List common areas
Lists common areas under an account. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:common_area:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/common_areas - Read
List activation codes
Returns a list of activation code information of the common areas under an account. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_common_area_activation_codes:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
GET /phone/common_areas/activation_codes - Read
Get common area details
Returns detailed information on the common area. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:common_area:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/common_areas/{commonAreaId} - Read
Get common area call handling setting
Returns the call handling setting of a common area for the specified hour type. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:common_area_call_handling_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/common_areas/{commonAreaId}/call_handling/settings - Read
Get common area settings
Returns common area settings. **Prerequisites:** * Pro or a higher account with Zoom Phone license. * Account owner or admin permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_common_area_settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/common_areas/{commonAreaId}/settings - Write
Add a common area
Adds an instance of a common area. You can configure devices shared by users and deployed in shared spaces. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:common_area:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/common_areas - Write
Generate activation codes for common areas
Generates activation codes for common areas. You can add up to 50 common areas at a time. **Prerequisites** - Pro or a higher account with Zoom Phone license - Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:common_area:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
POST /phone/common_areas/activation_code - Write
Apply template to common areas
Applies a template to common areas. You can add up to 50 common areas at a time. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:apply_template_to_common_areas:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/common_areas/template_id/{templateId} - Write
Update common area
Updates the common area information. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:common_area:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/common_areas/{commonAreaId} - Write
Update common area call handling setting
Update the call handling setting of a common area for the specified hour type. **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:common_area_call_handling_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/common_areas/{commonAreaId}/call_handling/settings/{hourType} - Write
Assign calling plans to a common area
Assigns calling plans to a common area. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:common_area_calling_plan:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/common_areas/{commonAreaId}/calling_plans - Write
Assign phone numbers to a common area
Assigns phone numbers to a common area. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:common_area_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/common_areas/{commonAreaId}/phone_numbers - Write
Update common area pin code
Updates the common area pin code. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions, This depends on whether [The PIN cannot be viewed by the admin](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0069783) is enabled. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:common_area:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/common_areas/{commonAreaId}/pin_code - Write
Add common area setting
Adds the common area setting according to the setting type. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:common_area_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/common_areas/{commonAreaId}/settings/{settingType} - Write
Update common area setting
Updates the common area setting according to the setting type. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:common_area_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/common_areas/{commonAreaId}/settings/{settingType} - Destructive
Delete a common area
Removes the common area. **Prerequisites:** * Pro or a higher account with Zoom Phone license. * Account owner or admin permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:common_area:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/common_areas/{commonAreaId} - Destructive
Unassign a calling plan from the common area
Use this API to unassign a calling plan from the common area. **Prerequisites:** * A Pro or higher account with a Zoom Phone license * An account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:common_area_calling_plan:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/common_areas/{commonAreaId}/calling_plans/{type} - Destructive
Unassign phone numbers from common area
Unassigns a phone number from a common area. **Prerequisites** * A Pro or a higher account with a Zoom Phone license * An account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:common_area_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/common_areas/{commonAreaId}/phone_numbers/{phoneNumberId} - Destructive
Delete common area setting
Removes the common area subsetting from desk phones. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:common_area_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/common_areas/{commonAreaId}/settings/{settingType}
Dashboard
- Read
List call logs
Returns monthly call logs metrics. The call logs that provide a record of all incoming and outgoing calls over Zoom Phone in an account. You can use query parameters to filter the response by date, site and MOS(Mean Opinion Score) of the call. **Prerequisites:** * Business or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_logs:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /phone/metrics/call_logs - Read
Get call QoS
Gets the call quality of service (QoS) data for a call made or received by a Zoom phone user in the account. **Prerequisites:** * Business, or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_qos:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
GET /phone/metrics/call_logs/{callId}/qos - Read
Get call details from call log
Returns call log details of a specific call. The call logs provide a record of all incoming and outgoing calls over Zoom Phone in an account. **Prerequisites:** * Business, or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_log:admin`
GET /phone/metrics/call_logs/{call_id} - Read
List default emergency address users
Returns the users who provide a default personal emergency address rather than a default site address or default account address. **Prerequisites:** * Pro or higher account plan with Zoom phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:default_emergency_address:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/metrics/emergency_services/default_emergency_address/users - Read
List detectable personal location users
Returns the users who created one or more detectable personal locations with associated network data. (Exclude users didn't enable Location Permission on client.) **Prerequisites:** * Pro or higher account plan with Zoom phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:detectable_personal_location:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/metrics/emergency_services/detectable_personal_location/users - Read
List users permission for location sharing
Returns users that have enabled location services and allowed location sharing with Zoom applications on client devices. (Excludes users who are unable to use Nomadic Emergency Services, or users on client versions lower than 5.4.0.) **Prerequisites:** * Pro or higher account plan with Zoom phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:location_sharing_permission:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/metrics/emergency_services/location_sharing_permission/users - Read
List nomadic emergency services users
Returns users who have been enabled for nomadic emergency services. **Prerequisites:** * Pro or higher account plan with Zoom phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:nomadic_emergency_services:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/metrics/emergency_services/nomadic_emergency_services/users - Read
List real time location for IP phones
Returns currently detected location of IP phones. **Prerequisites:** * Pro or higher account plan with Zoom phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:realtime_location_devices:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/metrics/emergency_services/realtime_location/devices - Read
List real time location for users
Returns the user's currently detected location. (Excludes users who didn't enable location permission on the client.) **Prerequisites:** * Pro or higher account plan with Zoom phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:realtime_location_users:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/metrics/emergency_services/realtime_location/users - Read
List tracked locations
Lists the tracked locations. **Prerequisites:** * Pro or higher account plan with Zoom phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_tracked_locations:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
GET /phone/metrics/location_tracking - Read
List past call metrics
Returns all the call logs metrics of the account from the selected time period. The call logs provide a record of all incoming and outgoing calls over Zoom Phone in an account. You can use query parameters to filter the response by metrics of the call (such as date, phone number, extension number and quality type). **Prerequisites:** * Business, or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_logs:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
GET /phone/metrics/past_calls
Device Line Keys
- Read
Get device line keys information
Use this API to get information on the Zoom Phone device [line keys](https://support.zoom.us/hc/en-us/articles/4402415568397-Customizing-keys-for-devices-with-multiple-users) settings and position. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:device_line_keys`,`phone:read:device_line_keys:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
GET /phone/devices/{deviceId}/line_keys - Write
Batch update device line key position
Use this API to batch update the Zoom Phone device [line key position](https://support.zoom.us/hc/en-us/articles/4402415568397-Customizing-keys-for-devices-with-multiple-users) information. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:device_line_keys`,`phone:update:device_line_keys:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
PATCH /phone/devices/{deviceId}/line_keys
Dial by Name Directory
- Read
List users in directory
Use this API to get users that are in or not in a [directory](https://support.zoom.us/hc/en-us/articles/4404938949389-Using-a-dial-by-name-directory). **Prerequisites:** * Business or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:directory:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
GET /phone/dial_by_name_directory/extensions - Read
List users in a directory by site
Use this API to get users that are in or not in a [directory](https://support.zoom.us/hc/en-us/articles/4404938949389-Using-a-dial-by-name-directory) of the specified site. **Prerequisites:** * Business or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:directory:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
GET /phone/sites/{siteId}/dial_by_name_directory/extensions - Write
Add users to a directory
Use this API to add users to a [directory](https://support.zoom.us/hc/en-us/articles/4404938949389-Using-a-dial-by-name-directory). **Prerequisites:** * Business or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:directory:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
POST /phone/dial_by_name_directory/extensions - Write
Add users to a directory of a site
Use this API to add users to a [directory](https://support.zoom.us/hc/en-us/articles/4404938949389-Using-a-dial-by-name-directory) of the specified site. **Prerequisites:** * Business or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:directory:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
POST /phone/sites/{siteId}/dial_by_name_directory/extensions - Destructive
Delete users from a directory
Use this API to delete users from the [directory](https://support.zoom.us/hc/en-us/articles/4404938949389-Using-a-dial-by-name-directory). **Prerequisites:** * Business or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:directory:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/dial_by_name_directory/extensions - Destructive
Delete users from a directory of a site
Use this API to delete users from a [directory](https://support.zoom.us/hc/en-us/articles/4404938949389-Using-a-dial-by-name-directory) of the specified site. **Prerequisites:** * Business or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:directory:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/sites/{siteId}/dial_by_name_directory/extensions
Emergency Addresses
- Read
List emergency addresses
Lists the emergency addresses. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_emergency_addresses:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/emergency_addresses - Read
Get emergency address details
Gets the emergency address information. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:emergency_address:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/emergency_addresses/{emergencyAddressId} - Write
Add an emergency address
Adds an emergency address. If the address provided is not an exact match, the system generated corrected address will be used. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:emergency_address:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/emergency_addresses - Destructive
Delete an emergency address
Removes an emergency address. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:emergency_address:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
DELETE /phone/emergency_addresses/{emergencyAddressId} - Destructive
Update an emergency address
Updates emergency address information. If the provided address does not exactly match, the system uses the corrected address it generates. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:emergency_address:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/emergency_addresses/{emergencyAddressId}
Emergency Service Locations
- Read
List emergency service locations
Returns emergency service locations. **Note**: When you enable [multiple sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites), the `site_id` parameter is required. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_emergency_locations:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/locations - Read
Get emergency service location details
Returns an emergency service location's information. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:emergency_location:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/locations/{locationId} - Write
Batch add emergency service locations
Adds emergency service locations in batch. **Prerequisites:** * Pro or higher account plan with Zoom phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:batch_emergency_locations:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/batch_locations - Write
Add an emergency service location
Adds an emergency service location. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:emergency_location:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/locations - Write
Update emergency service location
Updates an emergency location's information. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:emergency_location:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/locations/{locationId} - Destructive
Delete an emergency location
Removes an emergency location. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:emergency_location:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/locations/{locationId}
Emergency Service Routing
- Read
List an account's emergency routing rules
Lists all of an account's emergency routing rules (both Zoom default and customized) in a single response. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions * This is an account-level API. It can only be used when Multiple Sites is disabled for the account. Use the corresponding site-level emergency routing rule list API instead when Multiple Sites is enabled. **Note:** The response does not include a routing rule ID. Use the returned `number_pattern` value as the `routingRuleIdentifier` when calling the update or delete emergency routing rule APIs. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_emergency_services_routing_rules:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/emergency_services/routing_rules - Read
List a site's emergency routing rules
Lists all of a site's emergency routing rules (both Zoom default and customized) in a single response. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions * This is a site-level API. It can only be used when Multiple Sites is enabled for the account; if Multiple Sites is disabled, this API returns a 400 error ("Multiple Sites option has been disabled. Try again after enabling it."). Use the corresponding account-level emergency routing rule list API instead when Multiple Sites is disabled. **Note:** The response does not include a routing rule ID. Use the returned `number_pattern` value as the `routingRuleIdentifier` when calling the update or delete emergency routing rule APIs. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_site_emergency_service_routing_rules:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/sites/{siteId}/emergency_services/routing_rules - Write
Add an account's emergency routing rule
Adds an emergency routing rule for an account. You can define additional emergency service numbers, special service numbers, and call handling settings associated with the account. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions * This is an account-level API. It can only be used when Multiple Sites is disabled for the account. Use the corresponding site-level emergency routing rule API instead when Multiple Sites is enabled. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:emergency_services_routing_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/emergency_services/routing_rules - Write
Update an account's emergency routing rule
Updates an account's emergency routing rule. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions * This is an account-level API. It can only be used when Multiple Sites is disabled for the account. Use the corresponding site-level emergency routing rule API instead when Multiple Sites is enabled. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:emergency_services_routing_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /phone/emergency_services/routing_rules/{routingRuleIdentifier} - Write
Add a site's emergency routing rule
Add a site's emergency routing rule. You can define additional emergency service numbers, special service numbers, and call handling settings associated with it. **Prerequisites:** * A Pro or higher account with a Zoom Phone license. * Account owner or admin permissions. * This is a site-level API. It can only be used when Multiple Sites is enabled for the account; if Multiple Sites is disabled, this API returns a 400 error ("Multiple Sites option has been disabled. Try again after enabling it."). Use the corresponding account-level emergency routing rule API instead when Multiple Sites is disabled. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:site_emergency_service_routing_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/sites/{siteId}/emergency_services/routing_rules - Write
Update a site emergency routing rule
Updates a site's emergency routing rule. **Prerequisites** * Pro or higher account with Zoom Phone license. * Account owner or admin permissions. * This is a site-level API. It can only be used when Multiple Sites is enabled for the account; if Multiple Sites is disabled, this API returns a 400 error ("Multiple Sites option has been disabled. Try again after enabling it."). Use the corresponding account-level emergency routing rule API instead when Multiple Sites is disabled. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:site_emergency_service_routing_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/sites/{siteId}/emergency_services/routing_rules/{routingRuleIdentifier} - Destructive
Delete an account's emergency routing rule
Removes an account's emergency routing rule. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions * This is an account-level API. It can only be used when Multiple Sites is disabled for the account. Use the corresponding site-level emergency routing rule API instead when Multiple Sites is enabled. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:emergency_services_routing_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/emergency_services/routing_rules/{routingRuleIdentifier} - Destructive
Delete a site's emergency routing rule
Removes a site's emergency routing rule. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions * This is a site-level API. It can only be used when Multiple Sites is enabled for the account; if Multiple Sites is disabled, this API returns a 400 error ("Multiple Sites option has been disabled. Try again after enabling it."). Use the corresponding account-level emergency routing rule API instead when Multiple Sites is disabled. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:site_emergency_service_routing_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/sites/{siteId}/emergency_services/routing_rules/{routingRuleIdentifier}
Emergency Services
- Read
Get emergency service settings
Returns the complete emergency service configuration in a single response: "**Route Emergency Calls to Public Safety Answering Point (PSAP)**", "**Route Emergency Calls to Internal Safety Response Team**", "**Nomadic Emergency Services**", and "**Emergency Address Management**", each with its sub-settings. This single endpoint serves both account-level and site-level configuration: * When **Multiple Sites** is enabled for the account, `site_id` is required and the specified site's configuration is returned. * When **Multiple Sites** is disabled, `site_id` must be omitted and the account-level configuration is returned. **Prerequisites:** * Pro or a higher account with Zoom Phone license. * Account owner or admin permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:emergency_service_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/emergency_service_settings - Destructive
Update emergency service settings
Updates one emergency service setting group per call. Exactly one of `psap`, `internal_safety_response_team`, `nomadic_emergency_service` or `emergency_address_management` must be present in the request body; supplying none or more than one returns a validation error. Within the supplied group, omitted fields keep their current values. This single endpoint serves both account-level and site-level configuration: * When **Multiple Sites** is enabled for the account, `site_id` is required in the request body and the specified site's configuration is updated. * When **Multiple Sites** is disabled, `site_id` must be omitted and the account-level configuration is updated. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:emergency_service_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
PATCH /phone/emergency_service_settings
External Contacts
- Read
List external contacts
Lists the external contacts. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_external_contacts:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/external_contacts - Read
Get external contact details
Returns an external contact's information. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:external_contact:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/external_contacts/{externalContactId} - Write
Add an external contact
Adds an external contact. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:external_contact:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/external_contacts - Write
Update external contact
Updates an external contact's information. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:external_contact:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/external_contacts/{externalContactId} - Destructive
Delete an external contact
Removes an external contact. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:external_contact:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/external_contacts/{externalContactId}
Fax
- Read
Get extension's fax logs
Returns the extension's fax logs. **Prerequisites** * User must belong to a Business or Enterprise account. * User must have a Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_fax_log`,`phone:read:list_fax_log:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/extension/{extensionId}/fax/logs - Read
Get fax cover pages
Returns a list of fax cover pages for the account. **Prerequisites** * User must belong to a Business or Enterprise account. * User must have a Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:fax_cover_page`,`phone:read:fax_cover_page:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/fax/cover_pages - Read
Download fax cover page preview image
Downloads the preview image for a specific fax cover page. **Prerequisites** * User must belong to a Business or Enterprise account. * User must have a Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:fax_cover_page`,`phone:read:fax_cover_page:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `RESOURCE-INTENSIVE`
GET /phone/fax/cover_pages/download/{coverId} - Read
Get account's fax logs
Returns the account's fax logs. **Prerequisites** * User must belong to a Business or Enterprise account. * User must have a Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_fax_log:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /phone/fax/logs - Read
Get fax log details
Returns the fax log's details. **Prerequisites** * User must belong to a Business or Enterprise account. * User must have a Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_fax_log:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/fax/logs/{faxLogId} - Read
Download fax file
Downloads the fax file. **Prerequisites* * User must belong to a Business or Enterprise account. * User must have a Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:fax_log`,`phone:read:fax_log:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `RESOURCE-INTENSIVE`
GET /phone/fax/logs/{faxLogId}/file/{fileId} - Write
Upload fax file
Uploads fax file **Note:** * Please use `https://fileapi.zoom.us` instead of `https://api.zoom.us`, the full path is `https://fileapi.zoom.us/v2/fax/files` * Supported file formats: `.zip` * The maximum size of file is 50MB **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:send_fax`,`phone:write:send_fax:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `RESOURCE-INTENSIVE`
POST /fax/files - Write
Send fax
Sends a fax to receivers. **Prerequisites** * User must belong to a Business or Enterprise account. * User must have a Zoom Phone license. **Note:** Faxes sent through the API will first use the account-level page pool, if available. If no page pool is available, pages meter individually. Unlimited faxing does not apply to faxes sent through the API. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:send_fax`,`phone:write:send_fax:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/fax/documents - Write
Update fax log read status
Updates the read status of a specific fax log. **Prerequisites** * User must belong to a Business or Enterprise account. * User must have a Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:fax_log:admin`,`phone:read:fax_log` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/fax/logs/{faxLogId} - Destructive
Delete fax log
Deletes a specific fax log. **Prerequisites** * User must belong to a Business or Enterprise account. * User must have a Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:fax_log`,`phone:delete:fax_log:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/fax/logs/{faxLogId}
Firmware Update Rules
- Read
List firmware update rules
Use this API to get [firmware update rules](https://support.zoom.us/hc/en-us/articles/360054198852-Setting-up-firmware-update-rules). **Prerequisites:** * Business or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_firmware_update_rules:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
GET /phone/firmware_update_rules - Read
Get firmware update rule information
Use this API to get the [firmware update rule](https://support.zoom.us/hc/en-us/articles/360054198852-Setting-up-firmware-update-rules) information. **Prerequisites:** * Business or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:firmware_update_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
GET /phone/firmware_update_rules/{ruleId} - Read
List updatable firmwares
Use this API to get updatable [firmwares](https://support.zoom.us/hc/en-us/articles/360054198852-Setting-up-firmware-update-rules). **Prerequisites:** * Business or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_firmwares:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
GET /phone/firmwares - Write
Add a firmware update rule
Use this API to add a [firmware update rule](https://support.zoom.us/hc/en-us/articles/360054198852-Setting-up-firmware-update-rules). **Prerequisites:** * Business, or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:firmware_update_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
POST /phone/firmware_update_rules - Write
Update firmware update rule
Use this API to update a specific [firmware update rule](https://support.zoom.us/hc/en-us/articles/360054198852-Setting-up-firmware-update-rules). **Prerequisites:** * Business, or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:firmware_update_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
PATCH /phone/firmware_update_rules/{ruleId} - Destructive
Delete firmware update rule
Use this API to delete the [firmware update rule](https://support.zoom.us/hc/en-us/articles/360054198852-Setting-up-firmware-update-rules). **Prerequisites:** * Business or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:firmware_update_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/firmware_update_rules/{ruleId}
Group Call Pickup
- Read
List group call pickup objects
Use this API to retrieve a list of [Group Call Pickup](https://support.zoom.us/hc/en-us/articles/360060107472-Setting-up-and-using-group-call-pickup) objects in an account. **Prerequisites:** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_pickup_groups:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/group_call_pickup - Read
Get call pickup group by ID
Use this API to retrieve information on a specific [Group Call Pickup](https://support.zoom.us/hc/en-us/articles/360060107472-Setting-up-and-using-group-call-pickup) object in an account. **Prerequisites:** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_pickup_group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
GET /phone/group_call_pickup/{groupId} - Read
List call pickup group members
Use this API to retrieve members of a [call pickup group](https://support.zoom.us/hc/en-us/articles/360060107472-Setting-up-and-using-group-call-pickup) in an account. **Prerequisites:** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_pickup_group_member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
GET /phone/group_call_pickup/{groupId}/members - Write
Add a group call pickup object
Use this API to add a [Group Call Pickup](https://support.zoom.us/hc/en-us/articles/360060107472-Setting-up-and-using-group-call-pickup) instance to the account that has the Zoom Phone license assigned. **Prerequisites:** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:call_pickup_group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/group_call_pickup - Write
Update the group call pickup information
Use this API to update a specific [Group Call Pickup](https://support.zoom.us/hc/en-us/articles/360060107472-Setting-up-and-using-group-call-pickup) object information. **Prerequisites:** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_pickup_group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
PATCH /phone/group_call_pickup/{groupId} - Write
Add members to a call pickup group
Use this API to add members to the specified [Group Call Pickup](https://support.zoom.us/hc/en-us/articles/360060107472-Setting-up-and-using-group-call-pickup) object. **Prerequisites:** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:call_pickup_group_member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
POST /phone/group_call_pickup/{groupId}/members - Destructive
Delete group call pickup objects
Use this API to remove a [Group Call Pickup](https://support.zoom.us/hc/en-us/articles/360060107472-Setting-up-and-using-group-call-pickup) object. **Prerequisites:** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_pickup_group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/group_call_pickup/{groupId} - Destructive
Remove members from call pickup group
Use this API to remove member from the [Group Call Pickup](https://support.zoom.us/hc/en-us/articles/360060107472-Setting-up-and-using-group-call-pickup) object. **Prerequisites:** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_pickup_group_member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/group_call_pickup/{groupId}/members/{extensionId}
Groups
- Read
Get group policy details
Returns the group policy details. **Prerequisites** Pro or higher account plan with Zoom phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:group_policy:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/groups/{groupId}/policies/{policyType} - Read
Get group phone settings
Returns group phone settings. **Prerequisites** Account must have a Pro or a higher plan with Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:group_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/groups/{groupId}/settings - Read
List groups
List [groups](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account. **Prerequisite**: Pro or higher account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:read:admin`,`group:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:read:list_groups:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /groups - Read
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:read:admin`,`group:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:read:group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /groups/{groupId} - Read
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:read:admin`,`group:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:read:administrator:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /groups/{groupId}/admins - Read
List group channels
Returns a list of channels for a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. **Prerequisite**: - Pro, Business, or Education account **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:read:admin`,`group:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:read:list_channels:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /groups/{groupId}/channels - Read
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 deprecated as of September 22, 2019. **Prerequisite**: Pro, Business, or Education account **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:read:admin`,`group:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:read:lock_settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /groups/{groupId}/lock_settings - Read
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:read:admin`,`group:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:read:list_members:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /groups/{groupId}/members - Read
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:read:admin`,`group:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:read:settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /groups/{groupId}/settings - Read
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:read:admin`,`group:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:read:registration_settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /groups/{groupId}/settings/registration - Write
Update group policy
Updates the group policy. **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:group_policy:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
PATCH /phone/groups/{groupId}/policies/{policyType} - Write
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:write:group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /groups - Write
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:update:group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /groups/{groupId} - Write
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:write:administrator:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /groups/{groupId}/admins - Write
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. **Prerequisite**: Pro, Business, or Education account **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:update:lock_settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /groups/{groupId}/lock_settings - Write
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:write:member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /groups/{groupId}/members - Write
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:update:member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /groups/{groupId}/members/{memberId} - Write
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 deprecated as of September 22, 2019. **Prerequisite**: Pro, Business, or Education account **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:update:settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /groups/{groupId}/settings - Write
Update meeting Waiting Room branding
Sets the meeting Waiting Room branding (logo, background image, video, welcome title/description, and layout) for the group. To update the settings for a group in a sub account, use the account-scoped version of this API and pass the account ID in the `accountId` path parameter. **Prerequisites:** * The account must be a paid account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:write:waiting_room_branding:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /groups/{groupId}/settings/meeting_waiting_room_branding - Write
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:update:registration_settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /groups/{groupId}/settings/registration - Write
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:write:virtual_background_files:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /groups/{groupId}/settings/virtual_backgrounds - Write
Update webinar Waiting Room branding
Sets the Webinar Waiting Room branding (logo, background image, video, welcome title/description, and layout) for the group. To update the settings for a group in a sub account, use the account-scoped version of this API and pass the account ID in the `accountId` path parameter. **Prerequisites:** * The account must be a paid account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:write:waiting_room_branding:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /groups/{groupId}/settings/webinar_waiting_room_branding - Destructive
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:delete:group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /groups/{groupId} - Destructive
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:delete:administrator:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /groups/{groupId}/admins/{userId} - Destructive
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:delete:member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /groups/{groupId}/members/{memberId} - Destructive
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](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `group:delete:virtual_background_files:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /groups/{groupId}/settings/virtual_backgrounds
IVR
- Read
Get auto receptionist IVR
Returns an [interactive voice response (IVR) system](https://support.zoom.us/hc/en-us/articles/360038601971) of the specified auto receptionist. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:auto_receptionist_ivr:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/auto_receptionists/{autoReceptionistId}/ivr - Write
Update auto receptionist IVR
Updates the [interactive voice response (IVR) system](https://support.zoom.us/hc/en-us/articles/360038601971) of the specified auto receptionist. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:auto_receptionist_ivr:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/auto_receptionists/{autoReceptionistId}/ivr
Inbound Blocked List
- Read
List an extension's inbound block rules
Returns a list of the given extension's block rule for inbound calls and messaging. it lists inbound block rule for the given Call Queue, Auto Receptionist, Shared Line Group, Common Area, Zoom Room, or User. **Prerequisites:** * Pro or a higher account with Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_extension_inbound_block_rules:admin`,`phone:read:list_extension_inbound_block_rules` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/extension/{extensionId}/inbound_blocked/rules - Read
List an account's inbound blocked statistics
Returns the list of the statistics of the extensions blocked rule for inbound calls and messaging. (e.g. Call Queue, Auto Receptionist, Shared Line Group, Common Area, Zoom Room and User) **Prerequisites:** * Pro or higher account plan with Zoom phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_extension_inbound_block_rules_stat:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/inbound_blocked/extension_rules/statistics - Read
List an account's inbound block rules
Returns a list of account level inbound block rule for inbound calls and messaging. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_inbound_block_rules:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/inbound_blocked/rules - Write
Add an extension's inbound block rule
Adds the given extension's block rule for inbound calls and messaging. It adds the inbound block rule for the given Call Queue, Auto Receptionist, Shared Line Group, Common Area, Zoom Room or User. **Prerequisites:** * Pro or a higher account with Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:extension_inbound_block_rule:admin`,`phone:write:extension_inbound_block_rule` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/extension/{extensionId}/inbound_blocked/rules - Write
Mark a phone number as blocked for all extensions
Promotes and applies the phone number blocked from the extension level blocked rule to the account level blocked rule. This action is contingent on the statistics of extensions blocked rule. All extensions under the current account block this phone number. **Prerequisites:** * Pro or higher account plan with Zoom phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:inbound_blocked_for_all:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/inbound_blocked/extension_rules/statistics/blocked_for_all - Write
Add an account's inbound block rule
Adds an account level block rule for inbound calls and messaging from a phone number. As a result, all extensions block calls and messages to the phone number. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:inbound_block_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/inbound_blocked/rules - Write
Update an account's inbound block rule
Updates the account level block rule for inbound calls and messaging. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:inbound_block_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/inbound_blocked/rules/{blockedRuleId} - Destructive
Delete an extension's inbound block rule
Deletes the given extension's blocked rule for inbound calls and messaging. Use this API to delete inbound blocked rule for the given Call Queue, Auto Receptionist, Shared Line Group, Common Area, Zoom Room or User. **Prerequisites:** * Pro or a higher account with Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:extension_inbound_block_rule:admin`,`phone:delete:extension_inbound_block_rule` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/extension/{extensionId}/inbound_blocked/rules - Destructive
Delete an account's inbound blocked statistics
Deletes the statistic of extensions blocked rule for inbound calls and messaging. (e.g. Call Queue, Auto Receptionist, Shared Line Group, Common Area, Zoom Room and User) **Prerequisites:** * Pro or higher account plan with Zoom phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:extension_inbound_block_rule_stat:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/inbound_blocked/extension_rules/statistics - Destructive
Delete an account's inbound block rule
Deletes the account level blocked rule for inbound calls and messaging. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:inbound_block_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/inbound_blocked/rules
Line Keys
- Read
Get line key position and settings information
Use this API to get the Zoom Phone [line key settings](https://support.zoom.us/hc/en-us/articles/360040587552) information. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:line_keys`,`phone:read:line_keys:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
GET /phone/extension/{extensionId}/line_keys - Write
Batch update line key position and settings information
Use this API to batch update the Zoom Phone [line key settings](https://support.zoom.us/hc/en-us/articles/360040587552) information. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:line_keys`,`phone:update:line_keys:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
PATCH /phone/extension/{extensionId}/line_keys - Destructive
Delete a line key setting.
Use this API to delete the Zoom Phone [line key settings](https://support.zoom.us/hc/en-us/articles/360040587552) information. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:line_keys`,`phone:delete:line_keys:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/extension/{extensionId}/line_keys/{lineKeyId}
Monitoring Groups
- Read
Get a list of monitoring groups on an account
Returns an account's [monitoring group](https://support.zoom.us/hc/en-us/articles/360044804711) list. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_monitoring_groups:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/monitoring_groups - Read
Get monitoring group by ID
Returns a [monitoring group](https://support.zoom.us/hc/en-us/articles/360044804711) for the specified ID. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:monitoring_group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/monitoring_groups/{monitoringGroupId} - Read
Get members of a monitoring group
Use this API to return members list of a [Monitoring Group](https://support.zoom.us/hc/en-us/articles/360044804711). **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_monitoring_group_members:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
GET /phone/monitoring_groups/{monitoringGroupId}/monitor_members - Write
Create a monitoring group
Creates a [monitoring group](https://support.zoom.us/hc/en-us/articles/360044804711). **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:monitoring_group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/monitoring_groups - Write
Update a monitoring group
Use this API to update a [Monitoring Group](https://support.zoom.us/hc/en-us/articles/360044804711). **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:monitoring_group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
PATCH /phone/monitoring_groups/{monitoringGroupId} - Write
Add members to a monitoring group
Use this API to add members to a [Monitoring Group](https://support.zoom.us/hc/en-us/articles/360044804711). **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:monitoring_group_member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
POST /phone/monitoring_groups/{monitoringGroupId}/monitor_members - Destructive
Delete a monitoring group
Use this API to delete a [Monitoring Group](https://support.zoom.us/hc/en-us/articles/360044804711). **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:monitoring_group:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/monitoring_groups/{monitoringGroupId} - Destructive
Remove all monitors or monitored members from a monitoring group
Use this API to remove all monitor or monitored members from a [Monitoring Group](https://support.zoom.us/hc/en-us/articles/360044804711). **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:monitoring_group_member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/monitoring_groups/{monitoringGroupId}/monitor_members - Destructive
Remove a member from a monitoring group
Use this API to remove a member from a [Monitoring Group](https://support.zoom.us/hc/en-us/articles/360044804711). **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:monitoring_group_member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/monitoring_groups/{monitoringGroupId}/monitor_members/{memberExtensionId}
Outbound Calling
- Read
Get common area level outbound calling countries and regions
Returns the common area level outbound calling countries and regions. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:common_area_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/common_areas/{commonAreaId}/outbound_calling/countries_regions - Read
List common area level outbound calling exception rules
Lists the common area level outbound calling policy exception rules. **Prerequisite:** * Pro or higher account plan with Zoom phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:common_area_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/common_areas/{commonAreaId}/outbound_calling/exception_rules - Read
Get account level outbound calling countries and regions
Returns the account level outbound calling countries and regions. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_outbound_calling_rules:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/outbound_calling/countries_regions - Read
List account level outbound calling exception rules
Lists the account level outbound calling policy exception rules. **Prerequisite:** * Pro or higher account plan with Zoom phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_outbound_calling_rules:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/outbound_calling/exception_rules - Read
Get site level outbound calling countries and regions
Returns the site level outbound calling countries and regions. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:site_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/sites/{siteId}/outbound_calling/countries_regions - Read
List site level outbound calling exception rules
Returns a list of site level outbound calling policy exception rules. **Prerequisite:** * Pro or higher account plan with Zoom phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:site_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/sites/{siteId}/outbound_calling/exception_rules - Read
Get user level outbound calling countries and regions
Returns the user level outbound calling countries and regions. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:user_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/users/{userId}/outbound_calling/countries_regions - Read
List user level outbound calling exception rules
Returns a list of the user level outbound calling policy exception rules. **Prerequisite:** * Pro or higher account plan with Zoom phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:user_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/users/{userId}/outbound_calling/exception_rules - Write
Add common area level outbound calling exception rule
Adds the common area level outbound calling policy exception rule for the country region. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:common_area_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/common_areas/{commonAreaId}/outbound_calling/exception_rules - Write
Update common area level outbound calling exception rule
Updates the common area level outbound calling policy for the country region exception rule. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:common_area_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/common_areas/{commonAreaId}/outbound_calling/exception_rules/{exceptionRuleId} - Write
Add account level outbound calling exception rule
Adds the account level outbound calling policy exception rule for country region. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/outbound_calling/exception_rules - Write
Update account level outbound calling exception rule
Updates the account level outbound calling policy for the country region exception rule. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/outbound_calling/exception_rules/{exceptionRuleId} - Write
Add site level outbound calling exception rule
Adds the site level outbound calling policy exception rule for the country region. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:site_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/sites/{siteId}/outbound_calling/exception_rules - Write
Update site level outbound calling exception rule
Updates the site level outbound calling policy for the country region exception rule. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:site_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/sites/{siteId}/outbound_calling/exception_rules/{exceptionRuleId} - Write
Add user level outbound calling exception rule
Adds an user level outbound calling policy exception rule for the country region. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:user_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/users/{userId}/outbound_calling/exception_rules - Write
Update user level outbound calling exception rule
Updates the user level outbound calling policy for the country region exception rule. **Prerequisites:** * Pro or a higher account with Zoom Phone license. * Account owner or admin permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:user_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/users/{userId}/outbound_calling/exception_rules/{exceptionRuleId} - Destructive
Update common area level outbound calling countries or regions
Updates the common area level outbound calling policy country or region. **Prerequisite:** * Account must have a Pro or a higher plan with a Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:common_area_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/common_areas/{commonAreaId}/outbound_calling/countries_regions - Destructive
Delete common area level outbound calling exception rule
Deletes the common area level outbound calling exception rule. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:common_area_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/common_areas/{commonAreaId}/outbound_calling/exception_rules/{exceptionRuleId} - Destructive
Update account level outbound calling countries or regions
Updates the account level outbound calling policy country or region. **Prerequisite:** * Account must have a Pro or a higher plan with a Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/outbound_calling/countries_regions - Destructive
Delete account level outbound calling exception rule
Deletes the account level outbound calling exception rule. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/outbound_calling/exception_rules/{exceptionRuleId} - Destructive
Update site level outbound calling countries or regions
Updates the site level outbound calling policy country or region. **Prerequisites:** * Account must have a Pro or a higher plan with a Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:site_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/sites/{siteId}/outbound_calling/countries_regions - Destructive
Delete site level outbound calling exception rule
Deletes the site level outbound calling exception rule. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:site_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/sites/{siteId}/outbound_calling/exception_rules/{exceptionRuleId} - Destructive
Update user level outbound calling countries or regions
Updates the user level outbound calling policy country or region. **Prerequisite:** * Account must have a Pro or a higher plan with a Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:user_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/users/{userId}/outbound_calling/countries_regions - Destructive
Delete user level outbound calling exception rule
Deletes the user level outbound calling exception rule. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:user_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/users/{userId}/outbound_calling/exception_rules/{exceptionRuleId}
Phone Devices
- Read
List devices
Lists all the [desk phone devices](https://support.zoom.us/hc/en-us/articles/360021119092) that are configured with Zoom Phone on an account. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_devices:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/devices - Read
Get device details
Returns detailed information about a specific [desk phone device](https://support.zoom.us/hc/en-us/articles/360021119092). **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:device:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/devices/{deviceId} - Read
List Smartphones
Returns a list of all the [smartphones](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0074058) configured with Zoom Phone on an account. **Prerequisites** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_devices:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /phone/smartphones - Write
Add a device
[Adds an unassigned desk phone or an assigned (to a user or a common area) desk phone.](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061431#h_5ca07504-68a8-4c3d-ad0e-c1d3594436da) **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions * [Supported device](https://support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices) **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:device:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/devices - Write
Sync deskphones
Use this API to resync all online zero-touch or assisted-provisioning devices in an account or a site. Only allows sending one request every 15 minutes. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:sync_device:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
POST /phone/devices/sync - Write
Update a device
Updates the information of a [desk phone device](https://support.zoom.us/hc/en-us/articles/360021119092). **Prerequisites:** * Pro or a higher account with Zoom Phone license* Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:device:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/devices/{deviceId} - Write
Assign an entity to a device
By default, all Zoom Phone users can make and receive calls using the Zoom desktop and mobile applications. Additionally, if a desk phone is required, use this API to [add a desk phone and assign it to a user](https://support.zoom.us/hc/en-us/articles/360021119092#h_5ca07504-68a8-4c3d-ad0e-c1d3594436da). **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions * [Supported device](https://support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices) **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:device_extension:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
POST /phone/devices/{deviceId}/extensions - Write
Reboot a desk phone
Use this API to reboot an online zero-touch or assisted-provisioning device. You can only send one request every second. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:reboot_device:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
POST /phone/devices/{deviceId}/reboot - Destructive
Delete a device
Remove a [desk phone device or ATA (Analog Telephone Adapter)](https://support.zoom.us/hc/en-us/articles/360021119092) from the Zoom Phone System Management. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions * Device must not have been assigned to a user. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:device:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/devices/{deviceId} - Destructive
Unassign an entity from the device
Use this API to unassign a specific assignee from the device. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:device_extension:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/devices/{deviceId}/extensions/{extensionId} - Destructive
Update provision template of a device
Use this API to [assign a provision template to a device](https://support.zoom.us/hc/en-us/articles/360035817952#h_6b52ef26-d070-40ed-a3fa-520571944afc) or [remove a provision template from the device](https://support.zoom.us/hc/en-us/articles/360035817952#h_7b34cd1d-5ae6-4a23-bd04-454a6ad8cb3e) by leaving `templateId` empty. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions * [Supported device](https://support.zoom.us/hc/en-us/articles/360029698771#note) **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:device_provision_template:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
PUT /phone/devices/{deviceId}/provision_templates
Phone Plans
- Read
List calling plans
Returns all of an account's Zoom Phone [calling plans](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans). **Prerequisites** * A Pro or a higher account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_calling_plans:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/calling_plans - Read
List plan information (deprecated)
Returns all of an account's Zoom Phone [plan package](https://marketplace.zoom.us/docs/api-reference/other-references/plans#additional-zoom-phone-plans-and-codes), phone number usage, and availability. **Prerequisites** * A Pro or a higher account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_calling_plans:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/plans
Phone Roles
- Read
List phone roles
Returns the phone roles. **Prerequisites:** * Business or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_roles:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/roles - Read
Get role information
Use this API to get information on a phone [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management). **Prerequisites:** * Business, or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:role:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
GET /phone/roles/{roleId} - Read
List members in a role
Use this API to get members (not) in a [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management). **Prerequisites:** * Business or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:role_member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
GET /phone/roles/{roleId}/members - Read
List phone role targets
Targets of a phone [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management). **Prerequisites:** * Business or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_roles:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/roles/{roleId}/targets - Write
Duplicate a phone role
Use this API to duplicate a phone role. **Prerequisites:** * Business or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:role:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
POST /phone/roles - Write
Update a phone role
Use this API to update a role. **Prerequisites:** * Business, or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:role:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
PATCH /phone/roles/{roleId} - Write
Add members to roles
Use this API to add members to [roles](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management#h_01EFHY1R4QWAYTA6Z661NM9Q27). **Prerequisites:** * Business or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:role_member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
POST /phone/roles/{roleId}/members - Write
Add phone role targets
Adds targets to phone [roles](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management). **Prerequisites:** * Business or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:role:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/roles/{roleId}/targets - Destructive
Delete a phone role
Use this API to delete a phone [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management). **Prerequisites:** * Business, or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:role:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/roles/{roleId} - Destructive
Delete members in a role
Use this API to delete member(s) in a [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management). **Prerequisites:** * Business or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:role_member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/roles/{roleId}/members - Destructive
Delete phone role targets
Deletes the targets of a phone [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management). **Prerequisites:** * Business or Education account * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:role:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /phone/roles/{roleId}/targets
Private Directory
- Read
List private directory members
Returns the member list of a [private directory](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063992). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_private_directory_members:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/private_directory/members - Write
Add members to a private directory
Adds members to a [private directory](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063992). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:private_directory_member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/private_directory/members - Write
Update a private directory member
Updates a member of a [private directory](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063992). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:private_directory_member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/private_directory/members/{extensionId} - Destructive
Remove a member from a private directory
Removes a member from a [private directory](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063992). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:private_directory_member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/private_directory/members/{extensionId}
Provider Exchange
- Read
List carrier peering phone numbers. (deprecated)
Returns phone numbers that the carrier pushed to different customers. To become a peering provider/ carrier, submit your [request](https://docs.google.com/forms/d/e/1FAIpQLSewkY6ixVyKVNkWC-vgmejC16gigxsJWXji3dWzE3XlWtjsgg/viewform). **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_peering:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_peering_numbers:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/carrier_peering/numbers - Read
List peering phone numbers (deprecated)
Returns phone numbers to Zoom through the Provider Exchange. **Note**: Phone peering API and events are for partners who have completed the MoU to peer with Zoom. To become a peering provider/ carrier, submit your [request](https://docs.google.com/forms/d/e/1FAIpQLSewkY6ixVyKVNkWC-vgmejC16gigxsJWXji3dWzE3XlWtjsgg/viewform). **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_peering:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_peering_numbers:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/peering/numbers - Write
Add peering phone numbers (deprecated)
Adds phone numbers to Zoom through the Provider Exchange. **Note**: Phone peering API and events are for partners who have completed the MoU to peer with Zoom. To become a peering provider/ carrier, submit your [request](https://docs.google.com/forms/d/e/1FAIpQLSewkY6ixVyKVNkWC-vgmejC16gigxsJWXji3dWzE3XlWtjsgg/viewform). **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone_peering:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:peering_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/peering/numbers - Write
Update peering phone numbers (deprecated)
Updates phone numbers to Zoom through the Provider Exchange. **Note**: Phone peering API and events are for partners that have completed the MoU to peer with Zoom. To become a peering provider/ carrier, submit your [request](https://docs.google.com/forms/d/e/1FAIpQLSewkY6ixVyKVNkWC-vgmejC16gigxsJWXji3dWzE3XlWtjsgg/viewform). **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone_peering:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:peering_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/peering/numbers - Destructive
Remove peering phone numbers (deprecated)
Removes phone numbers added to Zoom through the provider exchange. **Note**: Phone peering API and events are for partners who have completed the MoU to peer with Zoom. To become a peering provider or carrier, submit your [request](https://docs.google.com/forms/d/e/1FAIpQLSewkY6ixVyKVNkWC-vgmejC16gigxsJWXji3dWzE3XlWtjsgg/viewform). **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone_peering:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:peering_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/peering/numbers
Provision Templates
- Read
List provision templates
Use this API to list all [provision templates](https://support.zoom.us/hc/en-us/articles/360035817952) in a Zoom account. **Prerequisites:** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_provision_templates:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
GET /phone/provision_templates - Read
Get a provision template
Use this API to get a specific [provision template](https://support.zoom.us/hc/en-us/articles/360035817952). **Prerequisites:** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:provision_template:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
GET /phone/provision_templates/{templateId} - Write
Add a provision template
Use this API to [create a provision template](https://support.zoom.us/hc/en-us/articles/360035817952#h_8266cb40-58fc-4c1a-8da2-885d72167234) in a Zoom account. **Prerequisites:** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:provision_template:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
POST /phone/provision_templates - Write
Update a provision template
Use this API to update a [provision template](https://support.zoom.us/hc/en-us/articles/360035817952#h_7b34cd1d-5ae6-4a23-bd04-454a6ad8cb3e) in a Zoom account. **Prerequisites:** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:provision_template:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
PATCH /phone/provision_templates/{templateId} - Destructive
Delete a provision template
Use this API to [delete a provision template](https://support.zoom.us/hc/en-us/articles/360035817952#h_7b34cd1d-5ae6-4a23-bd04-454a6ad8cb3e) in a Zoom account. **Prerequisites:** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:provision_template:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/provision_templates/{templateId}
Push To Talk
- Read
List push to talk channels
Returns a list of push to talk (PTT) channels. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_push_to_talk_channels:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/push_to_talk/channels - Read
Get push to talk channel details
Returns push to talk (PTT) channel details. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:push_to_talk_channel:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/push_to_talk/channels/{channelId} - Read
List push to talk channel members
Returns a list of push to talk (PTT) members. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_push_to_talk_channel_members:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/push_to_talk/channels/{channelId}/members - Write
Create a push to talk channel
Creates a push to talk (PTT) channel. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:push_to_talk_channel:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/push_to_talk/channels - Write
Update push to talk channel details
Updates the push to talk (PTT) channel details. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:push_to_talk_channel:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
PATCH /phone/push_to_talk/channels/{channelId} - Write
Add members to a push to talk (PTT) channel
Adds members to a push to talk (PTT) channel. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:push_to_talk_channel_member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/push_to_talk/channels/{channelId}/members - Destructive
Remove a push to talk channel
Removes a push to talk (PTT) channel. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:push_to_talk_channel:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/push_to_talk/channels/{channelId} - Destructive
Remove a member from a push to talk channel
Removes a member from a push to talk (PTT) channel. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:push_to_talk_channel_member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/push_to_talk/channels/{channelId}/members/{extensionId}
Routing Rules
- Read
List directory backup routing rules
Returns a list of directory backup routing rules. The directory backup routing rules are a series of predefined Regular Expressions. These rules are used to route outgoing calls. If a dialed number does not match a Zoom Phone user, and does not match a defined External Contact, these rules are tested next. If a dialed number does not match any rules, the call will be routed via the PSTN. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_routing_rules:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
GET /phone/routing_rules - Read
Get directory backup routing rule
Returns the directory backup routing rule. The directory backup routing rules are a series of predefined Regular Expressions. These rules are used to route outgoing calls. If a dialed number does not match a Zoom Phone user, and does not match a defined External Contact, these rules are tested next. If a dialed number does not match any rules, the call will be routed via the PSTN.**Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:routing_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
GET /phone/routing_rules/{routingRuleId} - Write
Add directory backup routing rule
Creates a directory backup routing rule. The directory backup routing rules are a series of predefined regular expressions. These rules are used to route outgoing calls. If a dialed number does not match a Zoom Phone user, and does not match a defined external contact, these rules are tested next. If a dialed number does not match any rules, the call will be routed through the PSTN. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:routing_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
POST /phone/routing_rules - Write
Update directory backup routing rule
Updates the directory backup routing rule. The directory backup routing rules are a series of predefined regular expressions. These rules are used to route outgoing calls. If a dialed number does not match a Zoom Phone user, and does not match a defined external contact, these rules are tested next. If a dialed number does not match any rules, the call will be routed through the PSTN. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:routing_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
PATCH /phone/routing_rules/{routingRuleId} - Destructive
Delete directory backup routing rule
Deletes the directory backup routing rule. The directory backup routing rules are a series of predefined Regular Expressions. These rules are used to route outgoing calls. If a dialed number does not match a Zoom Phone user, and does not match a defined External Contact, these rules are tested next. If a dialed number does not match any rules, the call will be routed via the PSTN. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:routing_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/routing_rules/{routingRuleId}
SMS Campaign
- Read
List SMS campaigns (deprecated)
Returns a list of all SMS campaigns in a Zoom account. **Prerequisites** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_sms_campaigns:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/sms_campaigns - Read
Get an SMS campaign (deprecated)
Returns a specific SMS campaign. **Prerequisites:** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:sms_campaign:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/sms_campaigns/{smsCampaignId} - Read
List opt statuses of phone numbers assigned to SMS campaign
Returns the opt statuses of phone numbers that are assigned to SMS the campaign. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:sms_campaign_number_opt_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/sms_campaigns/{smsCampaignId}/phone_numbers/opt_status - Read
List user's opt statuses of phone numbers
Returns the opt statuses of a user’s phone numbers. For user-level apps, pass the <a href="https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword" target="_blank">me</a> value instead of the userId parameter. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:sms_campaign_number_opt_status`,`phone:read:sms_campaign_number_opt_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/user/{userId}/sms_campaigns/phone_numbers/opt_status - Write
Assign a phone number to SMS campaign (deprecated)
[Assigns a phone number to the SMS campaign](https://support.zoom.us/hc/en-us/articles/5016496738445-SMS-MMS-10DLC-Compliance-for-Zoom-Phone-and-Zoom-Contact-Center#h_01FYVVQM1WMW5JD48YNY3J581B). **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:sms_campaign_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/sms_campaigns/{smsCampaignId}/phone_numbers - Write
Update opt statuses of phone numbers assigned to SMS campaign
Updates opt statuses of phone numbers that are assigned to the SMS campaign. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:sms_campaign_number_opt_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/sms_campaigns/{smsCampaignId}/phone_numbers/opt_status - Destructive
Unassign a phone number (deprecated)
[Unassigns a phone number from the SMS campaign](https://support.zoom.us/hc/en-us/articles/5016496738445-SMS-MMS-10DLC-Compliance-for-Zoom-Phone-and-Zoom-Contact-Center#h_01FYVVSPVM8MZN4Y9EW5690QHH). Remove the assigned phone number from the campaign. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license * The campaign must have been previously assigned a Zoom Phone number **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:sms_campaign_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/sms_campaigns/{smsCampaignId}/phone_numbers/{phoneNumberId}
Setting Templates
- Read
List setting templates
Gets a list of all the created phone template settings. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_setting_templates:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/setting_templates - Read
Get setting template details
Returns information about an account's phone template. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:setting_template:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/setting_templates/{templateId} - Write
Add a setting template
Creates a Zoom Phone setting template for an account. After creating a phone template, the defined settings will become the default settings for an account. **Prerequisites:** * A Business or enterprise Zoom account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:setting_template:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
POST /phone/setting_templates - Write
Update a setting template
Updates or modifies a phone template's settings. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:setting_template:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/setting_templates/{templateId}
Shared Line Appearance
Shared Line Group
- Write
Assign phone numbers
Assigns phone numbers to a shared line groups. These direct phone numbers will be shared among members of the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792-Setting-up-shared-line-groups). **Prerequisites:** * Pro or higher account with Zoom Phone license. * A valid Shared Line Group * Account owner or admin privileges **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:shared_line_group_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/shared_line_groups/{slgId}/phone_numbers - Write
Add a policy setting to a shared line group
Adds the policy sub-setting for a specific [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) according to the `policyType`. For example, you can use this API to set up shared access members. **Prerequisites:** * Pro or higher account with Zoom Phone license.* Account owner or admin privileges **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:shared_line_group_policy:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /phone/shared_line_groups/{slgId}/policies/{policyType} - Write
Update an SLG policy setting
Updates the policy sub-setting for a specific [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) according to the `policyType`. For example, you can use this API to update shared access members. **Prerequisites:** * Pro or higher account with Zoom Phone license. * Account owner or admin privileges **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:shared_line_group_policy:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/shared_line_groups/{slgId}/policies/{policyType} - Destructive
Unassign members from a shared line group
Unassigns **all** existing members from a shared line group. Members of the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) have access to the group's phone number and voicemail. **Prerequisites:** * Pro or higher account with Zoom Phone license. * A valid Shared Line Group * Account owner or admin privileges **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:shared_line_member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/shared_line_groups/{slgId}/members - Destructive
Unassign a member from a shared line group
Unassigns **a specific member** from a shared line group. Members of the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) have access to the group's phone number and voicemail. **Prerequisites:** * Pro or higher account with Zoom Phone license. * A valid Shared Line Group * Account owner or admin privileges **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:shared_line_member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/shared_line_groups/{slgId}/members/{memberId} - Destructive
Unassign all phone numbers
Unassigns all the phone numbers that have been assigned to the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792-Setting-up-shared-line-groups). **Prerequisites:** * Pro or higher account with Zoom Phone license. * A valid Shared Line Group * Account owner or admin privileges **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:shared_line_group_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/shared_line_groups/{slgId}/phone_numbers - Destructive
Unassign a phone number
Unassigns a specific phone number that was assigned to the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792-Setting-up-shared-line-groups). **Prerequisites:** * Pro or higher account with Zoom Phone license. * A valid shared line group * Account owner or admin privileges **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:shared_line_group_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/shared_line_groups/{slgId}/phone_numbers/{phoneNumberId} - Destructive
Delete an SLG policy setting
Removes the policy sub-setting for a specific [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) according to the `policyType`. For example, you can use this API to remove shared access members. **Prerequisites:** * Pro or higher account with Zoom Phone license.* Account owner or admin privileges **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:shared_line_group_policy:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/shared_line_groups/{slgId}/policies/{policyType}
Sites
- Read
List phone sites
Sites allow you to organize Zoom Phone users in your organization. Use this API to list all the [sites](https://support.zoom.us/hc/en-us/articles/360020809672) that have been created for an account. **Prerequisites:** * Multiple Sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15). * Pro or a higher account with Zoom Phone enabled. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_sites:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/sites - Read
Get phone site details
Returns information on a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672). Sites allow you to organize Zoom Phone users in your organization. **Prerequisites** * Account must have a Pro or a higher plan with Zoom Phone license. * Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:site:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/sites/{siteId} - Read
List customized outbound caller ID phone numbers
Use this API to retrieve phone numbers that can be used as the `site-level` customized outbound caller ID. * Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15). **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_site_customized_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
GET /phone/sites/{siteId}/outbound_caller_id/customized_numbers - Read
Get a phone site setting
Gets the site setting about a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672) according to the setting type. Sites allow you to organize Zoom Phone users in your organization. **Prerequisites:** * Account must have a Pro or a higher plan with Zoom Phone license. * Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:site_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/sites/{siteId}/settings/{settingType} - Write
Create a phone site
Creates a [site](https://support.zoom.us/hc/en-us/articles/360020809672) that allows you to organize the Zoom Phone users in your organization. **Prerequisites:** * Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15). * Pro or a higher account with Zoom Phone enabled. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:site:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/sites - Write
Update phone site details
Updates information about a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672). It allows you to organize Zoom Phone users in your organization. **Prerequisites** An account must have a Pro or a higher plan with Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:site:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/sites/{siteId} - Write
Add customized outbound caller ID phone numbers
Use this API to add the `site-level` customized outbound caller ID phone numbers. * Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15). **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:site_customized_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
POST /phone/sites/{siteId}/outbound_caller_id/customized_numbers - Write
Add a site setting
Sites allow you to organize Zoom Phone users in your organization. Use this API to add a site setting to a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672) according to the setting type. **Prerequisites:** * Account must have a Pro or a higher plan with Zoom Phone license. * Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:site_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/sites/{siteId}/settings/{settingType} - Write
Update the site setting
Allows you to organize Zoom Phone users in your organization. You can update the site setting of a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672) according to the setting type. **Prerequisites** * Account must have a Pro or a higher plan with Zoom Phone license. * Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:site_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/sites/{siteId}/settings/{settingType} - Destructive
Delete a phone site
Use this API to delete a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672) in a Zoom account. To delete a site, in the query parameter, you must provide the site ID of another site where the assets of current site (users, numbers and phones) can be transferred to. You cannot use this API to delete the main site. **Prerequisites:** * Account must have a Pro or a higher plan with Zoom Phone license. * [Multiple sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) must be enabled. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:site:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/sites/{siteId} - Destructive
Remove customized outbound caller ID phone numbers
Use this API to remove the `site-level` customized outbound caller ID phone numbers. * Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15). **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:site_customized_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/sites/{siteId}/outbound_caller_id/customized_numbers - Destructive
Delete a site setting
Sites allow you to organize Zoom Phone users in your organization. Use this API to delete the site setting of a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672). **Prerequisites:** * Account must have a Pro or a higher plan with Zoom Phone license. * Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:site_setting:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/sites/{siteId}/settings/{settingType}
Voicemails
- Read
Get a voicemail by call element ID
Returns the detailed information on a voicemail by the call element's `callElementId`. **Prerequisites** * A Pro or higher account with Zoom Phone license * Account owner or admin privileges **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin`,`phone_voicemail:read`,`phone_voicemail:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:voicemail`,`phone:read:voicemail:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/call_element/{callElementId}/voice_mail - Read
Get user voicemail details from a call log (deprecated)
Returns the detailed information on a voicemail associated with a call log ID. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. **Prerequisites** * User must belong to a Business or Enterprise account * User must have a Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin`,`phone_voicemail:read`,`phone_voicemail:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:voicemail`,`phone:read:voicemail:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/users/{userId}/call_logs/{id}/voice_mail - Read
Get user's voicemails
Returns a user's Zoom Phone voicemails. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin`,`phone_voicemail:read`,`phone_voicemail:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_voicemails`,`phone:read:list_voicemails:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/users/{userId}/voice_mails - Read
Get account voicemails
Gets a user's Zoom Phone voicemails. **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_voicemail:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_voicemails:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /phone/voice_mails - Read
Download a phone voicemail
Downloads the Zoom phone voicemail. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin`,`phone_voicemail:read`,`phone_voicemail:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:voicemail:admin`,`phone:read:voicemail` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/voice_mails/download/{fileId} - Read
Get voicemail details
Returns the information about a [voicemail message](https://support.zoom.us/hc/en-us/articles/360021400211-Managing-voicemail-messages). **Prerequisites** * Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin`,`phone_voicemail:read:admin`,`phone_voicemail:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:voicemail`,`phone:read:voicemail:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/voice_mails/{voicemailId} - Write
Update Voicemail Read Status
Updates the status of [voicemail message](https://support.zoom.us/hc/en-us/articles/360021400211-Managing-voicemail-messages). **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write`,`phone_voicemail:write`,`phone_voicemail:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:voicemail`,`phone:update:voicemail:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /phone/voice_mails/{voicemailId} - Destructive
Delete a voicemail
Deletes an account's [voicemail message](https://support.zoom.us/hc/en-us/articles/360021400211-Managing-voicemail-messages). **Prerequisites:** * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write`,`phone_voicemail:write`,`phone_voicemail:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:voicemail`,`phone:delete:voicemail:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /phone/voice_mails/{voicemailId}
WhatsApp Messages
- Read
Get user's WhatsApp sessions
Returns details about WhatsApp sessions 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. **Prerequisites:** * Paid account * User-enabled Zoom phone **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_whatsapp_sessions`,`phone:read:list_whatsapp_sessions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/users/{userId}/whatsapp/sessions - Read
Get account's WhatsApp sessions
Returns details about WhatsApp sessions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_whatsapp_sessions`,`phone:read:list_whatsapp_sessions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/whatsapp/sessions - Read
Get WhatsApp session details
Returns details about a WhatsApp session. **Prerequisites** * A paid account * Zoom Phone enabled for the account * A Zoom Phone-enabled user with WhatsApp messaging enabled **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:whatsapp_session`,`phone:read:whatsapp_session:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/whatsapp/sessions/{sessionId} - Read
Get WhatsApp message by message ID
Returns details about a specific message in a WhatsApp session. **Prerequisites** * A paid account * Zoom Phone enabled for the account * For Zoom Phone WhatsApp: a Zoom Phone-enabled user **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:whatsapp_message`,`phone:read:whatsapp_message:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/whatsapp/sessions/{sessionId}/messages/{messageId} - Write
Send WhatsApp message
Sends a WhatsApp message through a Zoom Phone WhatsApp Business Account (WABA). The sender phone number must be registered as a Meta WhatsApp Business phone number and linked to a WABA within the Zoom account. **Supported Outbound Message Types** * `text` — Free-text message. Only allowed within a 24-hour session window opened by an inbound message from the recipient. * `template` — Highly Structured Message (HSM) template pre-approved by Meta. Can be sent at any time, including outside the 24-hour window. * `image` / `document` — Rich media messages. Allowed only within the 24-hour session window. Media is delivered inline as base64-encoded content through `attachments`. **24-hour Session Window** WhatsApp enforces a customer-initiated messaging policy. After the recipient sends a message, a 24-hour window opens during which the business can reply with any message type. Once the window expires, only pre-approved `template` messages may be sent. **Prerequisites** * A Zoom Phone license * A WhatsApp Business Account (WABA) connected to the Zoom account * At least one Meta-registered phone number linked to the WABA * For `template` messages: a Meta-approved message template **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:whatsapp_message`,`phone:write:whatsapp_message:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/whatsapp/messages
Zoom Rooms
- Read
List Zoom Rooms under Zoom Phone license
Retrieves a list of [Zoom Rooms](https://support.zoom.us/hc/en-us/articles/360025153711) under the account that has the Zoom Phone license assigned.**Prerequisites:** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_rooms:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /phone/rooms - Read
List Zoom Rooms without Zoom Phone assignment
Returns [Zoom Rooms](https://support.zoom.us/hc/en-us/articles/360025153711) that are not assigned a Zoom Phone.**Prerequisites:** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_rooms:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
GET /phone/rooms/unassigned - Read
Get a Zoom Room under Zoom Phone license
Specifies [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711) in an account with an assigned Zoom Phone license. **Prerequisites** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:room:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /phone/rooms/{roomId} - Read
List Zoom Rooms
Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing. Use this API to list all the existing [Zoom Rooms](https://support.zoom.us/hc/en-us/articles/207483343-Getting-Started-with-Zoom-Rooms) in a Zoom account. **Prerequisites:** * Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:list_rooms:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /rooms - Read
List digital signage contents
Use this API to return information about a Zoom account's [Zoom Rooms digital signage content](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-digital-signage). You can also view this content in the **Room Management** section's [**Digital Signage Content**](https://zoom.us/digitalsignage#/) tab in the Zoom web portal. **Prerequisites:** * A Pro or a higher account with Zoom Rooms. * Existing content in the **Digital Signage Content** tab. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
GET /rooms/digital_signage - Read
Get Zoom Room settings
Get information on meeting, alert, digital signage or scheduling display settings applied to a specific Zoom Room. By default, only **Meeting Settings** are returned. To view only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter. **Prerequisites:** *Zoom Room licenses* Owner or Admin privileges on the Zoom Account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:room_settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /rooms/{id}/settings - Read
Get Zoom Room profile
Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing. Use this API to get detailed information on a specific Zoom Room in a Zoom account. **Prerequisites:** * Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:room:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /rooms/{roomId} - Read
List device profiles
Returns a list of Zoom Room device profiles. **Prerequisites:** * A Pro or a higher account with Zoom Rooms. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:list_device_profiles:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /rooms/{roomId}/device_profiles - Read
Get device information
Returns information about a Zoom Room device. **Prerequisites:** * A Pro or a higher account with Zoom Rooms. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:device_profile:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /rooms/{roomId}/device_profiles/devices - Read
Get a device profile
Returns a Zoom Room device profile. **Prerequisites:** * A Pro or a higher account with Zoom Rooms. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin`,`room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:device_profile:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /rooms/{roomId}/device_profiles/{deviceProfileId} - Read
List Zoom Room devices
List information about the devices that are being used for a specific [Zoom Room](https://support.zoom.us/hc/en-us/articles/207483343-Getting-Started-with-Zoom-Rooms) in an account. **Prerequisites:** * Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license. * Account owner or admin permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:list_devices:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /rooms/{roomId}/devices - Read
Get Zoom Room sensor data
Retrieves the sensor data from the specified Zoom Room. **Prerequisites** * Zoom Room licenses * Owner or Admin privileges on the Zoom Account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:sensor_data:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /rooms/{roomId}/sensor_data - Read
Get Zoom Rooms virtual controller URL
Get the Zoom Rooms virtual controller URL. **Prerequisites:** * Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:virtual_controller:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /rooms/{roomId}/virtual_controller - Write
Add a Zoom Room to a Zoom Phone
Associates a [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711#h_70c74c57-50d6-406b-a4fa-2f33d4bebdbc) with a Zoom Phone license. **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:room:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/rooms - Write
Update a Zoom Room under Zoom Phone license
Use this API to update a [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711) in an account that has the Zoom Phone license assigned. **Prerequisites:** * A Pro or higher account plan * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:room:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
PATCH /phone/rooms/{roomId} - Write
Assign calling plans to a Zoom Room
Assigns [calling plans](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) to a [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711#h_70c74c57-50d6-406b-a4fa-2f33d4bebdbc) with a maximum of 200 numbers at a time. **Prerequisites** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:room_calling_plan:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/rooms/{roomId}/calling_plans - Write
Assign phone numbers to a Zoom Room
[Assigns phone numbers to a Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711). Up to 200 numbers at a time. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:room_phone_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /phone/rooms/{roomId}/phone_numbers - Write
Add a Zoom Room
Use this API to [add a Zoom Room](https://support.zoom.us/hc/en-us/articles/202822279-Add-Zoom-Rooms-on-Web-Portal) to a Zoom account. **Prerequisites:** * Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:room:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /rooms - Write
Apply configuration profile for Zoom Rooms
Apply a configuration profile for Zoom Rooms. **Prerequisites** * Pro or a higher plan with [Zoom Rooms](https://zoom.us/zoomrooms) license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:room_settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
POST /rooms/configuration_profiles/{profileId}/apply - Write
Update E911 digital signage
Display or hide E911 emergency alert text content from [Zoom Rooms digital signage](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-digital-signage). **Prerequisites:** * [Zoom Rooms](https://zoom.us/zoomrooms/software) 5.3.0 or higher * Zoom Rooms digital signage must be [enabled](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-Digital-Signage#h_767fbb33-82a8-45a8-8392-a1bfa9687edd) **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:room_controls:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /rooms/events - Write
Create a device profile
Creates a Zoom Room device profile. **Prerequisites:** * A Pro or a higher account with Zoom Rooms. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:device_profile:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /rooms/{roomId}/device_profiles - Write
Update a device profile
Updates a Zoom Room device profile. **Prerequisites:** * A Pro or a higher account with Zoom Rooms. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:device_profile:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /rooms/{roomId}/device_profiles/{deviceProfileId} - Destructive
Remove a Zoom Room from a ZP account
Use this API to remove [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711#h_140e30ba-5a88-40b9-b799-16883fa0a037) from a Zoom Phone account. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:room:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/rooms/{roomId} - Destructive
Remove a calling plan from a Zoom Room
Use this API to unassign a [calling plan](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) from a [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711#h_140e30ba-5a88-40b9-b799-16883fa0a037). **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:room_calling_plan:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/rooms/{roomId}/calling_plans/{type} - Destructive
Remove a phone number from a Zoom Room
Use this API to unassign a [phone number](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers#h_38ba8b01-26e3-4b1b-a9b5-0717c00a7ca6) from a [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711#h_140e30ba-5a88-40b9-b799-16883fa0a037). **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license * The Zoom Room must have been previously assigned a Zoom Phone number **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:room_phone_number:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
DELETE /phone/rooms/{roomId}/phone_numbers/{phoneNumberId} - Destructive
Use Zoom Room controls
Controls [Zoom Rooms](https://support.zoom.us/hc/en-us/articles/207483343), including: * Room check-in and check-out. * Video and audio mute on and off. * Incoming meeting request accept or decline. * Meeting join, leave, or end. * Room restart. * Cancellation. * Switch between available cameras, speakers or microphones during a meeting. * Start or stop screen sharing. * Perform speaker volume changes during a meeting. **Prerequisites:** * [Zoom Rooms](https://support.zoom.us/hc/en-us/articles/207483343-Getting-started-with-Zoom-Rooms#:~:text=Zoom%20Rooms%20is%20a%20software,or%20from%20their%20mobile%20device) must have been set up for use for the account and must be online. * You must have access to the Calendar Integration APIs (either Microsoft Exchange or Google Calendar APIs) to get calendar information associated with the room. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:room_control:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /rooms/{id}/events - Destructive
Update Zoom Room settings
Update meeting, alert, digital signage or scheduling display settings applied to a specific Zoom Room. To update **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter. To update **Meeting Settings**, specify `meeting` as the value of the `setting_type` query parameter. **Prerequisites:** * Zoom Room licenses.* Owner or Admin privileges on the Zoom Account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:room_settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /rooms/{id}/settings - Destructive
Delete a Zoom Room
[Remove](https://support.zoom.us/hc/en-us/articles/360033432032-Zoom-Room-Device-Profiles#h_e55b2092-c418-4b02-819f-44de51448900) a specific Zoom Room profile from a Zoom account. **Prerequisites:** * Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:delete:room:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /rooms/{roomId} - Destructive
Update a Zoom Room profile
Update basic information on a specific Zoom Room in a Zoom account. **Prerequisites:** * Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:room:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /rooms/{roomId} - Destructive
Delete a device profile
Deletes a Zoom Room device profile. **Prerequisites:** * A Pro or a higher account with Zoom Rooms. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:delete:device_profile:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /rooms/{roomId}/device_profiles/{deviceProfileId} - Destructive
Change a Zoom Room's location
An account owner of a Zoom account can establish a [Zoom Rooms Location Hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) to better organize Zoom Rooms spread across various locations. The location can be structured in a hierarchy with Country being the top-level location, followed by city, campus, building, and floor. Use this API to assign a new location for a Zoom Room. Note that the Zoom Room can be assigned only to the lowest level location available in the hierarchy. **Prerequisite:** * Account owner or admin permission * Zoom Rooms version 4.0 or higher **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:room_location:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /rooms/{roomId}/location
Video SDK Sessions
- Read
List session users QoS Summary
Use this API to return a list of users from past sessions and a summary of their quality of service received during the session. The data returned indicates the connection quality for sending and receiving video, audio, and shared content. **Note:** This API may return empty values for users' `name` responses when the account calling this API: * Does **not** have a signed HIPAA business associate agreement (BAA). * Is a [**legacy** HIPAA BAA account](https://developers.zoom.us/docs/api/rest/other-references/legacy-business-associate-agreements/). * Displays data for any users who are **not** part of the host's account (external users) unless they meet certain conditions. **Prerequisites:** * A Business or higher plan. * Developers must subscribe to the QSS summary event to receive data from this API. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `qss:read:session_users_summary:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /videosdk/sessions/{sessionId}/users/qos_summary
Calibrations
- Read
List calibrations
List calibration tasks in Quality Management performance management. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `qm_calibrations:read:admin`,`qm_calibrations:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_quality_management:read:calibrations`,`zoom_quality_management:read:calibrations:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /qm/calibrations - Read
Get calibration detail
Retrieve one calibration record, including participants, aggregate scoring, and per-evaluator submission status. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `qm_calibrations:read`,`qm_calibrations:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_quality_management:read:calibrations`,`zoom_quality_management:read:calibrations:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /qm/calibrations/{calibrationId}
Cases
- Read
List cases
Returns cases visible to the authenticated caller. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `qm_cases:read`,`qm_cases:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_quality_management:read:cases`,`zoom_quality_management:read:cases:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /qm/cases - Read
Get case details
Returns the base case plus default AI summary, AI sentiment, and performance information. Activities, interactions, and activity level sentiment are opt-in includes. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `qm_cases:read`,`qm_cases:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_quality_management:read:cases`,`zoom_quality_management:read:cases:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /qm/cases/{qmCaseId}
Evaluations
- Read
List automated evaluations
List automated evaluations. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `qm_evaluations:read:admin`,`qm_evaluations:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_quality_management:read:evaluations:admin`,`zoom_quality_management:read:evaluations` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /qm/automated_evaluations - Read
List evaluations
List manually completed evaluations. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `qm_evaluations:read:admin`,`qm_evaluations:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_quality_management:read:evaluations`,`zoom_quality_management:read:evaluations:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /qm/evaluation - Read
View evaluation detail
View a specific interaction's evaluation detail. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `qm_evaluations:read`,`qm_evaluations:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_quality_management:read:evaluations`,`zoom_quality_management:read:evaluations:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /qm/evaluation/{evaluationId}
Interactions
- Read
List interactions
List interactions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `qm_interactions:read`,`qm_interactions:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_quality_management:read:interactions`,`zoom_quality_management:read:interactions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /qm/interactions - Read
View interaction detail
View the details of a specific interaction. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `qm_interactions:read:admin`,`qm_interactions:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_quality_management:read:interactions`,`zoom_quality_management:read:interactions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /qm/interactions/{interactionId} - Write
Add an interaction
Add an interaction by a third party download URL. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `qm_interactions:write:admin`,`qm_interactions:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_quality_management:write:interactions`,`zoom_quality_management:write:interactions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `1`
POST /qm/interactions
Room Apps
- Write
Config Zoom Room Controller Apps
Use this API to configure Zoom Room Controller installed Zoom Apps. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin`,`room:master` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:zoom_apps:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /rooms/controller/apps/config
Visitor Management
- Read
Get a list of visitors by location
List the invitations under a Zoom user account. Visitor management is a software system used to manage the lifecycle of visitors. **Prerequisite:** * Users need to be assigned a visitor management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `visitor_management:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `visitor_management:read:list_invitations`,`visitor_management:read:list_invitations:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /visitor/invitation - Read
Invitation details by invitationID
Visitor management is a software system used to manage the lifecycle of visitors. Inviter use this API to get the invitation details. **Prerequisite:** * Users need to be assigned a visitor management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `visitor_management:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `visitor_management:read:invitation_details`,`visitor_management:read:invitation_details:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /visitor/invitation/{invitationId} - Write
Send an invitation
Send a invitation to a visitor. Visitor management is a software system used to manage the visitors' lifecycle. **Prerequisite:** * Users need to be assigned a visitor management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `visitor_management:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `visitor_management:write:invitation`,`visitor_management:write:invitation:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /visitor/invitation - Write
Update an invitation
Update a invitation. Visitor management is a software system used to manage the visitors' lifecycle. **Prerequisite:** * Users need to be assigned a visitor management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `visitor_management:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `visitor_management:update:invitation`,`visitor_management:update:invitation:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /visitor/invitation/{invitationId} - Write
Check in a visitor
Check in an invitation. **Prerequisite:** * Users need to be assigned a visitor management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `visitor_management:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `visitor_management:write:check_in`,`visitor_management:write:check_in:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /visitor/invitation/{invitationId}/checkin - Destructive
Delete an Invitation
Visitor management is a software system used to manage the lifecycle of visitors. Inviter use this API to cancel or delete an invitation. **Prerequisite:** * Users need to be assigned a visitor management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `visitor_management:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `visitor_management:delete:invitation`,`visitor_management:delete:invitation:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /visitor/invitation/{invitationId}
Workspaces
- Read
List workspaces
List a location's workspaces. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read`,`workspace:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:list_workspaces`,`workspace:read:list_workspaces:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /workspaces - Read
List workspace additional information with time range
List a location's workspaces' additional information within a specified time range. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:admin`,`workspace:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:list_workspaces`,`workspace:read:list_workspaces:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /workspaces/additional_informations - Read
Get all workspace assets
List all workspace assets. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:asset:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /workspaces/assets - Read
Get a workspace asset
Create a workspace asset based on the asset ID. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:asset:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /workspaces/assets/{assetId} - Read
Get a floor's reservations
Retrieves a floor's reservations. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:admin`,`workspace:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:list_floor_workspace_reservations:admin`,`workspace:read:list_floor_workspace_reservations:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /workspaces/floors/{floorId}/reservations - Read
Get a workspace location floor map
Get a location's floor map. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read`,`workspace:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:location`,`workspace:read:location:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /workspaces/locations/{locationId}/floor_map - Read
List neighborhoods
List a floor's neighborhoods with optional neighborhood, workspace, user, or group filters. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:neighborhood:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /workspaces/locations/{locationId}/neighborhoods - Read
Get a neighborhood
Get a neighborhood by ID. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:neighborhood:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /workspaces/locations/{locationId}/neighborhoods/{neighborhoodId} - Read
Get questionnaire answer summary
Retrieves a summary of questionnaire answers for specified locations within a date range. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:workspace_reservation_questionnaire_response:admin`,`workspace:read:workspace_reservation_questionnaire_response:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /workspaces/questionnaires_summary - Read
List released workspaces by timeout
Lists workspaces that were released due to missing check-in or checkout information. The maximum query time interval is one month. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:admin`,`room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:list_release_infos:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /workspaces/released_workspaces_by_timeout - Read
List workspace reservations by locations
List workspace reservations by location. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read`,`workspace:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:list_reservations:admin`,`workspace:read:list_reservations:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /workspaces/reservations - Read
Get a location's hot desk usage
Creates a location's [hot desk](https://en.wikipedia.org/wiki/Hot_desking) usage information. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:admin`,`workspace:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:usage`,`workspace:read:usage:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /workspaces/usage - Read
Get Workspace Calendar Free/Busy Event
List workspace calendar free or busy event settings. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:workspace:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /workspaces/users/{userId}/calendar/settings - Read
Get a user's workspace's reservations
Retrieves a user's workspace's reservations. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:list_reservations:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /workspaces/users/{userId}/reservations - Read
Get a workspace
Creates workspace detail. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:list_workspaces`,`workspace:read:list_workspaces:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /workspaces/{workspaceId} - Read
Get a desk assignment
Get a desk assignment. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:admin`,`workspace:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:assignment`,`workspace:read:assignment:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /workspaces/{workspaceId}/assignment - Read
Get a workspace QR code
Use this API to get the workspace QR code. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:qr:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /workspaces/{workspaceId}/qr_code - Read
Get a workspace's reservations
Retrieves a workspace's reservations. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:admin`,`workspace:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:list_reservations`,`workspace:read:list_reservations:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /workspaces/{workspaceId}/reservations - Read
Get a workspace reservation by reservationId
Retrieves a workspace reservation ID. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read`,`workspace:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:reservation`,`workspace:read:reservation:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /workspaces/{workspaceId}/reservations/{reservationId} - Read
List workspace reservation questionnaires
List workspace reservation questionnaires. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:reservation:admin`,`workspace:read:reservation:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /workspaces/{workspaceId}/reservations/{reservationId}/questionnaires - Read
Get workspace settings
Get workspace settings. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read`,`workspace:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:read:settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /workspaces/{workspaceId}/settings - Write
Create a workspace
Creates a new workspace. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write:workspace:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /workspaces - Write
Create a workspace asset
Create a new workspace asset. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write:asset:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /workspaces/assets - Write
Edit a workspace asset
Edit the workspace's asset based on asset ID. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:update:asset:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /workspaces/assets/{assetId} - Write
Check in/out of a reservation
Use this API to check in to or out of a reservation. This API does not support Zoom Room Desk and Common Area Phone Desk. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write:events`,`workspace:write:events:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /workspaces/events - Write
Add or Update a Workspace floor map
Use this API to Add or Update a Workspace floor map. **Prerequisite:** The caller must be a Zoom Workspace licensed user **Note:** Base URL: `https://fileapi.zoom.us/v2/` * Rate limit: 20 requests per second per user or 2000 requests per second per IP address * The caller must support HTTP 30x redirects * The caller must retain the Authorization header when redirected to a different hostname * JPG/JPEG, 24-bit PNG, PDF * Recommended dimensions - 1920 x 1080 (landscape) for 16:9 aspect ratio displays * Maximum dimensions - 6000 x 4000 (landscape) * Your object size should no more than 10M **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write:location`,`workspace:write:location:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
POST /workspaces/floormap/files - Write
Update workspace settings
Updates workspace settings. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write`,`workspace:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:update:setting:admin`,`workspace:update:setting:master` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /workspaces/settings - Write
Add a workspace photo
Use this API to add a workspace photo. **Note:** * Please use `https://fileapi.zoom.us` instead of `https://api.zoom.us`, the full path is `https://fileapi.zoom.us/v2/workspaces/settings/photos`. * Supported file formats: "PNG", "JPG", "JPEG", "GIF". * The maximum size of file is 15MB. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write:workspace:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
POST /workspaces/settings/photos - Write
Set Workspace Calendar Free/Busy Event
Set calendar free or busy event. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write:workspace:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /workspaces/users/{userId}/calendar/settings - Write
Create a reservation
Creates a workspace reservation. When creating a linked Zoom **meeting**, include the `meeting` object. To schedule a **new** meeting using the host's **Personal Meeting ID (PMI)**, set `meeting.use_pmi` to `true`. Do not set `use_pmi` when selecting an existing meeting via `meeting.meeting_uuid`. PMI may be restricted by account settings. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write`,`workspace:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write:reservation`,`workspace:write:reservation:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /workspaces/{workspaceId}/reservations - Write
Update a reservation
Updates a reservation. This API supports maintaining workspace reservation event of the next `6` months. The `start_time` and `end_time` time range of a single workspace reservation event can be a minimum of `15` minutes and a maximum of `24` hours. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write`,`workspace:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:update:reservation`,`workspace:update:reservation:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /workspaces/{workspaceId}/reservations/{reservationId} - Destructive
Delete a workspace asset
Delete a workspace asset by asset ID. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:delete:asset:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /workspaces/assets/{assetId} - Destructive
Delete neighborhoods
Delete one or more neighborhoods from a floor. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:delete:neighborhood:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /workspaces/locations/{locationId}/neighborhoods - Destructive
Delete workspace photos
Deletes workspace photos. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:delete:photo:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
DELETE /workspaces/settings/photos - Destructive
Delete Workspace floor map
Use this API to delete a workspace floor map. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write:location`,`workspace:write:location:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
DELETE /workspaces/{locationId}/background - Destructive
Delete a workspace
Deletes workspace detail. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:delete:workspace:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /workspaces/{workspaceId} - Destructive
Update a workspace
Updates workspace details. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:update:workspace:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /workspaces/{workspaceId} - Destructive
Set a desk assignment
Set a desk assignment. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write:assignment:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /workspaces/{workspaceId}/assignment - Destructive
Delete a desk assignment
Deletes a desk assignment. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:delete:assignment:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /workspaces/{workspaceId}/assignment - Destructive
Delete a reservation
Deletes a reservation. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:write`,`workspace:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workspace:delete:reservation`,`workspace:delete:reservation:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /workspaces/{workspaceId}/reservations/{reservationId}
Zoom Rooms Account
- Read
Get Zoom Room account profile
Get details on the account profile of a Zoom Room. This information can only by accessed either by the Zoom Room Account Owner or a user with Zoom Rooms admin permission. To get information on an individual room profile, use the [**Get Zoom Room profile**](/docs/api-reference/zoom-api/methods#operation/getZRProfile) API. **Prerequisites:** * Zoom account owner or Zoom Rooms admin permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:account_profile:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /rooms/account_profile - Read
Get Zoom Room account settings
Get details on Account Settings of a Zoom Room. With this API, you can view the **Account Meeting Settings**, **Alert Settings** (Client Alert Settings and Notification Settings), **Digital Signage Settings** or **Scheduling Display Settings** of the Zoom Rooms account. By default, only **Account Meeting Settings** are returned. To view only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter. **Prerequisites:** * Zoom Room licenses. * Owner or Admin privileges on the Zoom Account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:account_settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /rooms/account_settings - Write
Update Zoom Room account profile
Update information on the account profile of a Zoom Room. This information can only by accessed either by the Zoom Room Account Owner or a user with Zoom Rooms admin permission. To update information on an individual room profile, use the [**Update a Zoom Room profile**](/docs/api-reference/zoom-api/methods#operation/updateRoomProfile) API. **Prerequisites:** * Zoom account owner or Zoom Rooms admin permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:account_profile:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /rooms/account_profile - Destructive
Update Zoom Room account settings
Update account settings applied for Zoom Rooms in a Zoom account. With this API, you can update the **Account Meeting Settings**, **Alert Settings** (Client Alert Settings and Notification Settings), **Digital Signage Settings** or **Scheduling Display Settings** of the Zoom Rooms account by specifying the required setting type in the `setting_type` parameter. To update only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter and to update only **Account Meeting Settings**, specify `meeting` as the value of the `setting_type` query parameter. **Prerequisites:** * Zoom Room licenses * Owner or Admin privileges on the Zoom Account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:account_settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /rooms/account_settings
Zoom Rooms Calendar
- Read
List calendar services
List all the existing [calendar services](https://support.zoom.us/hc/en-us/articles/4409832833037) in a Zoom Room account. **Prerequisites:** * A Pro or a higher plan with a [Zoom Rooms](https://zoom.us/zoomrooms) license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:list_calendar_services:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /rooms/calendar/services - Read
List calendar resources by calendar service
List all of a Zoom Room account's [calendar resources](https://support.zoom.us/hc/en-us/articles/4409832833037). **Prerequisites:** * A Pro or a higher plan with a [Zoom Rooms](https://zoom.us/zoomrooms) license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:list_calendar_resources:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /rooms/calendar/services/{serviceId}/resources - Read
Get a calendar resource by ID
List Zoom Room account's [calendar resource](https://support.zoom.us/hc/en-us/articles/4409832833037). **Prerequisites:** * A Pro or a higher plan with a [Zoom Rooms](https://zoom.us/zoomrooms) license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:calendar_resource:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /rooms/calendar/services/{serviceId}/resources/{resourceId} - Write
Add a calendar resource to a calendar service
Use this API to add a [calendar resource](https://support.zoom.us/hc/en-us/articles/4409832833037) to a Microsoft Exchange or Office 365 calendar service in a Zoom Room account. **Note:** This API does not support adding a calendar resource to a Google calendar service. **Prerequisites:** * A Pro or a higher plan with a [Zoom Rooms](https://zoom.us/zoomrooms) license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:calendar_resource:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /rooms/calendar/services/{serviceId}/resources - Destructive
Delete a calendar service
Deletes a Zoom Room account's calendar service. **Prerequisites:** * A Pro or a higher plan with a [Zoom Rooms](https://zoom.us/zoomrooms) license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:delete:calendar_service:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /rooms/calendar/services/{serviceId} - Destructive
Delete a calendar resource
Deletes a Zoom Room account's [calendar resource](https://support.zoom.us/hc/en-us/articles/4409832833037) from a Microsoft Exchange or Office 365 calendar service. **Note:** This API does not support deleting a calendar resource from a Google calendar service. **Prerequisites:** * A Pro or a higher plan with a [Zoom Rooms](https://zoom.us/zoomrooms) license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:delete:calendar_resource:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /rooms/calendar/services/{serviceId}/resources/{resourceId} - Destructive
Start calendar service sync process
Use this API to kick off the sync process for Zoom Room account's calendar service. **Prerequisites:** * A Pro or a higher plan with a [Zoom Rooms](https://zoom.us/zoomrooms) license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:calendar_service:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PUT /rooms/calendar/services/{serviceId}/sync
Zoom Rooms Content
- Read
List Zoom Rooms background image library contents
Returns a list of Zoom Rooms background image library contents. Maximum number per page 200. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:background_library_content:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /rooms/content/background/contents - Read
Get Zoom Rooms background image library content
Return a Zoom Rooms background image library content item. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:background_library_content:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /rooms/content/background/contents/{contentId} - Read
List default Zoom Rooms background image library contents
Display a list of Zoom-provided default background images from the background image library. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:background_library_content:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /rooms/content/background/defaults - Read
List Zoom Rooms Background Image Library Folders
Returns a list of Zoom Rooms background image library content folders. Maximum number per page 200. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:background_library_folder:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /rooms/content/background/folders - Read
Get Zoom Rooms Background Image Library Folder
Returns a Zoom Rooms background image library folder. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:background_library_folder:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /rooms/content/background/folders/{folderId} - Read
List Digital Signage content items
Returns a list of Zoom Rooms digital signage library base folder content items. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:digital_signage_library_contents:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /rooms/content/digital_signage/contents - Read
Get Digital Signage content item
Use this API to get the details of an individual digital signage content item. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:digital_signage_library_contents:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /rooms/content/digital_signage/contents/{contentId} - Read
Get Digital Signage content folder
Use this API to get the details of an individual digital signage content folder. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:master` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:digital_signage_library_contents:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /rooms/content/digital_signage/folders/{folderId} - Read
List Digital Signage library playlists
Returns a list of Zoom Rooms content library digital signage playlists. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:digital_signage_library_playlists:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /rooms/content/digital_signage/playlists - Read
Get Digital Signage library playlist
Returns a Zoom Rooms content library digital signage playlist. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:digital_signage_library_playlists:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /rooms/content/digital_signage/playlists/{playlistId} - Read
Get Digital Signage library playlist content items
Returns a Zoom Rooms content library digital signage playlist content items and their metadata. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:digital_signage_library_playlists:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /rooms/content/digital_signage/playlists/{playlistId}/contents - Read
List Digital Signage library playlist published rooms
List Digital Signage library playlist published rooms. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:digital_signage_library_playlists:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /rooms/content/digital_signage/playlists/{playlistId}/rooms - Write
Add Zoom Rooms Background Image Library Folder
Use this API to add a Zoom Rooms background image library content folder. You may create up to 20 folders, maximum. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:background_library_folder:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /rooms/content/background/folders - Write
Update Zoom Rooms Background Image Library Folder
Updates a Zoom Rooms background image library content folder. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:background_library_folder:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /rooms/content/background/folders/{folderId} - Write
Add a digital signage URL
Use this API to add a URL to the Zoom Rooms digital signage content library. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:digital_signage_library_contents:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /rooms/content/digital_signage/contents - Write
Add a digital signage content folder
Use this API to add a Digital Signage Content folder. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:digital_signage_library_contents:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /rooms/content/digital_signage/folders - Write
Update a digital signage content folder
Updates a Digital Signage content folder’s attributes. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:digital_signage_library_contents:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /rooms/content/digital_signage/folders/{folderId} - Write
Add a Digital Signage library playlist
Use this API to add a content library Digital Signage Playlist. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:digital_signage_library_playlists:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /rooms/content/digital_signage/playlists - Write
Update a Digital Signage library playlist
Updates a Zoom Rooms content library digital signage playlist. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:digital_signage_library_playlists:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /rooms/content/digital_signage/playlists/{playlistId} - Write
Add Zoom Rooms background image library content
Upload an image to Zoom Room Content Library. **Prerequisite:** The caller must be a Zoom Room licensed user. **Note:** * Base URL: `https://fileapi.zoom.us/v2/`. * Rate limit: 20 requests per second per user or 2000 requests per second per IP address. * The caller must support HTTP 30x redirects. * The caller must retain the Authorization header when redirected to a different hostname. * JPG/JPEG, 24-bit PNG (no alpha) or GIF (ZR Appliance only) * Recommended dimensions - 1920 x 1080 (landscape) or 1080 x 1920 (portrait) for 16:9 aspect ratio displays * Maximum dimensions - 5120 x 2160 (landscape) or 2160 x 5120 (portrait) * Your object size should no more than 10 M * For an **account-level** [OAuth app](https://developers.zoom.us/docs/integrations/create/), this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.) with **Edit** permission for **Zoom Rooms**. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:background_library_content:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /zrbackground/files - Write
Add a digital signage image or video
Upload an image or video to the Zoom Rooms Digital Signage Content Library. **Note**: * Base URL: https://fileapi.zoom.us/v2/ **Rate limit**: 20 requests per second per user or 2000 requests per second per IP address. The caller must support HTTP 30x redirects. The caller must retain the Authorization header when redirected to a different hostname. JPG/JPEG, 24-bit PNG (no alpha) or GIF (ZR Appliance only) **Recommended dimensions**: - 1920 x 1080 (landscape) or 1080 x 1920 (portrait) for 16:9 aspect ratio displays. Maximum dimensions - 5120 x 2160 (landscape) or 2160 x 5120 (portrait) Your object size should no more than 10 M. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:digital_signage_library_contents:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /zrdigitalsignage/files - Destructive
Delete Zoom Rooms Background Image Library Content
Deletes a Zoom Rooms background image library content item. Warning: the image will be deleted, and Zoom Rooms using the image will revert to the default background image. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:delete:background_library_content:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /rooms/content/background/contents/{contentId} - Destructive
Delete Zoom Rooms Background Image Library Folder
Deletes a Zoom Rooms background image library content folder. Warning: all images in the folder will be deleted, and Zoom Rooms using those images will revert to the default background image. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:delete:background_library_folder:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /rooms/content/background/folders/{folderId} - Destructive
Delete a Digital Signage content item
Use this API to delete an individual digital signage content item. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin`,`room:write:master` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:digital_signage_library_contents:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /rooms/content/digital_signage/contents/{contentId} - Destructive
Update a Digital Signage content item attributes
Use this API to update a digital signage content item's attributes. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:digital_signage_library_contents:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /rooms/content/digital_signage/contents/{contentId} - Destructive
Delete a Digital Signage content folder
Use this API to delete an individual digital signage content folder. **Note**: All digital signage content items in this folder will also be deleted. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:master` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:digital_signage_library_contents:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /rooms/content/digital_signage/folders/{folderId} - Destructive
Delete Digital Signage library playlist
Delete digital signage library playlist. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:digital_signage_library_playlists:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /rooms/content/digital_signage/playlists/{playlistId} - Destructive
Update Digital Signage library playlist content items
Updates a Zoom Rooms content library digital signage playlist content items and their metadata. This API replaces the entire playlist. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:digital_signage_library_playlists:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /rooms/content/digital_signage/playlists/{playlistId}/contents - Destructive
Update Digital Signage library playlist published rooms
Update Digital Signage library playlist published rooms. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:digital_signage_library_playlists:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /rooms/content/digital_signage/playlists/{playlistId}/rooms - Destructive
Update Zoom Rooms background image library content
Update a Zoom Rooms background image library content. **Prerequisite:** The caller must be a Zoom Rooms licensed user. **Note:** * Base URL - `https://fileapi.zoom.us/v2/`. * Rate limit - 20 requests per second per user or 2000 requests per second per IP address. * The caller must support HTTP 30x redirects. * The caller must retain the Authorization header when redirected to a different hostname. * JPG/JPEG, 24-bit PNG (no alpha) or GIF (ZR Appliance only)* Recommended dimensions - 1920 x 1080 (landscape) or 1080 x 1920 (portrait) for 16:9 aspect ratio displays* Maximum dimensions - 5120 x 2160 (landscape) or 2160 x 5120 (portrait)* For an **account-level** [OAuth app](https://developers.zoom.us/docs/integrations/create/), this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.) with **Edit** permission for **Zoom Rooms**. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:background_library_content:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PUT /zrbackground/files - Destructive
Update a Digital Signage image or video file
Update an image or video content item in the Zoom Rooms digital signage content library. **Note**: * Base URL: https://fileapi.zoom.us/v2/. **Rate limit**: 20 requests per second per user or 2000 requests per second per IP address. The caller must support HTTP 30x redirects. The caller must retain the Authorization header when redirected to a different hostname. JPG/JPEG, 24-bit PNG (no alpha) or GIF (ZR Appliance only). **Recommended dimensions** - 1920 x 1080 (landscape) or 1080 x 1920 (portrait) for 16:9 aspect ratio displays Maximum dimensions - 5120 x 2160 (landscape) or 2160 x 5120 (portrait) Your object size should no more than 10 M. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:digital_signage_library_contents:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /zrdigitalsignage/files
Zoom Rooms Devices
- Destructive
Delete a Zoom Room user device
Deletes a Zoom Room device. **Prerequisites:** * Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license. * Account owner or admin permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:delete:device:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /rooms/{roomId}/devices/{deviceId} - Destructive
Change Zoom Rooms app version
Use this API to [upgrade or downgrade](https://support.zoom.us/hc/en-us/articles/204675449-Upgrade-or-Downgrade-Zoom-Rooms-Software) the version of your installed Zoom Rooms app on your Mac or Windows device. **Prerequisites:** * A Pro or a higher account with Zoom Rooms. * The Zoom Rooms software must be installed on a Mac or a Windows device. This API does not support other devices. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:device_app_version:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PUT /rooms/{roomId}/devices/{deviceId}/app_version
Zoom Rooms Location
- Read
List Zoom Room locations
A Zoom account owner or a Zoom Room administrator can establish a [location hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) to help manage Zoom Rooms that are spread among a variety of locations. Use this API to list the different location types used for Zoom Rooms in an account. **Prerequisites:** * Account owner or admin permissions. * Zoom Rooms Version 4.0 or higher **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:list_locations:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /rooms/locations - Read
Get Zoom Room location structure
Get the [location hierarchial structure(s)](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) applied on the Zoom Rooms in an account. **Prerequisites:** * Zoom Rooms version 4.0 or higher. * Account owner or admin permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:location_hierarchy:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /rooms/locations/structure - Read
Get Zoom Room location profile
Each location type of the [Zoom Rooms location hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) has a profile page with information such as the location name, address, support email, and more. Use this API to retrieve information about a specific Zoom Rooms location type, such as the city location of the Zoom Rooms. **Prerequisite:** * Account owner or admin permission. * Zoom Rooms version 4.0 or higher. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:location:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /rooms/locations/{locationId} - Read
Get location settings
Get information on meeting, alert, digital signage or scheduling display settings applied to Zoom Rooms located in a specific location. By default, only **Meeting Settings** are returned. To view only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter. **Prerequisites:** * Zoom Room licenses* Owner or Admin privileges on the Zoom Account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:location_settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /rooms/locations/{locationId}/settings - Write
Add a location
Add a location to the [location hierarchial structure(s)](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) of Zoom Rooms in an account. **Prerequisites:** * Account owner or admin permissions. * Zoom Rooms Version 4.0 or higher **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:location:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /rooms/locations - Write
Update Zoom Room location profile
Each location type of the [Zoom Rooms location hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) has a profile page that includes information such as name of the location, address, support email, etc. Use this API to update information about a specific Zoom Rooms location type such as information about the city where the Zoom Rooms is located. **Prerequisite:** * Account owner or admin permission. * Zoom Rooms version 4.0 or higher. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:location:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /rooms/locations/{locationId} - Destructive
Update Zoom Rooms location structure
Update the [location hierarchial structure(s)](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) applied on the Zoom Rooms in an account. **Prerequisites:** * Zoom Rooms version 4.0 or higher * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:location_hierarchy:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PUT /rooms/locations/structure - Destructive
Delete a location
Remove a location from the [location hierarchial structure(s)](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) of Zoom Rooms in an account. **Prerequisites:** * Account owner or admin permissions. * Zoom Rooms Version 4.0 or higher **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:location:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /rooms/locations/{locationId} - Destructive
Change the assigned parent location
An account owner of a Zoom account can establish a [Zoom Rooms Location Hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) to better organize Zoom Rooms spread across various locations. The location can be structured in a hierarchy with Country being the top-level location, followed by city, campus, building, and floor. The location in the lower level in the hierarchy is considered as a child of the location that is a level above in the hierarchy. Use this API to change the parent location of a child location. For instance, if the location hierarchy is structured in a way where there are two campuses (Campus 1, and Campus 2) in a City and Campus 1 consists of a building named Building 1 with a floor where Zoom Rooms are located, and you would like to rearrange the structure so that Building 1 along with its child locations (floor and Zoom Rooms) are relocated directly under Campus 2 instead of Campus 1, you must provide the location ID of Building 1 in the path parameter of this request and the location ID of Campus 2 as the value of `parent_location_id` in the request body. **Prerequisite:** * Account owner or admin permission * Zoom Rooms version 4.0 or higher **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:location:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PUT /rooms/locations/{locationId}/location - Destructive
Update location settings
Update meeting, alert, digital signage or scheduling display settings applied to Zoom Rooms located in a specific location. To update **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter. Similarly, to update **Meeting Settings**, specify `meeting` as the value of the `setting_type` query parameter. **Prerequisites:** * Zoom Room licenses* Owner or Admin privileges on the Zoom Account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:location_settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /rooms/locations/{locationId}/settings
Zoom Rooms Tags
- Read
List all Zoom Room Tags
List all Zoom Rooms Tags **Prerequisites:** * A Pro or a higher plan with a [Zoom Rooms](https://zoom.us/zoomrooms) license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:list_tags:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /rooms/tags - Write
Assign Tags to Zoom Rooms By Location ID
Use this API to assign Tags to Zoom Rooms by location ID **Prerequisites:** * A Pro or a higher plan with a [Zoom Rooms](https://zoom.us/zoomrooms) license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:room_tag:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /rooms/locations/{locationId}/tags - Write
Create a new Zoom Rooms Tag
Creates a new Zoom Rooms Tag. **Prerequisites:** * A Pro or a higher plan with a [Zoom Rooms](https://zoom.us/zoomrooms) license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:tag:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /rooms/tags - Write
Edit Tag
Edits Tag. **Prerequisites:** * A Pro or a higher plan with a [Zoom Rooms](https://zoom.us/zoomrooms) license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:tag:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /rooms/tags/{tagId} - Write
Assign Tags to a Zoom Room
Use this API to assign Tags to a Zoom Room **Prerequisites:** * A Pro or a higher plan with a [Zoom Rooms](https://zoom.us/zoomrooms) license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:room_tag:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PATCH /rooms/{roomId}/tags - Destructive
Delete Tag
Deletes Tag. **Prerequisites:** * A Pro or a higher plan with a [Zoom Rooms](https://zoom.us/zoomrooms) license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:delete:tag:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /rooms/tags/{tagId} - Destructive
Un-assign Tags from a Zoom Room
Un-assign Tags from a Zoom Room **Prerequisites:** * A Pro or a higher plan with a [Zoom Rooms](https://zoom.us/zoomrooms) license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:delete:room_tag:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /rooms/{roomId}/tags
Routing Forms
- Read
get routing response
Returns the response submitted for a routing form. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read`,`scheduler:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:routing`,`scheduler:read:routing:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /scheduler/routing/forms/{formId}/response/{responseId} - Read
list account routing response
Returns a list of routing responses across all routing forms under the account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read`,`scheduler:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:routing`,`scheduler:read:routing:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /scheduler/routing/responses
analytics
- Read
Report analytics
Generates the scheduler analytics report. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read`,`scheduler:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:analytics`,`scheduler:read:analytics:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /scheduler/analytics
availability
- Read
List availability
Returns the availability schedules of the given user. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:admin`,`scheduler:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:list_availability`,`scheduler:read:list_availability:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /scheduler/availability - Read
Get availability
Returns the availability schedule of the given UUID. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:admin`,`scheduler:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:availability`,`scheduler:read:availability:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /scheduler/availability/{availabilityId} - Write
Insert availability
Inserts a user availability schedule. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:admin`,`scheduler:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:availability`,`scheduler:write:availability:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /scheduler/availability - Write
Patch availability
Adjusts the availability schedule content of the given UUID. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:admin`,`scheduler:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:update:availability`,`scheduler:update:availability:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /scheduler/availability/{availabilityId} - Destructive
Delete availability
Removes a user's availability. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:admin`,`scheduler:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:delete:availability`,`scheduler:delete:availability:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /scheduler/availability/{availabilityId}
scheduled events
- Read
List scheduled events
Returns a list of all scheduled events. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:admin`,`scheduler:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:list_scheduled_events`,`scheduler:read:list_scheduled_events:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /scheduler/events - Read
Get scheduled events
Returns a scheduled event. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:admin`,`scheduler:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:scheduled_event`,`scheduler:read:scheduled_event:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /scheduler/events/{eventId} - Read
Get scheduled event attendee
Returns information about a specified attendee (person invited to an event). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read`,`scheduler:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:scheduled_event_attendee`,`scheduler:read:scheduled_event_attendee:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /scheduler/events/{eventId}/attendees/{attendeeId} - Write
Create a booking for a schedule slot
Books a time slot on an existing schedule in Zoom Scheduler. This endpoint creates a new booking, attendee, or event by specifying the schedule, start time, duration, booker information, and optional guests or custom field responses. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:admin`,`scheduler:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:scheduled_event`,`scheduler:write:scheduled_event:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /scheduler/attendee - Destructive
Delete scheduled events
Deletes a scheduled event. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:admin`,`scheduler:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:delete:scheduled_event`,`scheduler:delete:scheduled_event:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /scheduler/events/{eventId} - Destructive
Patch scheduled events
Patches a scheduled event. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:admin`,`scheduler:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:update:scheduled_event`,`scheduler:update:scheduled_event:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /scheduler/events/{eventId}
schedules
- Read
List schedules
Returns a list of all schedules. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:admin`,`scheduler:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:list_schedule`,`scheduler:read:list_schedule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /scheduler/schedules - Read
Get schedules
Returns a schedule. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:admin`,`scheduler:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:get_schedule`,`scheduler:read:get_schedule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /scheduler/schedules/{scheduleId} - Read
List schedule available times
Returns available time slots for a given schedule, including day-level and spot-level availability, custom fields, recurrence rules, and scheduling segments. Use this to find bookable time slots before creating a scheduled event. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:admin`,`scheduler:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:get_schedule`,`scheduler:read:get_schedule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /scheduler/schedules/{scheduleId}/available_times - Write
Insert schedules
Creates a schedule. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:admin`,`scheduler:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:insert_schedule`,`scheduler:write:insert_schedule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /scheduler/schedules - Destructive
Delete schedules
Deletes a schedule. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:admin`,`scheduler:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:delete:delete_schedule`,`scheduler:delete:delete_schedule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /scheduler/schedules/{scheduleId} - Destructive
Patch schedules
Patches a schedule. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:admin`,`scheduler:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:update:patch_schedule`,`scheduler:update:patch_schedule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /scheduler/schedules/{scheduleId}
scheduling links
- Write
Single use link
Creates a single-use scheduling link. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:admin`,`scheduler:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:single_use_link`,`scheduler:write:single_use_link:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /scheduler/schedules/single_use_link
shares
team
- Read
List team
Lists teams for the specified user, or for the current user. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read`,`scheduler:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:get_schedule`,`scheduler:read:get_schedule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /scheduler/teams
users
- Read
Get user
Returns information about the user. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:admin`,`scheduler:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:user`,`scheduler:read:user:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /scheduler/users/{userId}
Assignee
- Read
Get assignees of a task
Retrieves the list of assignees of a specified task. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks_assignee:read:admin`,`tasks_assignee:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks:read:assignees`,`tasks:read:assignees:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /tasks/items/{taskId}/assignees - Write
Add assignees to a task
Add one or more assignees to a specified task. If a user is an assignee, they are also considered a collaborator. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks_assignee:write`,`tasks_assignee:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks:write:assignees`,`tasks:write:assignees:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /tasks/items/{taskId}/assignees - Destructive
Remove Assignee from task
Removes a specific assignee from a task. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks_assignee:write`,`tasks_assignee:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks:delete:assignees`,`tasks:delete:assignees:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /tasks/items/{taskId}/assignees/{userId}
File
- Read
Download Imported Whiteboard File
Download files imported into the whiteboard, including images, PDFs, DOCX, and other supported formats. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_file:read`,`whiteboard_file:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:file`,`whiteboard:read:file:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /whiteboards/{whiteboardId}/files/{fileId} - Write
Upload a file in tasks
Uploads a file to tasks. **Notes** - Base URL - `https://fileapi.zoom.us/v2`. - Rate limit: 20 requests per second per user or 2000 requests per second per IP address. - The caller must support HTTP 30x redirects. - The caller must retain the Authorization header when redirected to a different hostname. - **Supported file formats** `.json`. - For an account-level [OAuth](/docs/integrations/create/) app, this API can only be used on behalf of a user who is assigned a [role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983#h_80abad9b-86a8-492c-8a3b-5b0141a8c0a9) with **Edit** permission for Tasks Management. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks_file:write`,`tasks_file:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks:write:file`,`tasks:write:file:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY` **Not supported in Gov cluster**
POST /tasks/files - Write
Upload file for whiteboard import
Uploads a file to whiteboard. **Notes**: - Base URL: `https://fileapi.zoom.us/v2`. - Rate limit: 20 requests per second per user or 2000 requests per second per IP address. - The caller must support HTTP 30x redirects. - The caller must retain the Authorization header when redirected to a different hostname. - Supported file formats: `.pdf`, `.vsdx`. - For an account-level [OAuth](https://developers.zoom.us/docs/integrations/create/) app, this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983#h_80abad9b-86a8-492c-8a3b-5b0141a8c0a9) with **Edit** permission for Whiteboard Management. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_file:write:admin`,`whiteboard_file:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write:file`,`whiteboard:write:file:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY` **Not supported in Gov cluster**
POST /whiteboards/files
Tasks
- Read
List tasks
Retrieves tasks assigned to, or created by, the current user with advanced filtering, sorting, and pagination options. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks:read`,`tasks:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks:read:list_tasks:admin`,`tasks:read:list_tasks` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /tasks/items - Read
Get task details
Retrieves detailed information about a specific task by it’s ID **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks:read`,`tasks:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks:read:task`,`tasks:read:task:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /tasks/items/{taskId} - Write
Create a new task
Provide essential details to create a new task without file attachments. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks:write:task` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /tasks/items - Write
Update task fields
Updates specific fields of an existing task. Only provided fields will be updated, others will remain unchanged. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks:write`,`tasks:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks:update:task`,`tasks:update:task:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /tasks/items/{taskId} - Destructive
Delete a task
Permanently delete a task and all its associated data including descriptions, attachments, collaborators, and integrations. This operation cannot be undone. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks:delete`,`tasks:delete:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tasks:delete:task:admin`,`tasks:delete:task` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /tasks/items/{taskId}
Contact Groups
- Read
List contact groups
List [contact groups](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account. **Prerequisite**: Pro or higher account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_group:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
GET /contacts/groups - Read
Get a contact group
Get a [contact group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account. **Prerequisite**: Pro or higher account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_group:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
GET /contacts/groups/{groupId} - Read
List contact group members
List members in [contact groups](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account. **Prerequisite**: Pro or higher account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_group:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /contacts/groups/{groupId}/members - Write
Create a contact group
Use this API to create a [contact group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management). **Prerequisite**: Pro or higher account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_group:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
POST /contacts/groups - Write
Update a contact group
Update a [contact group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. **Prerequisite**: Pro or higher account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_group:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
PATCH /contacts/groups/{groupId} - Write
Add contact group members
Use this API to add members to a [contact group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management). **Prerequisite**: Pro or higher account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_group:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
POST /contacts/groups/{groupId}/members - Destructive
Delete a contact group
Use this API to delete a [contact group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-). **Prerequisite**: Pro or higher account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_group:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
DELETE /contacts/groups/{groupId} - Destructive
Remove members in a contact group
Removes members in a [contact group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-). **Prerequisite**: Pro or higher account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_group:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
DELETE /contacts/groups/{groupId}/members
Divisions
- Read
List divisions
List divisions under an account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** ` division:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `division:read:list_divisions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /divisions - Read
Get a division
Get a division under an account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `division:wirte:admin`,` division:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `division:read:division:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /divisions/{divisionId} - Read
List division members
List the users of a division under your account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** ` division:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `division:read:member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /divisions/{divisionId}/users - Write
Create a division
Create a division. You can add a maximum of 500 divisions in one account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `division:wirte:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `division:write:division:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
POST /divisions - Write
Update a division
Update a group under your account. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `division:wirte:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `division:update:division:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
PATCH /divisions/{divisionId} - Write
Assign a division
Assign a division to members. A user can belong to only one division. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `division:wirte:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `division:write:member:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
POST /divisions/{divisionId}/users - Destructive
Delete a division
Delete an entire division. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `division:wirte:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `division:delete:division:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
DELETE /divisions/{divisionId}
Channels
- Read
List channels
Retrieves the list of channels. **Prerequisites**: * A [Pro or higher account plan](https://www.zoom.us/pricing?). * A Zoom Video Management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt_channels:read`,`video_mgmt_channels:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt:read:list_channels`,`video_mgmt:read:list_channels:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /video_management/channels - Read
Get channel details
Returns the details of the video channel. **Prerequisites**: * A [Pro or higher account plan](https://www.zoom.us/pricing?). * A Zoom Video Management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt_channels:read`,`video_mgmt_channels:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt:read:channel`,`video_mgmt:read:channel:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /video_management/channels/{channelId} - Write
Create a channel
Creates a channel for managing videos. **Prerequisites**: * A [Pro or higher account plan](https://www.zoom.us/pricing?). * A Zoom Video Management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt_channels:write`,`video_mgmt_channels:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt:write:channel`,`video_mgmt:write:channel:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /video_management/channels - Write
Update channel
Updates a video channel. **Prerequisites**: * A Pro or higher account plan. * A Zoom Video Management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt_channels:write`,`video_mgmt_channels:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt:update:channel`,`video_mgmt:update:channel:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /video_management/channels/{channelId} - Write
Channel actions
Perform state transition actions on a video channel . **Prerequisites**: * A [Pro or higher account plan](https://www.zoom.us/pricing?). * A Zoom Video Management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt_channels:write`,`video_mgmt_channels:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt:update:channel`,`video_mgmt:update:channel:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /video_management/channels/{channelId}/actions - Destructive
Delete channel
Deletes a video channel. **Prerequisites**: * A Pro or higher account plan. * A Zoom Video Management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt_channels:write`,`video_mgmt_channels:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt:delete:channel`,`video_mgmt:delete:channel:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /video_management/channels/{channelId}
Permissions
- Read
List channel permissions
Retrieves the list of permissions for a channel. \n **Prerequisites**: * A [Pro or higher account plan](https://www.zoom.us/pricing?). * A Zoom Video Management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt_channels:read`,`video_mgmt_channels:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt:read:list_permissions`,`video_mgmt:read:list_permissions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /video_management/channels/{channelId}/permissions - Write
Create channel permissions
Creates permissions for the given channel ID. Add users, such as collaborators or viewers, to the channel. **Prerequisites**: * A [Pro or higher account plan](https://www.zoom.us/pricing?). * A Zoom Video Management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt_channels:write`,`video_mgmt_channels:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt:write:permissions`,`video_mgmt:write:permissions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /video_management/channels/{channelId}/permissions - Write
Update channel permissions
Updates channel permissions. **Prerequisites**: * A [Pro or higher account plan](https://www.zoom.us/pricing?). * A Zoom Video Management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt_channels:write`,`video_mgmt_channels:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt:update:permissions`,`video_mgmt:update:permissions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /video_management/channels/{channelId}/permissions - Destructive
Delete channel permissions
Delete channel permissions. **Prerequisites**: * A [Pro or higher account plan](https://www.zoom.us/pricing?). * A Zoom Video Management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt_channels:write`,`video_mgmt_channels:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt:delete:permissions`,`video_mgmt:delete:permissions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /video_management/channels/{channelId}/permissions
Playlists
- Read
List channel playlists
Retrieves the list of playlists for the channel. **Prerequisites**: * A [Pro or higher account plan](https://www.zoom.us/pricing?). * A Zoom Video Management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt_channels:read`,`video_mgmt_channels:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt:read:list_channel_playlists`,`video_mgmt:read:list_channel_playlists:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /video_management/channels/{channelId}/playlists - Read
List playlists
Retrieves the list of playlists for the user. **Prerequisites**: * A [Pro or higher account plan](https://www.zoom.us/pricing?). * A Zoom Video Management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt_playlists:read`,`video_mgmt_playlists:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt:read:list_playlists`,`video_mgmt:read:list_playlists:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /video_management/playlists - Write
Add channel playlists
Adds playlists to the channel. **Prerequisites**: * A [Pro or higher account plan](https://www.zoom.us/pricing?). * A Zoom Video Management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt_channels:write`,`video_mgmt_channels:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt:write:channel_playlists`,`video_mgmt:write:channel_playlists:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /video_management/channels/{channelId}/playlists - Write
Create a playlist
Creates a playlist for managing videos. **Prerequisites**: * A [Pro or higher account plan](https://www.zoom.us/pricing?). * A Zoom Video Management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt_playlists:write`,`video_mgmt_playlists:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt:write:playlist`,`video_mgmt:write:playlist:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /video_management/playlists - Write
Update playlist
Update playlist. **Prerequisites**: * A [Pro or higher account plan](https://www.zoom.us/pricing?). * A Zoom Video Management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt_playlists:write`,`video_mgmt_playlists:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt:update:playlist`,`video_mgmt:update:playlist:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /video_management/playlists/{playlistId} - Destructive
Delete channel playlists
Removes playlists from the channel. **Prerequisites**: * A [Pro or higher account plan](https://www.zoom.us/pricing?). * A Zoom Video Management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt_channels:write`,`video_mgmt_channels:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt:delete:channel_playlists`,`video_mgmt:delete:channel_playlists:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /video_management/channels/{channelId}/playlists - Destructive
Delete playlist
Deletes a playlist. **Prerequisites**: * A Pro or higher account plan. * A Zoom Video Management license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt_playlists:write`,`video_mgmt_playlists:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_mgmt:delete:playlist`,`video_mgmt:delete:playlist:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /video_management/playlists/{playlistId}
Byos Storage
- Read
List storage location
List the Bring Your Own Storage (BYOS) location. Lists all settings, except it will not show the AWS access key and secret. **This feature is in beta.** See [Bring your own storage](/docs/video-sdk/storage/) for details. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:read:storage_location:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /videosdk/settings/storage/location - Read
Storage location detail
Get details about one of the Bring Your Own Storage (BYOS) locations. This won't show the AWS access key and secret. **This feature is in beta.** See [Bring your own storage](/docs/video-sdk/storage/) for details. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:read:storage_location_detail:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /videosdk/settings/storage/location/{storageLocationId} - Write
Add storage location
Add the Bring Your Own Storage (BYOS) location. **This feature is in beta.** See [Bring your own storage](/docs/video-sdk/storage/) for details. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:write:storage_location:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
POST /videosdk/settings/storage/location - Write
Change storage location detail
Change one of the Bring Your Own Storage (BYOS) storage location details. **This feature is in beta.** See [Bring your own storage](/docs/video-sdk/storage/) for details. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:update:storage_location_detail:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
PATCH /videosdk/settings/storage/location/{storageLocationId} - Destructive
Update Bring Your Own Storage settings
Change Cloud Recording's Bring Your Own Storage setting. You can enable or disable this recording option. If it is set to true, Zoom will use your selected storage location to store recordings. If it is set to false, Zoom will use Zoom's own storage, charge you for cloud storage, and delete your configured storage locations. **This feature is in beta.** See [Bring your own storage](/docs/video-sdk/storage/) for details. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:update:storage_location_settings:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
PATCH /videosdk/settings/storage - Destructive
Delete storage location detail
Delete one of the the Bring Your Own Storage (BYOS) storage locations. **This feature is in beta.** See [Bring your own storage](/docs/video-sdk/storage/) for details. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:delete:storage_location_detail:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
DELETE /videosdk/settings/storage/location/{storageLocationId}
Video SDK Reports
- Read
Get cloud recording usage report
Retrieve cloud recording usage report for a specified period. You can only get cloud recording reports for up to 6 months prior to the current date. The date gap between from and to dates should be smaller or equal to 30 days. **Prerequisites** * A Video SDK account. **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /videosdk/report/cloud_recording - Read
Get daily usage report
Get daily report of the account-wide usage of Zoom services for each day in a given month. It lists the number of sessions, users, and session minutes. **Prerequisites** * A Video SDK account. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:read:daily_report:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /videosdk/report/daily - Read
Get operation logs report
Get operation logs report for a specified period of time. The operations logs report allows you to audit admin and user activity, such as changing account settings, and deleting recordings. See [Using Admin Activity Logs](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067251) for similar usage in Zoom Meetings. **Prerequisites** * A Video SDK account. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:read:operation_log:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /videosdk/report/operationlogs - Read
Get telephone report
Get the telephone report for a specified period of time. The telephone report allows you to view who dialed into sessions via phone (Audio Conferencing or SIP Connected Audio), which number they dialed into, and other details. See [Accessing audio conferencing reports](https://support.zoom.us/hc/en-us/articles/206514816-Telephone-reports) for similar usage in Zoom Meetings. **Prerequisites** * A Video SDK account. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `video_sdk:read:telephone:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
GET /videosdk/report/telephone - Read
Get webhook logs
Get the webhook call logs for the Video SDK app created by the current account. **Prerequisites** * A Video SDK account. **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /videosdk/report/webhook_logs
Knowledge Management
- Read
Get articles
Returns multiple knowledge base articles. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:read:km_kbs` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:read:list_km_articles`,`zva:read:list_km_articles:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /km/kbs/{kbId}/articles - Read
Get article
Returns a knowledge base article. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:read:km_kbs` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:read:km_article`,`zva:read:km_article:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /km/kbs/{kbId}/articles/{articleId} - Read
Get sync
Returns the details of a knowledge base sync. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:read:km_kbs` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:read:km_kb:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /km/kbs/{kbId}/sync/{syncId} - Write
Create article
Creates a knowledge base article. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:write:km_kbs` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:write:km_article`,`zva:write:km_article:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /km/kbs/{kbId}/articles - Write
Create sync request
Creates a sync request for the specified knowledge base **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:write:km_kbs` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:update:km_kb:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /km/kbs/{kbId}/sync - Destructive
Update article
Updates a knowledge base article. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:write:km_kbs` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:update:km_article`,`zva:update:km_article:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /km/kbs/{kbId}/articles/{articleId} - Destructive
Delete article
Deletes a knowledge base article. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:write:km_kbs` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:delete:km_article`,`zva:delete:km_article:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /km/kbs/{kbId}/articles/{articleId}
Classification Labels
- Read
List classification labels
Retrieves all classification labels for the account. **Note:** Each account can have a maximum of 30 classification labels. The `whiteboard_count` field is only returned when using admin scopes. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_classification_labels:read:admin`,`whiteboard_classification_labels:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:list_classification_labels:admin`,`whiteboard:read:list_classification_labels` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /whiteboards/classification_labels - Read
Get classification label
Retrieves detailed information about a specific classification label. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_classification_labels:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:classification_labels:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /whiteboards/classification_labels/{classificationId} - Write
Create a classification label
Creates a new classification label for the account. The label is immediately available for use. **Note:** Each account can have a maximum of 30 classification labels. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_classification_labels:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write:classification_labels:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /whiteboards/classification_labels - Write
Update a classification label
Updates an existing classification label. Only the fields provided in the request body will be updated. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_classification_labels:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:update:classification_labels:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /whiteboards/classification_labels/{classificationId} - Destructive
Delete classification label
Deletes an existing classification label. This action cannot be undone. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_classification_labels:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:delete:classification_labels:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /whiteboards/classification_labels/{classificationId} - Destructive
Apply classification to whiteboard
Applies or updates a classification label on a whiteboard. Each whiteboard can only have one classification label at a time. If the whiteboard already has a label, it will be replaced. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write:admin`,`whiteboard:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:update:whiteboard_classification`,`whiteboard:update:whiteboard_classification:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PUT /whiteboards/{whiteboardId}/classification - Destructive
Remove classification from whiteboard
Removes the classification label from a whiteboard. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write`,`whiteboard:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:delete:whiteboard_classification`,`whiteboard:delete:whiteboard_classification:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
DELETE /whiteboards/{whiteboardId}/classification
Content
- Read
Get Whiteboard Content
Get whiteboard content. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_content:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:content` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /whiteboards/{whiteboardId}/content - Write
Save Whiteboard Content
Save whiteboard content. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_content:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write:content` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
POST /whiteboards/{whiteboardId}/content - Destructive
Delete Whiteboard Content
Delete whiteboard content. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:delete:content` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
DELETE /whiteboards/{whiteboardId}/content
Document
- Read
List all whiteboards
Use this API to list whiteboards of current user (**Required Scopes**: `whiteboard:read`) or list all whiteboards under the account (**Required Scopes**: `whiteboard:read:admin`). **Note:** `user_id` can intake `Zoom user ID` or `email` which only applies when scope = `whiteboard:read:admin`. Otherwise, the `user_id` can only intake `me`. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:admin`,`whiteboard:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:list_whiteboards:admin`,`whiteboard:read:list_whiteboards` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /whiteboards - Read
Get a whiteboard
Returns a whiteboard's information. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:admin`,`whiteboard:read` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:whiteboard:admin`,`whiteboard:read:whiteboard` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /whiteboards/{whiteboardId} - Write
Create a new whiteboard
Creates a new whiteboard for a user. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write:whiteboard` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /whiteboards - Destructive
Update whiteboard basic information
Use this API to rename a whiteboard, update whiteboard status (locked or unlocked). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:update:whiteboard:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
PUT /whiteboards/{whiteboardId} - Destructive
Delete a whiteboard
Deletes a whiteboard. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write:admin`,`whiteboard:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:delete:whiteboard:admin`,`whiteboard:delete:whiteboard` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
DELETE /whiteboards/{whiteboardId}
Project
- Read
List all projects
Retrieves a list of projects. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_project:read`,`whiteboard_project:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:list_projects:admin`,`whiteboard:read:list_projects` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /whiteboards/projects - Read
Get a project
Retrieves detailed information about a specific project. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_project:read`,`whiteboard_project:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:project`,`whiteboard:read:project:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /whiteboards/projects/{projectId} - Read
Get collaborators of a project
Returns a list of a project collaborators. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_project_collaborator:read`,`whiteboard_project_collaborator:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:project_collaborator`,`whiteboard:read:project_collaborator:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /whiteboards/projects/{projectId}/collaborators - Read
List subprojects
Retrieves a list of all subprojects under a parent project. Returns all direct subprojects without pagination. **Project Hierarchy Constraints** * Project hierarchy supports up to 20 levels of nesting * Each project node can contain a maximum of 1,000 direct subprojects **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_project:read`,`whiteboard_project:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:subproject`,`whiteboard:read:subproject:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /whiteboards/projects/{projectId}/subprojects - Write
Create a new project
This API endpoint allows you to create a new project for a user, optionally adding collaborators and initializing it with existing whiteboards. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_project:write`,`whiteboard_project:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write:project`,`whiteboard:write:project:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /whiteboards/projects - Write
Update project basic information
This API endpoint allows you to update the basic information of a specific project. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_project:write:admin`,`whiteboard_project:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:update:project:admin`,`whiteboard:update:project` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /whiteboards/projects/{projectId} - Write
Update project collaborators
Updates the role of a collaborator in a project, which allows you to modify the permissions of an existing collaborator in a specific project. Note that when assigning a new `OWNER` or `CO_OWNER`, the specified user must belong to the same account as the original `OWNER`. The original owner will automatically be demoted to `CO_OWNER` if a new owner is designated. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_project_collaborator:write`,`whiteboard_project_collaborator:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:update:project_collaborator`,`whiteboard:update:project_collaborator:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
PATCH /whiteboards/projects/{projectId}/collaborators - Write
Create a subproject
Creates a new subproject under the specified parent project. **Project Hierarchy Constraints** * Project hierarchy supports up to 20 levels of nesting * Each project node can contain a maximum of 1,000 direct subprojects **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_project:write:admin`,`whiteboard_project:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write:subproject`,`whiteboard:write:subproject:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
POST /whiteboards/projects/{projectId}/subprojects - Write
Move whiteboards to a project
This API endpoint allows you to move one or more whiteboards to a specified project. It enables users to organize their whiteboards by associating them with a specific project, enhancing project management capabilities. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_project:write:admin`,`whiteboard_project:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write:project_whiteboard`,`whiteboard:write:project_whiteboard:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /whiteboards/projects/{projectId}/whiteboards - Destructive
Delete a project
This API endpoint allows you to delete a specified project. Deleting a project removes all associated whiteboards from the project, setting them to have no project assignment. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_project:write:admin`,`whiteboard_project:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:delete:project`,`whiteboard:delete:project:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /whiteboards/projects/{projectId} - Destructive
Remove the collaborator from a project
This API endpoint allows you to remove a specific collaborator from a designated project. It enables project managers or authorized users to revoke access or remove a user from a project, enhancing project management and access control capabilities. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_project_collaborator:write`,`whiteboard_project_collaborator:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:delete:project_collaborator:admin`,`whiteboard:delete:project_collaborator` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /whiteboards/projects/{projectId}/collaborators/{collaboratorId} - Destructive
Remove whiteboards from a project
This API endpoint allows you to remove one or more whiteboards from a specified project. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_project:write:admin`,`whiteboard_project:write` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:delete:project_whiteboard`,`whiteboard:delete:project_whiteboard:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
DELETE /whiteboards/projects/{projectId}/whiteboards
Filter groups
- Read
List filter groups
Get all filter groups **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:read:list_filter_groups:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /workforce-management/filter-groups
Forecasts
- Read
List forecasts
List forecasts. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:read:forecasts:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
GET /workforce-management/forecasts - Read
Get a forecast for a scheduling group
List forecasted values for a scheduling group within a forecast. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:read:forecasts:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /workforce-management/forecasts/{forecastId}/scheduling-groups/{schedulingGroupId}
Imports
- Read
Get historical queue metrics import metadata
Retrieve a list of historical queue metrics import metadata. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:read:queue_metrics:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /workforce-management/imports/{importId}/historical-queue-metrics - Write
Upload forecast
Upload a CSV file to create an imported forecast. The request creates one or more forecast requests and starts asynchronous CSV validation. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:write:import_forecast:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
POST /workforce-management/imports/forecast - Write
Upload historical agent status
Import external historical agent status change events into WFM for adherence reporting. This endpoint validates the full payload, auto-creates unknown statuses and sub-statuses, and stores data for historical adherence calculation. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:write:agent_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY` **Not supported in Gov cluster**
POST /workforce-management/imports/historical-agent-status - Write
Upload historical queue metrics
Import historical queue metrics to Workforce Management (WFM). **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:write:queue_metrics:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY` **Not supported in Gov cluster**
POST /workforce-management/imports/historical-queue-metrics - Write
Upload forecast staffing
Import interval-level staffing into Zoom Workforce Management (WFM) by uploading a CSV file and creating an imported staffing forecast. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:write:staffing:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
POST /workforce-management/imports/staffing - Destructive
Delete historical agent status
Delete historical agent status events for a user within a specified time range (`start_time` inclusive, `end_time` exclusive). Each request item targets one `user_id` and time window and removes matching events in that interval. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:delete:agent_status:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
DELETE /workforce-management/imports/historical-agent-status
Organizational Groups
- Read
Get multiple organizational groups
Get multiple organizational groups. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:read:organizational_groups:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
GET /workforce-management/organizational-groups - Read
Get a single organizational group
Get a single organizational group. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:read:organizational_groups:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT` **Not supported in Gov cluster**
GET /workforce-management/organizational-groups/{organizationalGroupId} - Write
Create an organizational group
Create an organizational group. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:write:organizational_groups:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
POST /workforce-management/organizational-groups - Write
Update an organizational group
Update an organizational group. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:update:organizational_groups:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
PATCH /workforce-management/organizational-groups/{organizationalGroupId} - Destructive
Delete organizational group
Delete an organizational group. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:delete:organizational_groups:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM` **Not supported in Gov cluster**
DELETE /workforce-management/organizational-groups/{organizationalGroupId}
Schedules
- Read
List all schedule agents
List the schedule agents for the particular date and timezone. **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:read:list_schedule_agents:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
GET /workforce-management/schedules/agents
Scheduling groups
- Read
List scheduling groups
Get all the scheduling group name and id **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `workforce_management:read:list_scheduling_groups:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
GET /workforce-management/scheduling-groups
No operations match.
See How connections work for access and permissions, or browse all integrations.