Use wide Zoom integration

With Ants & Apps platform you can connect Zoom with more than 30 available apps, 600+ functional formulas to boost your productivity

Reference

  • accounts

    • List all the Sub Accounts under the Master Account

      This action list all the Sub Accounts under the Master Account.


      **Prerequisites:**
      * Pro or a higher paid account with Master Account option enabled.
      **Scope**: `account:read:admin`

      GETAccounts

      Request parameters

      • page_sizeinteger

        The number of records returned within a single API call.

      • page_numberinteger

        The current page number of returned records.

    • Get a Sub Account under the Master Account

      This action get a Sub Account under the Master Account.



      **Prerequisites:** * Pro or a higher paid account with Master Account option enabled.
      **Scope**: `account:write:admin`

      GETAccount

      Request parameters

      • accountId*string

        The account ID.

    • Get [billing information](https://support

      This action get [billing information](https://support.zoom.us/hc/en-us/articles/201363263-About-Billing) of a Sub Account under a Master Account.

      **Prerequisites:** * Pro or a higher paid account with Master Account option enabled.
      **Scope**:`billing:master`

      GETAccountBilling

      Request parameters

      • accountId*string

        The account ID.

    • [Account Locked Settings](https://support

      This action [Account Locked Settings](https://support.zoom.us/hc/en-us/articles/115005269866) allow you turn settings on or off for all users in your account. No user except the account admin or account owner can change these settings. With lock settings, you force the settings on for all users. Use this API to retrieve an account's locked settings.

      Note: The force_pmi_jbh_password field under meeting settings was deprecated on September 22, 2019. Use require_password_for_pmi_meetings field as an alternative for the same functionality.

      **Prerequisites:** * Pro or a higher paid account with Master Account option enabled.
      **Scope**: `account:read:admin`.
      **Scope:** account:read:admin

      GETGetAccountLockSettings

      Request parameters

      • accountId*string

    • Get a Sub Account's [managed domains](https://support

      This action get a Sub Account's [managed domains](https://support.zoom.us/hc/en-us/articles/203395207-What-is-Managed-Domain-).

      To get managed domains of the Master Account, provide `me` as the value for accountId in the path parameter. Provide the Sub Account's Account ID as the value of accountId path parameter to get managed domains of the Sub Account. **Prerequisites:**
      * Pro or a higher paid account with Master Account option enabled.
      **Scope:** `account:read:admin`

      GETAccountManagedDomain

      Request parameters

      • accountId*string

        The account ID.

    • Get plan information for a Sub Account under the Master account

      This action get plan information for a Sub Account under the Master account.



      **Scopes:** `billing:master`

      GETAccountPlans

      Request parameters

      • accountId*string

        The account ID.

    • Get information on usage of [plans](https://marketplace

      This action get information on usage of [plans](https://marketplace.zoom.us/docs/api-reference/other-references/plans) on a Master Account. **Prerequisite**:
      Account type: Master Account on a paid Pro, Business or Enterprise plan.
      **Scope:** `billing:master`

      GETGetPlanUsage

      Request parameters

      • accountId*string

    • List [Cloud Recordings](https://support

      This action list [Cloud Recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) available on an Account. **Prerequisites**:
      * A Pro or a higher paid plan with Cloud Recording option enabled.
      **Scopes**: `recording:read:admin` or `account:read:admin` If the scope `recording:read:admin` is used, the Account ID of the Account must be provided in the `accountId` path parameter to list recordings that belong to the Account. This scope only works for Sub Accounts. To list recordings of a Master Account, the scope must be `account:read:admin` and the value of `accountId` should be `me`.

      GETGetAccountCloudRecording

      Request parameters

      • accountId*string

      • page_sizeinteger

        The number of records returned within a single API call.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

      • fromstring

        The start date for the monthly range for which you would like to retrieve recordings. The maximum range can be a month. The month should fall within the past six months period from the date of query.

      • tostring

        The end date for the monthly range for which you would like to retrieve recordings. The maximum range can be a month. The month should fall within the past six months period from the date of query.

    • Get the settings of a Sub Account under a Master Account

      This action get the settings of a Sub Account under a Master Account.
      To get the settings of a Master Account, use `me` as the value for the `accountId` path parameter.

      Note: The `force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.

      **Prerequisites**: * The Sub Account must be a paid account.
      **Scopes**: `account:read:admin`

      GETAccountSettings

      Request parameters

      • accountId*string

        The account ID.

      • optionstring

        `meeting_authentication`: Use this query parameter to view [meeting authentication configuration](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied on the account.
        `recording_authentication`: Use this query parameter to view [recording authentication configuration](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied on the account.

    • Get trusted domains of a Sub Account

      This action get trusted domains of a Sub Account. To get the trusted domains of a Master Account, use `me` as the value for the `accountId` path parameter. **Prerequisites:**
      * The Sub Account must be a paid account.
      **Scope:** `account:read:admin`

      GETAccountTrustedDomain

      Request parameters

      • accountId*string

        The account ID.

    • Create a Sub Account under the Master Account

      This action create a Sub Account under the Master Account.



      **Prerequisites:**
      * Pro or a higher paid account with Master Account option enabled.
      **Scope**: `account:write:admin`

      POSTAccountCreate

      Request body

      • email*string

        User's email address.

      • first_name*string

        User's first name.

      • last_name*string

        User's last name.

      • password*string

        User's password.

      • optionsobject

        Account options object.

    • Subscribe plans for a Sub Account under a Master Account

      This action subscribe plans for a Sub Account under a Master Account.



      **Scopes**: `billing:master`

      POSTAccountPlanCreate

      Request parameters

      • accountId*string

        The account ID.

      Request body

      • contactobject

        Billing Contact object.

      • plan_audioobject

        Additional audio conferencing plan type.

      • plan_baseobject

        Account base plan object.

      • plan_large_meetingarray

        Additional large meeting Plans.

      • plan_phoneobject

        Phone Plan Object

      • plan_recordingstring

        Additional cloud recording plan.

      • plan_room_connectorobject

        Account plan object.

      • plan_webinararray

        Additional webinar plans.

      • plan_zoom_roomsobject

        Account plan object.

    • Add an additional plan for a sub account

      This action add an additional plan for a sub account.

      **Prerequisites:**
      * Pro or a higher plan with Master Account enabled. * The Sub Account must be a paid account. The billing charges for the Sub Account must be paid by the Master Account.
      **Scopes**: `billing:master`

      POSTAccountPlanAddonCreate

      Request parameters

      • accountId*string

        The account ID.

      Request body

      • hostsinteger

        Number of hosts for this plan.

      • typestring

        Account plan type.

    • With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer’s network and the Zoom cloud

      This action with SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer’s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers' IP telephony network, will be connected over this trunk rather than over the PSTN.

      Use this API to assign internal numbers to a Sub Account. **Prerequisites:**
      * Pro or a higher account with SIP Connected Audio plan enabled. * The account must be a Master Account
      **Scopes:** `sip_trunk:master`

      POSTAssignSipTrunkNumbers

      Request parameters

      • accountId*string

        Unique Identifier of the Sub Account.

      Request body

      • phone_numbersarray

        Phone number(s) to be assigned to the Sub Account.

    • The current account owner can [change the owner of an account](https://support

      This action the current account owner can [change the owner of an account](https://support.zoom.us/hc/en-us/articles/115005686983-Change-Account-Owner) to another user on the same account.
      Use this API to change the owner of an account. **Prerequisites**:
      * Account owner or admin permissions.
      * Pro or a higher plan with Master Account option enabled.. **Scopes:** `account:write:admin` or `account:master`

      PUTUpdateAccountOwner

      Request parameters

      • accountId*string

        Account Id of the account.

      Request body

      • email*string

        Email address of the new owner.

    • Update an additional plan for a sub account

      This action update an additional plan for a sub account.

      **Prerequisites:**
      * Pro or a higher plan with Master Account enabled. * The Sub Account must be a paid account. The billing charges for the Sub Account must be paid by the Master Account.
      **Scopes**: `billing:master`

      PUTAccountPlanAddonUpdate

      Request parameters

      • accountId*string

        The account ID.

      Request body

      • hosts*integer

        Number of hosts for this plan.

      • type*string

        Account plan type.

    • Update a base plan of a Sub Account

      This action update a base plan of a Sub Account.



      **Scopes:** `billing:master`

      PUTAccountPlanBaseUpdate

      Request parameters

      • accountId*string

        The account ID.

      Request body

      • hosts*integer

        Account base plan number of hosts. For a Pro Plan please select a value between 1 and 9. For a Business Plan please select a value between 10 and 49. For a Education Plan please select a value between 20 and 149. For a Free Trial Plan please select a value between 1 and 9999.

      • type*string

        Account base plan type.

    • Disassociate a user from one Account and move the user to another Account under the same Master Account

      This action disassociate a user from one Account and move the user to another Account under the same Master Account. With this API, a user under a Master Account or a Sub Account can be moved to another Sub Account within the same Master Account. To move a user from a Master Account to a Sub Account, use `me` as the value for `accountId`. In this scenario, "me" refers to the Account ID of the Master Account. To move a user from one Sub Account to another Sub Account, provide the Sub Account's Account ID as the value for `accountId`. **Prerequisites**: * The account should have Pro or a higher plan with Master Account option enabled. * The user whose account needs to be switched should not be an admin or an owner of that account. * The user should not have the same [managed domain](https://support.zoom.us/hc/en-us/articles/203395207-What-is-Managed-Domain-) as the account owner. **Scope:** `user:master`

      PUTSwitchUserAccount

      Request parameters

      • accountId*string

      • userId*string

      Request body

      • account_id*string

        The Account ID of the account to which you would like move the user to.

    • Update [billing information](https://support

      This action update [billing information](https://support.zoom.us/hc/en-us/articles/201363263-About-Billing) for a Sub Account under a Master account.



      **Prerequisites:** * Pro or a higher paid account with Master Account option enabled.
      **Scope**:`billing:master`

      PATCHAccountBillingUpdate

      Request parameters

      • accountId*string

        The account ID.

      Request body

      • addressstring

        Billing Contact's address.

      • aptstring

        Billing Contact's apartment/suite.

      • citystring

        Billing Contact's city.

      • countrystring

        Billing Contact's country.

      • emailstring

        Billing Contact's email address.

      • first_namestring

        Billing Contact's first name.

      • last_namestring

        Billing Contact's last name.

      • phone_numberstring

        Billing Contact's phone number.

      • statestring

        Billing Contact's state.

      • zipstring

        Billing Contact's zip/postal code.

    • [Account Locked Settings](https://support

      This action [Account Locked Settings](https://support.zoom.us/hc/en-us/articles/115005269866) allow you turn settings on or off for all users in your account. No user except the account admin or account owner can change these settings. With lock settings, you force the settings on for all users. Use this API to update an account's locked settings.


      Note: The `force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.

      **Prerequisites:**
      * Pro or a higher paid account with Master Account option enabled.
      **Scope:** `account:write:admin`

      PATCHUpdateAccountLockSettings

      Request parameters

      • accountId*string

      Request body

      • email_notificationobject

      • in_meetingobject

      • recordingobject

      • schedule_meetingobject

      • telephonyobject

      • tspobject

    • Update a Sub Account's options under the Master Account

      This action update a Sub Account's options under the Master Account.

      **Prerequisites:** * Pro or a higher paid account with Master Account option enabled.
      **Scope**: `account:write:admin`

      PATCHAccountOptionsUpdate

      Request parameters

      • accountId*string

        The account ID.

      Request body

      • meeting_connectorsstring

        Specify the IP addresses of the Meeting Connectors that you would like to share with the Sub Account. Multiple values can be separated by comma. If no value is provided in this field, all the Meeting Connectors of a Master Account will be shared with the Sub Account. **Note:** This option can only be used if the value of `share_mc` is set to `true`.

      • pay_modestring

        Payee:
        `master` - Master account holder pays.
        `sub` - Sub account holder pays.

      • room_connectorsstring

        Specify the IP addresses of the Room Connectors that you would like to share with the Sub Account. Multiple values can be separated by comma. If no value is provided in this field, all the Room Connectors of a Master Account will be shared with the Sub Account. **Note:** This option can only be used if the value of `share_rc` is set to `true`.

      • share_mcboolean

        Enable/disable the option for a Sub Account to use shared [Meeting Connector(s)](https://support.zoom.us/hc/en-us/articles/201363093-Getting-Started-with-the-Meeting-Connector) that are set up by the Master Account. Meeting Connectors can only be used by On-prem users.

      • share_rcboolean

        Enable/disable the option for a Sub Account to use shared [Virtual Room Connector(s)](https://support.zoom.us/hc/en-us/articles/202134758-Getting-Started-With-Virtual-Room-Connector) that are set up by the Master Account. Virtual Room Connectors can only be used by On-prem users.

    • [Cancel additional plan](https://support

      This action [Cancel additional plan](https://support.zoom.us/hc/en-us/articles/203634215-How-Do-I-Cancel-My-Subscription-) for a sub account. Only a Master account holder who pays for this sub account can cancel the add-on. The cancellation does not provide refund for the current subscription. The service remains active for the current session. **Prerequisites:**
      * Pro or a higher plan with Master Account option enabled. * The Sub Account must be a paid account.
      **Scope:** `billing:master`

      PATCHAccountPlanAddonCancel

      Request parameters

      • accountId*string

      Request body

      • actionstring

        The action that needs to be taken for this sub account. Value must be set to "cancel".

      • commentstring

        Additional comments about the cancellation decision.

      • reasoninteger

        The reason for the cancellation of plan. Reason options:
        `1` - Only needed the service occasionally.
        `2` - Features in the free plan are sufficient.
        `3` - The plan is too expensive.
        `4` - Important features are missing.
        `5` - I need help to better use Zoom.
        `6` - I bought the wrong product.
        `7` - I am not satisfied with the product quality.

      • typestring

        Plan [type](https://marketplace.zoom.us/docs/api-reference/other-references/plans).

    • [Cancel a base plan](https://support

      This action [Cancel a base plan](https://support.zoom.us/hc/en-us/articles/203634215-How-Do-I-Cancel-My-Subscription-) for a sub account. Only a master account holder who pays for this sub account can cancel the plan. The cancellation does not provide refund for the current subscription. The service remains active for the current session. **Scopes**: `billing:master`

      PATCHAccountPlanBaseDelete

      Request parameters

      • accountId*string

      Request body

      • action*string

        The action that needs to be taken for this sub account. Value must be set to "cancel".

      • commentstring

        Additional comments about the cancellation decision.

      • reasoninteger

        The reason for the cancellation of plan. Reason options:
        `1` - Only needed the service occasionally.
        `2` - Features in the free plan are sufficient.
        `3` - The plan is too expensive.
        `4` - Important features are missing.
        `5` - I need help to better use Zoom.
        `6` - I bought the wrong product.
        `7` - I am not satisfied with the product quality.

    • Update the settings of a Sub Account that is under a Master Account

      This action update the settings of a Sub Account that is under a Master Account.
      To update the settings of the Master Account, use `me` as the value of the `accountId` path parameter.


      Note: The `force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.

      **Prerequisites**: * The Sub Account must be a paid account.
      **Scopes**: `account:write:admin`

      PATCHAccountSettingsUpdate

      Request parameters

      • accountId*string

        The account ID.

      • optionstring

      Request body

      • email_notificationobject

        Account Settings: Notification.

      • featureobject

        Account Settings: Feature.

      • in_meetingobject

        Account Settings: In Meeting.

      • integrationobject

        Account Settings: Integration.

      • recordingobject

        Account Settings: Recording.

      • schedule_metingobject

        Account Settings: Schedule Meeting.

      • securityobject

        Account Settings: Security.

      • telephonyobject

        Account Settings: Telephony.

      • tspobject

        Account Settings: TSP.

      • zoom_roomsobject

        Account Settings: Zoom Rooms.

    • With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer’s network and the Zoom cloud

      This action with SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer’s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers' IP telephony network, will be connected over this trunk rather than over the PSTN.

      Using this API, a Master Account owner can copy the SIP Connected Audio configurations applied on the Master Account and enable those configurations on a Sub Account. The owner can also disable the configuration in the Sub Account where it was previously enabled. **Prerequisites:**
      * Pro or a higher account with SIP Connected Audio plan enabled. * Master Account Owner
      **Scopes:** `sip_trunk:master`

      PATCHAssignSIPConfig

      Request parameters

      • accountId*string

      Request body

      • enableboolean

        Enable or delete the configuration.
        The values can be one of the following:
        `true`: Enable configuration.
        `false`: Delete configuration

    • Disassociate a Sub Account from the Master Account

      This action disassociate a Sub Account from the Master Account. This will leave the Sub Account intact but it will no longer be associated with the master account.


      **Prerequisites:** * Pro or a higher paid account with Master Account option enabled.
      **Scope**: `account:write:admin`

      DELETEAccountDisassociate

      Request parameters

      • accountId*string

        The account ID.

    • With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer’s network and the Zoom cloud

      This action with SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer’s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers' IP telephony network, will be connected over this trunk rather than over the PSTN.

      Use this API to delete all internal numbers assigned to a Sub Account. **Prerequisites:**
      * Pro or a higher account with SIP Connected Audio plan enabled. * The account must be a Master Account
      **Scopes:** `sip_trunk:master`

      DELETEDeleteAllSipNumbers

      Request parameters

      • accountId*string

        Account ID of the Sub Account from which the numbers are to be deleted. This can be retrieved from [List Sub Accounts](https://marketplace.zoom.us/docs/api-reference/zoom-api/accounts/account) API.

  • phone

    • A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account

      This action 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.
      Use this API to list all the blocked lists in an acccount.
      **Prerequisites:** * Pro or higher account plan with Zoom phone license
      **Scope:** `phone:read:admin`

      GETListBlockedList

      Request parameters

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

      • page_sizeinteger

        The total number of records returned from a single API call.

    • A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account

      This action 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.
      Use this API to get information about a specific blocked list.
      **Prerequisites:** * Pro or higher account plan with Zoom phone license
      **Scope:** `phone:read:admin`

      GETGetABlockedList

      Request parameters

      • blockedListId*string

        Unique Identifier of the blocked list.

    • Retrieve [call logs](https://support

      This action retrieve [call logs](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-Call-Logs) for an account. **Scopes**: `phone:read:admin`

      **Prerequisite:**
      1. Business or Enterprise account
      2. A Zoom Phone license
      3. Account Owner and a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) with Zoom Phone Management

      GETAccountCallLogs

      Request parameters

      • page_sizeinteger

        The number of records returned within a single API call.

      • page_numberinteger

        The current page number of returned records.

      • fromstring

        Start date from which you would like to get the call logs. The start date should be within past six months.

      • tostring

        The end date upto which you would like to get the call logs for. The end date should be within past six months.

      • typestring

        The type of the call logs. The value can be either "all" or "missed".

    • Call queues allow you to route incoming calls to a group of users

      This action 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:** `phone:read:admin`

      GETListCallQueues

      Request parameters

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

      • page_sizeinteger

        The number of records returned from a single API call.

    • Call queues allow you to route incoming calls to a group of users

      This action 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 get information on a specific Call Queue.

      **Prerequisites:**
      * Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license
      **Scopes:** `phone:read:admin`

      GETGetACallQueue

      Request parameters

      • callQueueId*string

        Unique Identifier of the Call Queue. This can be retrieved from [List Call Queues API]().

    • List all Zoom Phone [calling plans](https://marketplace

      This action list all Zoom Phone [calling plans](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) that are enabled for a Zoom account.

      **Prerequisites:**
      * Pro or a higher account with Zoom phone license.
      **Scope:** `phone:read:admin`

      GETListCallingPlans
    • A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it

      This action a common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don't belong to a specific employees, you could add a common area phone so that any person can use it.
      Use this API to get details on a specific [common area phone](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones) in an account.

      **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:** `phone:read:admin`

      GETGetACommonAreaPhone

      Request parameters

      • commonAreaPhoneId*string

        Unique Identifier of the Common Area Phone. This can be retrieved from List Common Area Phones API.

    • A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it

      This action a common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don't belong to a specific employees, you could add a common area phone so that any person can use it.
      Use this API to [list all common area phone](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones) in an account.

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

      **Scope:** `phone:read:admin`

      GETListCommonAreaPhones

      Request parameters

      • page_sizeinteger

        The total number of records returned from a single API call.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

    • List all the [desk phone devices](https://support

      This action list all the [desk phone devices](https://support.zoom.us/hc/en-us/articles/360021119092) that are configured with Zoom Phone on an account. To view devices that have not yet been assigned to a user, set the value of the `type` query parameter as `unassigned` and to view devices that have been assigned, set the value as `assigned`.

      **Scopes:** `phone:read:admin`
      **Prerequisites:**
      * Pro or a higher account with Zoom Phone license * Account owner or admin permissions

      GETListPhoneDevices

      Request parameters

      • type*string

        State of the device. The value should be either `assigned` to list devices that have been assigned to user(s) or `unassigned` to list devices that have not yet been assigned to any user in the Zoom account.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

      • page_sizeinteger

        The number of records returned within a single API call.

    • Get detailed information about a specific [desk phone device](https://support

      This action get 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:** `phone:write:admin`

      GETGetADevice

      Request parameters

      • deviceId*string

        Unique Identifier of the device.

    • A Zoom account owner or admin can purchase phone numbers and assign them to Zoom phone users

      This action a Zoom account owner or admin can purchase phone numbers and assign them to Zoom phone users. Use this API to list all Zoom Phone numbers in a Zoom account. You can filter the response based on your needs by using query parameters. **Prerequisites:**
      * Pro or higher plan with Zoom phone license
      **Scope:** `phone:read:admin`

      GETListAccountPhoneNumbers

      Request parameters

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

      • typestring

        Query response by number assignment. The value can be one of the following:
        `assigned`: The number has been assigned to either a user, a call queue, an auto-receptionist or a common area phone in an account.
        `unassigned`: The number is not assigned to anyone.
        `all`: Include both assigned and unassigned numbers in the response.

      • extension_typestring

        The type of assignee to whom the number is assigned. The value can be one of the following:
        `user`
        `callQueue`
        `autoReceptionist`
        `commonAreaPhone`

      • page_sizeinteger

        The number of records returned within a single API call.

      • number_typestring

        The type of phone number. The value can be either `toll` or `tollfree`.

      • pending_numbersboolean

        Include or exclude pending numbers in the response. The value can be either `true` or `false`.

    • A Zoom account owner or admin can purchase phone numbers and assign them to Zoom phone users

      This action a Zoom account owner or admin can purchase phone numbers and assign them to Zoom phone users. Use this API to get details on a specific Phone number in a Zoom account.

      **Prerequisites:**
      * Pro or higher plan with Zoom phone license
      **Scope:** `phone:read:admin`

      GETGetPhoneNumberDetails

      Request parameters

      • numberId*string

        Unique Identifier of the Phone Number. This can be retrieved from the List Phone Numbers API.

    • Site allow you to organize Zoom Phone users in your organization

      This action 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. **Scope:** `phone:read:admin`

      GETListPhoneSites

      Request parameters

      • page_sizeinteger

        The number of records returned within a single API call.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

    • Site allow you to organize Zoom Phone users in your organization

      This action sites allow you to organize Zoom Phone users in your organization. Use this API to get information about 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).
      **Scope:** `phone:read:admin`

      GETGetASite

      Request parameters

      • siteId*string

        Unique Identifier of the Site.

    • List all the users on an account who have been assigned Zoom Phone licenses

      This action list all the users on an account who have been assigned Zoom Phone licenses.

      **Prerequisites:**
      * Pro or higher plan with Zoom phone license
      **Scope:** `phone:read:admin`

      GETListPhoneUsers

      Request parameters

      • page_sizeinteger

        The number of records returned from a single API call.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

      • site_idstring

        Unique Identifier of the site. This can be retrieved from List Phone Sites API.

    • Retrieve a user's [zoom phone](https://support

      This action retrieve a user's [zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) profile. **Scopes:** `phone:read`, `phone:read:admin`
      **Prerequisites** : 1. Business or Enterprise account 2. A Zoom Phone license

      GETPhoneUser

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

    • Retrieve a [zoom phone](https://support

      This action retrieve a [zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) user's call logs. **Scopes:** `phone:read`, `phone:read:admin`

      **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license

      GETPhoneUserCallLogs

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

      • from*string

        Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

      • to*string

        End date.

      • page_sizeinteger

        The number of records returned within a single API call.

      • page_numberinteger

        The current page number of returned records.

      • typestring

    • Retrieve a user's zoom [phone recordings](https://support

      This action retrieve a user's zoom [phone recordings](https://support.zoom.us/hc/en-us/articles/360021336671-Viewing-Call-History-and-Recordings). **Scopes:** `phone:read`, `phone:read:admin`

      **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license

      GETPhoneUserRecordings

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

      • page_sizeinteger

        The number of records returned within a single API call.

      • page_numberinteger

        The current page number of returned records.

    • Retrieve a user's zoom phone profile [settings](https://support

      This action retrieve a user's zoom phone profile [settings](https://support.zoom.us/hc/en-us/articles/360021325712-Configuring-Settings). **Scopes:** `phone:read`, `phone:read:admin`

      **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license

      GETPhoneUserSettings

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

    • Retrieve a user's Zoom Phone voicemails

      This action retrieve a user's Zoom Phone voicemails. **Scopes:** `phone:read`, `phone:read:admin`

      **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license

      GETPhoneUserVoiceMails

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

      • page_sizeinteger

        The number of records returned within a single API call.

      • page_numberinteger

        The current page number of returned records.

      • statusstring

        Status of the voice mail

    • Assign available phone numbers to an [auto receptionist](https://support

      This action assign 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:** `phone:write:admin`

      POSTAssignPhoneNumbersAutoReceptionist

      Request parameters

      • autoReceptionistId*string

        Unique Identifier of the Auto Receptionist. It can be retrieved from the [List Sites API](https://marketplace.zoom.us/docs/api-reference/zoom-api/phone-site/listphonesites).

      Request body

      • phone_numbersarray

        Provide either the unique identifier of the Phone Number in the `id` field or provide the phone number in the `number` field.

    • A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account

      This action 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.
      Use this API to create a blocked list and add a number to that blocked list.
      **Prerequisites:** * Pro or higher account plan with Zoom phone license
      **Scope:** `phone:write:admin`

      POSTAddAnumberToBlockedList

      Request body

      • block_typestring

        State whether you want the block type to be inbound or outbound.
        `inbound`: Pass this value to prevent the blocked number or prefix from calling in to phone users.
        `outbound`: Pass this value to prevent phone users from calling the blocked number or prefix.

      • commentstring

        Provide a comment to help you identify the blocked number or prefix.

      • match_typestring

        Specify the match type for the blocked list. The values can be one of the following:

        `phoneNumber`: Choose this option (Phone Number Match) if you want to block a specific phone number. Then, in the `phone_number` field, provide the phone number along with the country code.

        `prefix`: Choose this option (Prefix Match) if you want to block all numbers with a specific country code and area code. Next, in the `phone_number` field, enter a country code as part of the prefix. For example, entering 1907 blocks numbers with country code 1 and area code 907.

      • phone_numberstring

        The phone number to be blocked if you passed "phoneNumber" as the value for the `match_type` field. If you passed "prefix" as the value for the `match_type` field, provide the prefix of the phone number here including the country code. For example, entering 1905 blocks numbers with country code 1 and area code 905.

      • statusstring

        Enable or disable the blocking. One of the following values are allowed:
        `active`: Keep the blocking active.
        `inactive`: Disable the blocking.

    • Call queues allow you to route incoming calls to a group of users

      This action 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 [create a call queue](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues#h_e81faeeb-9184-429a-aaea-df49ff5ff413).
      You can add phone users or common area phones to call queues. **Prerequisites:**
      * Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license
      **Scopes:** `phone:write:admin`

      POSTCreateCallQueue

      Request body

      • name*string

        Name of the Call Queue.

      • site_id*string

        Required only if [multiple sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) have been enabled. This can be retrieved from the [List Phone Sites]() API.

      • descriptionstring

        Description for the Call Queue.

      • extension_numberinteger

        Phone extension number for the site.
        If a site code has been [assigned](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_79ca9c8f-c97b-4486-aa59-d0d9d31a525b) to the site, provide the short extension number instead of the original extension number..

      • membersobject

        A list of one or more phone users to be included in the call queue. Provide either users or common area phone(s). Provide at least one user in the users object.

    • Add phone users and/or [common area phones](https://support

      This action add phone users and/or [common area phones](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones) as members to a specific Call Queue.

      **Prerequisites:**
      * Pro or higher account plan. * Zoom Phone license
      **Scopes:** `phone:write:admin`

      POSTAddMembersToCallQueue

      Request parameters

      • callQueueId*string

        Unique Identifier of the Call Queue.

      Request body

      • membersobject

        A maximum of 10 members can be added at a time.

    • After [buying phone number(s)](https://support

      This action after [buying phone number(s)](https://support.zoom.us/hc/en-us/articles/360020808292#h_007ec8c2-0914-4265-8351-96ab23efa3ad), you can assign it, allowing 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:** `phone:write:admin`

      POSTAssignPhoneToCallQueue

      Request parameters

      • callQueueId*string

        Unique Identifier of the Call Queue.

      Request body

      • phone_numbersarray

        Provide either the `id` or the `number` field. Only a max of 5 numbers can be assigned to a call queue at a time.

    • A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it

      This action a common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don't belong to a specific employees, you could add a common area phone so that any person can use it.
      Use this API to [add a common area phone](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones#h_2d0da347-c35a-4993-9771-e21aaa568deb).

      **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)
      **Scope:** `phone:write:admin`

      POSTAddCommonAreaPhone

      Request body

      • display_name*string

        Display name of the Common area phone.

      • extension_number*integer

        Extension number assigned to the common area phone. If site code is enabled, provide the short extension number instead.

      • mac_address*string

        Mac Address (serial number) of the common area desk phone. These examples show the formats supported: `64-16-7f-37-90-92` or `64167f379092`

      • type*string

        Phone device manufacturer name. Refer to the "Manufacturer Name" field in [this](https://marketplace.zoom.us/docs/api-reference/other-references/zoomphone-supporteddevice) table.

      • descriptionstring

        Description for the common area phone.

      • modelstring

        Device Model name. Refer to the "Model Name" field in [this](https://marketplace.zoom.us/docs/api-reference/other-references/zoomphone-supporteddevice) table.

      • site_idstring

        Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672). This can be retrieved from List Sites API.

      • time_zonestring

        [Timezone ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists) for the common area phone.

    • By default, all Zoom Phone users can make and receive calls using the Zoom desktop and mobile applications

      This action 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](https://support.zoom.us/hc/en-us/articles/360021119092#h_5ca07504-68a8-4c3d-ad0e-c1d3594436da) to a user. **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:** `phone:write:admin`

      POSTAddPhoneDevice

      Request body

      • display_name*string

        Display name of the desk phone.

      • mac_address*string

        The MAC address of the desk phone.
        Note: If you're using a wireless phone, enter the wired MAC address, not the wireless MAC address.

      • assigned_tostring

        User ID or email address of the user to whom this device is to be assigned. The User ID and the email of the user can be retrieved using the [List Users](https://marketplace.zoom.us/docs/api-reference/zoom-api/users/users) API.

      • modelstring

        Model name of the device.

      • typestring

        Manufacturer (brand) name of the device.

    • Site allow you to organize Zoom Phone users in your organization

      This action sites allow you to organize Zoom Phone users in your organization. Use this API to create a [Site](https://support.zoom.us/hc/en-us/articles/360020809672).
      **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. **Scope:** `phone:write:admin`

      POSTCreatePhoneSite

      Request body

      • auto_receptionist_name*string

        Display name of the [auto-receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Integrated-Voice-Response-IVR-) for the site.

      • name*string

        Name of the Site.

      • default_emergency_addressobject

      • site_codeinteger

        Identifier for a site. If site code is enabled, this field is required.

    • Assign [calling plan](https://marketplace

      This action assign [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. **Scopes**: `phone:write` `phone:write:admin`

      **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license

      POSTAssignCallingPlan

      Request parameters

      • userId*string

      Request body

      • calling_plansarray

    • Assign a [phone number](https://support

      This action assign a [phone number](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers) to a user who has already enabled Zoom Phone. **Scopes**: `phone:write` `phone:write:admin`

      **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license

      POSTAssignPhoneNumber

      Request parameters

      • userId*string

      Request body

      • phone_numbersarray

    • A call queue manager has the privileges to maanage the call queue's voicemail inbox and recordings, change all call queue settings and call queue policy settings

      This action a call queue manager has the privileges to maanage the call queue's voicemail inbox and recordings, change all call queue settings and call queue policy settings.

      Use this API to to set another phone user as the [call queue manager](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues#h_db06854b-e6a3-4afe-ba15-baf58f31f90c). **Prerequisites:**
      * Pro or higher account plan. * Account owner or admin permissions * Zoom Phone license
      **Scopes:** `phone:write:admin`

      PUTChangeCallQueueManager

      Request parameters

      • callQueueId*string

        Unique Identifier of the Call Queue.

      Request body

      • member_idstring

        Unique Identifier (userId) or email address of the user who will be the new call queue manager.

    • The [main company number](https://support

      This action the [main company number](https://support.zoom.us/hc/en-us/articles/360028553691) can be used by external callers to reach your phone users (by dialing the main company number and the user's extension). It can also be used by phone users in your account as their caller ID while making calls.

      Use this API to [change the main company number](https://support.zoom.us/hc/en-us/articles/360028553691#h_82414c34-9df2-428a-85a4-efcf7f9e0d72) of an account.

      **Prerequisites:**
      * Pro or higher account plan. * Account owner or admin permissions
      **Scopes:** `phone:write:admin`

      PUTChangeMainCompanyNumber

      Request body

      • phone_numberstring

        Provide either the unique identifier of the phone number (id) or the phone number itself in e164 format (e.g: +199955500123).

    • An auto receptionist answers calls with a personalized recording and routes calls to a phone user, call queue, common area phone, or voicemail

      This action an auto receptionist answers calls with a personalized recording and routes calls to a phone user, call queue, common area phone, 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.
      Use this API to [change 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 display name and extension number assigned to the main auto receptionist.

      **Prerequisites:**
      * Pro or higher account with Zoom Phone license.
      **Scopes:** `phone:write:admin`

      PATCHUpdateAutoReceptionist

      Request parameters

      • autoReceptionistId*string

        Unique Identifier of the Auto Receptionist. It can be retrieved from the [List Sites API](https://marketplace.zoom.us/docs/api-reference/zoom-api/phone-site/listphonesites).

      Request body

      • extension_numberinteger

        Extension number to be assigned to the auto receptionist. If site code is enabled, provide the short extension number instead.

      • namestring

        Display name of the auto receptionist.

    • A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account

      This action 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.
      Use this API to update information on the blocked list.
      **Prerequisites:** * Pro or higher account plan with Zoom phone license
      **Scope:** `phone:write:admin`

      PATCHUpdateBlockedList

      Request parameters

      • blockedListId*string

        Unique Identifier for the blocked list.

      Request body

      • block_typestring

        State whether you want the block type to be inbound or outbound.
        `inbound`: Pass this value to prevent the blocked number or prefix from calling in to phone users.
        `outbound`: Pass this value to prevent phone users from calling the blocked number or prefix.

      • commentstring

        Provide a comment to help you identify the blocked number or prefix.

      • match_typestring

        Specify the match type for the blocked list. The values can be one of the following:

        `phoneNumber`: Choose this option (Phone Number Match) if you want to block a specific phone number. Then, in the `phone_number` field, provide the phone number along with the country code.

        `prefix`: Choose this option (Prefix Match) if you want to block all numbers with a specific country code and area code. Next, in the `phone_number` field, enter a country code as part of the prefix. For example, entering 1907 blocks numbers with country code 1 and area code 907.

      • phone_numberstring

        The phone number to be blocked if you passed "phoneNumber" as the value for the `match_type` field. If you passed "prefix" as the value for the `match_type` field, provide the prefix of the phone number here including the country code. For example, entering 1905 blocks numbers with country code 1 and area code 905.

      • statusstring

        Enable or disable the blocking. One of the following values are allowed:
        `active`: Keep the blocking active.
        `inactive`: Disable the blocking.

    • Call queues allow you to route incoming calls to a group of users

      This action 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 update information of a specific Call Queue.
      **Prerequisites:**
      * Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license
      **Scopes:** `phone:write:admin`

      PATCHUpdateCallQueue

      Request parameters

      • callQueueId*string

        Unique Identifier of the Call Queue.

      Request body

      • descriptionstring

        Description for the Call Queue.

      • extension_numberinteger

        Phone extension number for the site.
        If a site code has been [assigned](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_79ca9c8f-c97b-4486-aa59-d0d9d31a525b) to the site, provide the short extension number instead of the original extension number.

      • namestring

        Name of the Call Queue.

      • site_idstring

        Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) where the Call Queue is assigned.

      • statusstring

        Status of the Call Queue. Allowed values:
        `active`
        `inactive`

      • timezonestring

        [Timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones) of the Call Queue.

    • A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it

      This action a common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don't belong to a specific employees, you could add a common area phone so that any person can use it.
      Use this API to update details on a specific [common area phone](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones) in an account.

      **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:** `phone:write:admin`

      PATCHUpdateCommonAreaPhone

      Request parameters

      • commonAreaPhoneId*string

      Request body

      • display_namestring

        Display name of the common area phone.

      • extension_numberinteger

        Extension number of the phone. If site code is enabled, provide short extension number instead.

      • mac_addressstring

        Mac address or serial number of the device. Examples of supported format: "64-16-7f-37-90-92" or "64167f379092".

      • site_idstring

        Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) to which the common area desk phone is assigned.

    • Update information of a [desk phone device](https://support

      This action update 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:** `phone:write:admin`

      PATCHUpdateADevice

      Request parameters

      • deviceId*string

        Unique Identifier of the Device.

      Request body

      • assigned_tostring

        User ID or email address of the user to whom this device is to be assigned. The User ID and the email of the user can be retrieved using the [List Users](https://marketplace.zoom.us/docs/api-reference/zoom-api/users/users) API.

      • display_namestring

        Display name of the desk phone.

      • mac_addressstring

        The MAC address of the desk phone.
        Note: If you're using a wireless phone, enter the wired MAC address, not the wireless MAC address.

    • Site allow you to organize Zoom Phone users in your organization

      This action sites allow you to organize Zoom Phone users in your organization. Use this API to update information about 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. * **Scope:** `phone:write:admin`

      PATCHUpdateSiteDetails

      Request parameters

      • siteId*string

        Unique Identifier of the Site.

      Request body

      • namestring

        Name of the site.

      • site_codeinteger

        [Site Code](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_79ca9c8f-c97b-4486-aa59-d0d9d31a525b).

    • Update a [Zoom Phone](https://support

      This action update a [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051-Zoom-Phone) user's profile. **Scopes:** `phone:write` `phone:write:admin`

      **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license

      PATCHUpdateUserProfile

      Request parameters

      • userId*string

      Request body

      • extension_numberstring

        The extension number of the user. The number must be complete (i.e. site number + short extension).

      • site_idstring

        Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672) where the user should be moved/assigned.

    • Unassign all phone numbers that were previously assigned to an [auto receptionist](https://support

      This action unassign 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:** `phone:write:admin`

      DELETEUnassignAllPhoneNumsAutoReceptionist

      Request parameters

      • autoReceptionistId*string

    • Unassign a specific phone number that was previously assigned to an [auto receptionist](https://support

      This action unassign 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:** `phone:write:admin`

      DELETEUnassignAPhoneNumAutoReceptionist

      Request parameters

      • autoReceptionistId*string

        Unique identifier of the auto receptionist. This can be retrieved from the List Phone Sites API.

      • phoneNumberId*string

        Unique Identifier of the phone number or provide the actual phone number in e164 format (example: +19995550123).

    • A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account

      This action 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).
      Use this API to delete a blocked list and therefore removing the associated number from the blocked list. The number will be unblocked after the deletion.
      **Prerequisites:** * Pro or higher account plan with Zoom phone license
      **Scope:** `phone:write:admin`

      DELETEDeleteABlockedList

      Request parameters

      • blockedListId*string

        Unique Identifier of the blocked list. This can be retrieved from the List Blocked List API.

    • Call queues allow you to route incoming calls to a group of users

      This action 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:** `phone:write:admin`

      DELETEDeleteACallQueue

      Request parameters

      • callQueueId*string

        Unique Identifier of the call queue.

    • Use this API to remove all members from a Call Queue who were previously assigned to that Call Queue

      This action use this API to remove all members from a Call Queue who were previously assigned to that Call Queue. The members could be phone users or [common area phones](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones). **Prerequisites:**
      * Pro or higher account plan. * Zoom Phone license
      **Scopes:** `phone:write:admin`

      DELETEUnassignAllMembers

      Request parameters

      • callQueueId*string

    • Use this API to remove a member from a Call Queue who was previously added to that Call Queue

      This action use this API to remove a member from a Call Queue who was previously added to that Call Queue. The member could be a phone user or a [common area phone](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones). A member who is a Call Queue Manager cannot be unassigned from the Call Queue using this API. **Prerequisites:**
      * Pro or higher account plan. * Zoom Phone license
      **Scopes:** `phone:write:admin`

      DELETEUnassignMemberFromCallQueue

      Request parameters

      • callQueueId*string

        Unique Identifier of the Call Queue from which the member needs to be unassigned.

      • memberId*string

        Unique Identifier of the member who needs to be unassigned.

    • Use this API to unbind all phone numbers that are assigned to a [Call Queue](https://support

      This action use this API to unbind 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:** `phone:write:admin`

      DELETEUnassignAPhoneNumCallQueue

      Request parameters

      • callQueueId*string

        Unique Identifier of the Call Queue. This can be retrieved from List Call Queues API.

    • After assigning a phone number, you can unbind it if you don't want it to be assigned to a [Call Queue](https://support

      This action 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). Use this API to unbind a phone number from a Call Queue. 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:** `phone:write:admin`

      DELETEUnAssignPhoneNumCallQueue

      Request parameters

      • callQueueId*string

        Unique Identifier of the Call Queue. This can be retrieved from the List Call Queues API.

      • phoneNumberId*string

        Unique Identifier of the Phone Number.

    • A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it

      This action a common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don't belong to a specific employees, you could add a common area phone so that any person can use it.
      Use this API to remove the [common area phone](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones) from Zoom Phone System in an account.

      **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:** `phone:write:admin`

      DELETEDeleteCommonAreaPhone

      Request parameters

      • commonAreaPhoneId*string

        Unique Identifier of the common area phone.

    • Remove a [desk phone device](https://support

      This action remove a [desk phone device](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:** `phone:write:admin`

      DELETEDeleteADevice

      Request parameters

      • deviceId*string

        Unique Identifier of the device.

    • Site allow you to organize Zoom Phone users in your organization

      This action sites allow you to organize Zoom Phone users in your organization. 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.
      **Scope:** `phone:write:admin`

      DELETEDeletePhoneSite

      Request parameters

      • siteId*string

        Unique Identifier of the Site.

      • transfer_site_id*string

        The Site ID of another site where the assets of the current site (users, numbers and phones) can be transferred to.

    • Unassign a [calling plan](https://marketplace

      This action unassign a [calling plan](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) that was previously assigned to a [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051) user. **Scopes**: `phone:write` `phone:write:admin`

      **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license

      DELETEUnassignCallingPlan

      Request parameters

      • type*string

        The [type](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) of the calling plan that was assigned to user. (e.g: The value of type would be "200" for Unlimited US/Canada calling plan.)

      • userId*string

    • Unassign [phone number](https://support

      This action unassign [phone number](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers#h_38ba8b01-26e3-4b1b-a9b5-0717c00a7ca6) of a Zoom phone user.
      After assigning a phone number, you can remove it if you don't want it to be assigned to anyone. **Scopes**: `phone:write` `phone:write:admin`

      **Prerequisite:** 1. Business or Enterprise account 2. A Zoom Phone license 3. User must have been previously assigned a Zoom Phone number.

      DELETEUnassignPhoneNumber

      Request parameters

      • userId*string

        Provide either userId or email address of the user.

      • phoneNumberId*string

        Provide either phone number or phoneNumberId of the user.

  • rooms

    • Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing

      This action 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**: `room:read:admin`

      GETListZoomRooms

      Request parameters

      • statusstring

        The status of the Zoom Room.

      • typestring

        Type of the Zoom Rooms.

      • unassigned_roomsboolean

        Use this query parameter with a value of `true` if you would like to see Zoom Rooms in your account that have not been assigned to anyone yet.

      • page_sizeinteger

        The number of records returned within a single API call.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

      • location_idstring

        Parent location ID of the Zoom Room.

    • Get details on the account profile of a Zoom Room

      This action 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 [Get Zoom Room Profile API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms/getzrprofile) instead. **Prerequisites:**
      * Zoom account owner or Zoom Rooms admin permissions
      **Scopes:** `room:read:admin`

      GETGetZRAccountProfile
    • Get details on Account Settings of a Zoom Room

      This action get details on Account Settings of a Zoom Room. With this API, you can view either the **Account Meeting Settings** or the **Alert Settings** (Client Alert Settings and Notfication 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:** `room:read:admin`

      GETGetZRAccountSettings

      Request parameters

      • setting_type*string

        The type of setting that you would like to retrieve.
        `alert`: Alert Settings applied on the Zoom Rooms Account.
        `meeting`: Meeting settings of the Zoom Rooms Account.

    • A Zoom account owner or a Zoom Room administrator can establish a [location hierarchy](https://support

      This action 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:** `room:read:admin`

      GETListZRLocations

      Request parameters

      • parent_location_idstring

        A unique identifier for the parent location. For instance, if a Zoom Room is located in Floor 1 of Building A, the location of Building A will be the parent location of Floor 1. Use this parameter to filter the response by a specific location hierarchy level.

      • typestring

        Use this field to filter the response by the type of location. The value can be one of the following: `country`, `states`, `city`, `campus`, `building`, `floor`.

      • page_sizeinteger

        The number of records returned within a single API call.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

    • Get the [location hierarchial structure(s)](https://support

      This action 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:** `room:read:admin`

      GETGetZRLocationStructure
    • Each location type of the [Zoom Rooms location hierarchy](https://support

      This action 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 retrieve 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:** `room:read:admin`

      GETGetZRLocationProfile

      Request parameters

      • locationId*string

        Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response).

    • Get information on meeting or alert settings applied to Zoom Rooms located in a specific location

      This action get information on meeting or alert 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:** `room:read:admin`

      GETGetZRLocationSettings

      Request parameters

      • setting_type*string

        The type of setting that you would like to retrieve.
        `alert`: Alert Settings applied on the Zoom Rooms Account.
        `meeting`: Meeting settings of the Zoom Rooms Account.

      • locationId*string

        Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response).

    • Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing

      This action 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**: `room:read:admin`

      GETGetZRProfile

      Request parameters

      • roomId*string

        Unique Identifier of the Zoom Room. This can be retrieved from the response of [List Zoom Rooms](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms/listzoomrooms) API.

    • List information about the devices that are being used for a specific [Zoom Room](https://support

      This action 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**: `room:read:admin`

      GETListZRDevices

      Request parameters

      • roomId*string

        Unique Identifier of the Zoom Room. This can be retrieved from the response of [List Zoom Rooms](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms/listzoomrooms) API.

    • Get information on meeting or alert settings applied to a specific Zoom Room

      This action get information on meeting or alert 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:** `room:read:admin`

      GETGetZRSettings

      Request parameters

      • setting_type*string

        The type of setting that you would like to retrieve.
        `alert`: Alert Settings applied on the Zoom Rooms Account.
        `meeting`: Meeting settings of the Zoom Rooms Account.

      • roomId*string

        Unique identifier of the Zoom Room.

    • Use this API to [add a Zoom Room](https://support

      This action 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**: `room:write:admin`

      POSTAddARoom

      Request body

      • name*string

        Name of the Zoom Room.

      • type*string

        Type of the Zoom Room.

      • location_idstring

        **Optional**
        Location ID of the lowest level location in the [location hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) where the Zoom Room is to be added. For instance if the structure of the location hierarchy is set up as “country, states, city, campus, building, floor”, a room can only be added under the floor level location. This ID can be retrieved from the [List Zoom Room Locations](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) API.

    • Add a location to the [location hierarchial structure(s)](https://support

      This action 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:** `room:write:admin`

      POSTAddAZRLocation

      Request body

      • namestring

        Name of the location. The name must be unique and shouldn't have already been used in the same account.

      • parent_location_idstring

        The location ID of the location that is a level higher from the location that is being added.

        For example, to add a City named "City 1" as the child location under a State named "State 1", you must provide the location ID of "State 1". This can be retrieved using the [List Zoom Room Locations](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) API.

    • An account owner of a Zoom account can establish a [Zoom Rooms Location Hierarchy](https://support

      This action 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 accross various location. 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:** `room:write:admin`

      /n

      PUTChangeParentLocation

      Request parameters

      • locationId*string

      Request body

      • parent_location_idstring

        Location ID of the new Parent Location under which you the child location will be positioned. This can be retrieved from the [List Zoom Room Locations](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) API.

    • An account owner of a Zoom account can establish a [Zoom Rooms Location Hierarchy](https://support

      This action 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 accress various location. 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:** `room:write:admin`

      PUTChangeZRLocation

      Request parameters

      • roomId*string

        Unique Identifier of the Zoom Room.

      Request body

      • location_idstring

        Location ID of the location where Zoom Room is to be assigned. This can be retrieved from the `id` property in the response of [List Zoom Rooms Locations](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) API.

    • Update information on the account profile of a Zoom Room

      This action 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 [Update Zoom Room Profile API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms/updatezrprofile) instead. **Prerequisites:**
      * Zoom account owner or Zoom Rooms admin permissions
      **Scopes:** `room:write:admin`

      PATCHUpdateZRAccProfile

      Request body

      • basicobject

    • Update account settings applied for Zoom Rooms in a Zoom account

      This action update account settings applied for Zoom Rooms in a Zoom account. With this API, you can update either the **Account Meeting Settings** or the **Alert Settings** (Client Alert Settings and Notfication 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:** `room:write:admin`

      PATCHUpdateZoomRoomAccSettings

      Request parameters

      • setting_type*string

        The type of setting that you would like to update.
        `alert`: Alert Settings applied on the Zoom Rooms Account.
        `meeting`: Meeting settings of the Zoom Rooms Account.

      Request body

      • zoom_roomsobject

    • Update the [location hierarchial structure(s)](https://support

      This action 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:** `room:write:admin`

      PATCHUpdateZoomRoomsLocationStructure

      Request body

      • structuresarray

        Location Structure. The value can be either one or a combination of the following strings separated by comma: `country`, `state`, `city`, `campus`, `building`, `floor`

    • Each location type of the [Zoom Rooms location hierarchy](https://support

      This action 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:** `room:write:admin`

      PATCHUpdateZRLocationProfile

      Request parameters

      • locationId*string

        Unique Identifier of the location. This can be retrieved from the [List Zoom Room Locations](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) API.

      Request body

      • basicobject

    • Update information on either meeting or alert settings applied to Zoom Rooms located in a specific location

      This action update information on either meeting or alert 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:** `room:write:admin`

      PATCHUpdateZRLocationSettings

      Request parameters

      • setting_type*string

        The type of setting that you would like to update.
        `alert`: Alert Settings applied on the Zoom Rooms Account.
        `meeting`: Meeting settings of the Zoom Rooms Account.

      • locationId*string

        Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response).

      Request body

      • zoom_roomsobject

    • Update basic information on a specific Zoom Room in a Zoom account

      This action 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**: `room:write:admin`

      PATCHUpdateRoomProfile

      Request parameters

      • roomId*string

        Unique Identifier of a Zoom Room.

      Request body

      • basicobject

    • Update either meeting or alert settings applied to a specific Zoom Room

      This action update either meeting or alert 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:** `room:write:admin`

      PATCHUpdateZRSettings

      Request parameters

      • roomId*string

        Unique Identifier of the Zoom Room.

      • setting_typestring

        The type of setting that you would like to update.
        `alert`: Alert Settings applied on the Zoom Rooms Account.
        `meeting`: Meeting settings of the Zoom Rooms Account.

      Request body

      • zoom_roomsobject

    • [Remove](https://support

      This action [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**: `room:write:admin`

      DELETEDeleteAZoomRoom

      Request parameters

      • roomId*string

        Unique Identifier of a Zoom Room.

  • roles

    • List [roles](https://support

      This action list [roles](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) on your account **Scopes:** `role:read:admin`

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

      GETRoles
    • Each Zoom user automatically has a role which can either be owner, administrator, or a member

      This action 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 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-requisite:**
      * A Pro or higher plan.
      * For role management and updates, you must be the Account Owner or user with role management permissions. **Scopes:** `role:read:admin`

      GETGetRoleInformation

      Request parameters

      • roleId*string

        Role Id.

    • User [roles](https://support

      This action 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. **Scope:** `role:read:admin`

      **Prerequisites:**
      * A Pro or a higher plan.

      GETRoleMembers

      Request parameters

      • roleId*string

        The role ID

    • Each Zoom user automatically has a role which can either be owner, administrator, or a member

      This action each Zoom user automatically has a role which can either be owner, administrator, or a member. **Pre-requisite:**
      * 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:** `role:write:admin`

      POSTCreateRole

      Request body

      • descriptionstring

        Description of the role.

      • namestring

        Name of the role.

      • privilegesarray

        Privileges assigned to the role. Can be one or a combination of [these permissions](https://marketplace.zoom.us/docs/api-reference/other-references/privileges).

    • User [roles](https://support

      This action 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. **Scopes:** `role:write:admin`

      **Prerequisites:**
      * A Pro or a higher plan.

      POSTAddRoleMembers

      Request parameters

      • roleId*string

        The role ID

      Request body

      • membersarray

        Array of userId/user email of users to whom you would like to assign this role. Upto 30 users can be assigned a role at once.

    • Each Zoom user automatically has a [role](https://support

      This action 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:** `role:write:admin`

      PATCHUpdateRole

      Request parameters

      • roleId*string

        Role Id

      Request body

      • descriptionstring

        Description of the role.

      • idstring

        Role Id.

      • namestring

        Name of the role.

      • privilegesarray

        Privileges assigned to the role. Can be one or a combination of [these permissions](https://marketplace.zoom.us/docs/api-reference/other-references/privileges).

      • total_membersinteger

        Total members assigned to that role.

    • Each Zoom user automatically has a role which can either be owner, administrator, or a member

      This action 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:** `role:write:admin`

      DELETEDeleteRole

      Request parameters

      • roleId*string

        Role Id.

    • User [roles](https://support

      This action 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. **Scope:** `role:write:admin`

      **Prerequisites:**
      * A Pro or a higher plan.

      DELETERoleMemberDelete

      Request parameters

      • roleId*string

        The role ID

      • memberId*string

        Member's ID

  • chat

    • Zoom chat [channels](https://support

      This action 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. Use this API to get information about a specific channel.

      Note: This API only supports user-managed OAuth app.


      **Scope:** `chat_channel:read`

      GETGetChannel

      Request parameters

      • channelId*string

        Channel ID: Unique Identifier of a channel.

    • A [channel](https://support

      This action a [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or multiple members. List all the members of a channel using this API.

      Note: This API only supports user-managed OAuth app.


      **Scopes:** `chat_channel:read`

      GETListChannelMembers

      Request parameters

      • channelId*string

        Channel Id.

      • page_sizeinteger

        The number of records returned with a single API call.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

    • Zoom chat [channels](https://support

      This action 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. Use this API to list a user's chat channels.

      Note: This API only supports user-managed OAuth app.


      **Scope**: `chat_channel:read`

      GETGetChannels

      Request parameters

      • page_sizeinteger

        The number of records returned from a single API call.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. The expiration period for this token is 15 minutes.

    • A user under an organization’s Zoom account has internal users listed under Company Contacts in the Zoom Client

      This action 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). Call this API to list all the contacts of a Zoom user. Zoom contacts are categorized 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 will be set as company contact.

      Note: This API only supports user-managed OAuth app.


      **Scope**: `chat_contact:read`

      GETGetUserContacts

      Request parameters

      • typestring

        The type of contact. The value can be one of the following: `company`: Contacts from the user's organization. `external`: External contacts.

      • page_sizeinteger

        The number of records returned with a single API call.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

    • A user under an organization’s Zoom account has internal users listed under Company Contacts in the Zoom Client

      This action 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). Call this API to get information on a specific contact of the Zoom user.

      Note: This API only supports user-managed OAuth app.


      **Scope**: `chat_contact:read`

      GETGetUserContact

      Request parameters

      • contactId*string

        The user's contact Id or email address. The contact can be either a company contact or an external contact.

      • query_presence_statusboolean

        The presence status of the contact. Include this query parameter with a value of `true` to get the presence status of the contact in the response.

    • A Zoom user can have conversations with other Zoom users via chat

      This action a Zoom user can have conversations with other Zoom users via chat. Use this API to list the current user's chat messages between the user and an individual contact or a chat channel.
      In the query parameter, you must provide either of the following:
      * `to_contact`: The email address of the contact with whom the user conversed by sending/receiving messages. * `to_channel`: The channel ID of the channel to/from which the user has sent and/or received messages.
      **Specify a date** in the `date` query parameter to view messages from that date. If a date is not provided, the default value for the query will be the **current date**.

      Note: This API only supports user-managed OAuth app.



      **Scopes:** `chat_message:read`

      GETGetChatMessages

      Request parameters

      • userId*string

      • to_contactstring

        The email address of a chat contact with whom the current user chatted. Messages that were sent and/or received between the user and the contact is displayed. Note: You must provide either `contact` or `channel` as a query parameter to retrieve messages either from an individual or a chat channel.

      • to_channelstring

        The channel Id of a channel inside which current user had chat converstations. Messages that were sent and/or received between the user and the channel is displayed. Note: You must provide either `contact` or `channel` as a query parameter to retrieve messages either from an individual or a chat channel.

      • date string

        The query date for which you would like to get the chat messages.

      • page_sizeinteger

        The number of records returned with a single API call.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

    • A [channel](https://support

      This action a [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or multiple members. Use this API to invite members that are in your contact list to a channel. The maximum number of members that can be added at once with this API is 5.

      Note: This API only supports user-managed OAuth app.


      **Scope:** `chat_channel:write`

      POSTInviteChannelMembers

      Request parameters

      • channelId*string

        Channel ID: Unique Identifier of the channel.

      Request body

      • membersarray

        Members of a channel. You can invite up to a max number of 5 members with a single API call.

    • A [channel](https://support

      This action a [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or multiple members. Use this API to join a channel that is open for anyone in the same organization to join. You cannot use this API to join private channels that only allows invited members to be a part of it.

      Note: This API only supports user-managed OAuth app.


      **Scope:** `chat_channel:write`

      POSTJoinChannel

      Request parameters

      • channelId*string

        Channel Id.

    • Zoom chat channels allow users to communicate via chat in private or public groups

      This action zoom chat channels allow users to communicate via chat in private or public groups. Use this API to create a channel for a user.

      Note: This API only supports user-managed OAuth app.


      **Scopes**: `chat_channel:write`

      POSTCreateChannel

      Request body

      • membersarray

        Member(s) to include in the channel. A max of 5 members can be added to the channel at once with this API.

      • namestring

        Name of the channel.

      • typeinteger

        Type of the channel. The value can be one of the following:
        `1`: Private channel. In this type of channel, members must be invited to join a channel.
        `2`: Private channel with members that belong to one Zoom account. Members in this channel should be invited and the members should be from the same organization.
        `3`: Public channel. Anyone can search for this channel and join the channel.
        `4`: New chat. This is an instant channel which can be created by adding members to a new chat.

    • Send chat messages on Zoom to either an individual user who is in your contact list or to a [channel](https://support

      This action send chat messages on Zoom to either an individual user who is 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. To send a message to a contact, provide the contact's email address in the `to_contact` field. Similary, to send a message to a channel, provide the Channel Id of the Channel in `to_channel` field.

      **Scopes:** `chat_message:write`

      Note: This API only supports user-managedOAuth app.


      POSTSendaChatMessage

      Request body

      • message*string

        The message to be sent.

      • to_channelstring

        The Channel Id of the channel where you would like to send a message.

      • to_contactstring

        The email address of the contact to whom you would like to send the message.

    • Each chat message has a unique identifier

      This action each chat message has a unique identifier. Use this API to edit a chat message that you previously sent to either a contact or a channel in Zoom by providing the ID of the message as the value of the `messageId` parameter. The ID can be retrieved from List User's Chat Messages API. Additionally, as a query parameter, you must provide either the **email address** of the contact or the **Channel ID** of the channel where the message was sent.

      Note: This API only supports user-managed OAuth app.


      **Scope:** `chat_message:write`

      PUTEditMessage

      Request parameters

      • messageId*string

        Message ID: Unique Identifier of the message.

      Request body

      • messagestring

        The edited message.

      • to_channelstring

        The Channel ID of the channel where you sent the message.
        You must provide either `to_contact` or `to_channel` parameter in the API request. Channel ID can be retrieved from List User's Channels API.

      • to_contactstring

        The email address of the contact to whom the message was sent.
        You must provide either `to_contact` or `to_channel` parameter in the API request.

    • Zoom chat channels allow users to communicate via chat in private or public channels

      This action zoom chat channels allow users to communicate via chat in private or public channels. Use this API to update the name of a specific channel that you created.

      Note: This API only supports user-managed OAuth app.


      **Scope:** `chat_channel:write`

      PATCHUpdateChannel

      Request parameters

      • channelId*string

        Channel Id.

      Request body

      • name*string

        A new name for the channel.

    • Zoom chat [channels](https://support

      This action 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. Use this API to delete a specific channel.

      Note: This API only supports user-managed OAuth app.


      **Scope:** `chat_channel:write`

      DELETEDeleteChannel

      Request parameters

      • channelId*string

        Channel ID: Unique Identifier of a channel.

    • If you're no longer interested in being a member of an existing channel, you can leave the channel at any time

      This action if you're no longer interested in being a member of an existing channel, you can leave the channel at any time. Use this API to leave a specific channel. After leaving the channel, you can no longer access information from that channel.

      Note: This API only supports user-managed OAuth app.


      **Scope:** `chat_channel:write`

      DELETELeaveChannel

      Request parameters

      • channelId*string

        Channel ID: Unique Identifier of a channel.

    • A [channel](https://support

      This action A [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or multiple members. Use this API to remove a member from a chat channel.

      **Scopes:** `chat_channel:write`

      Note: This API only supports user-managed OAuth app.


      DELETERemoveAChannelMember

      Request parameters

      • channelId*string

        Unique Identifier of the Channel from where you would like to remove a member. This can be retrieved from the [List Channels API](https://marketplace.zoom.us/docs/api-reference/zoom-api/chat-channels/getchannels).

      • memberId*string

        Email address of the member whom you would like to be remove from the channel.

    • Delete a chat message that you previously sent to a contact or a channel

      This action delete a chat message that you previously sent to a contact or a channel. In the query parameter, you must provide either of the following:
      * `to_contact`: The email address of the contact to whom you sent the message. Use this parameter to delete a message sent to an individual contact in Zoom. * `to_channel`: The channel ID of the channel where you sent the message. Use this parameter to delete a message sent to a channel in Zoom.

      Note: This API only supports user-managed OAuth app.


      **Scope:** `chat_message:write`

      DELETEDeleteChatMessage

      Request parameters

      • messageId*string

        Message ID

      • to_contactstring

        The userId or email address of a chat contact to whom you previously sent the message. Note: You must provide either `to_contact` or `to_channel` as a query parameter to delete a message that was previously sent to either an individual or a chat channel respectively.

      • to_channelstring

        The channel Id of the channel where you would like to send the message. You must provide either `to_contact` or `to_channel` as a query parameter to delete a message that was previously sent to either an individual or a chat channel

  • sip_phones

    • Zoom’ 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

      This action 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. Use this API to list SIP phones on an account.

      **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.
      **Scope:** `sip_phone:read:admin`

      GETListSipPhones

      Request parameters

      • page_numberinteger

        The current page number of returned records.

      • search_keystring

        User name or email address of a user. If this parameter is provided, only the SIP phone system integration enabled for that specific user will be returned. Otherwise, all SIP phones on an account will be returned.

      • page_sizeinteger

        The number of records returned within a single API call.

    • Zoom’ 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

      This action 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. Use this API to enable a user to use SIP 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.
      **Scope:** `sip_phone:write:admin`

      POSTCreateSIPPhone

      Request body

      • authorization_name*string

        Authorization name of the user registered for SIP Phone.

      • domain*string

        The name or IP address of your provider’s SIP domain. (example: CDC.WEB).

      • password*string

        The password generated for the user in the SIP account.

      • proxy_server*string

        IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server.

      • register_server*string

        IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address.

      • user_email*string

        The email address of the user to associate with the SIP Phone. Can add [.win, .mac, .android, .ipad, .iphone, .linux, .pc, .mobile, .pad] at the end of the email (ex. [email protected]) to add accounts for different platforms for the same user.

      • user_name*string

        The phone number associated with the user in the SIP account.

      • voice_mail*string

        The number to dial for checking voicemail.

      • proxy_server2string

        IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server, or empty.

      • proxy_server3string

        IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server, or empty.

      • register_server2string

        IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address.

      • register_server3string

        IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address.

      • registration_expire_timeinteger

        The number of minutes after which the SIP registration of the Zoom client user will expire, and the client will auto register to the SIP server.

      • transport_protocolstring

        Protocols supported by the SIP provider.
        The value must be either `UDP`, `TCP`, `TLS`, `AUTO`.

      • transport_protocol2string

        Protocols supported by the SIP provider.
        The value must be either `UDP`, `TCP`, `TLS`, `AUTO`.

      • transport_protocol3string

        Protocols supported by the SIP provider.
        The value must be either `UDP`, `TCP`, `TLS`, `AUTO`.

    • Zoom’ 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

      This action 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. Use this API to update information of a specific SIP Phone on a Zoom account.

      **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.
      **Scope:** `sip_phone:write:admin`

      PATCHUpdateSIPPhone

      Request parameters

      • phoneId*string

        Unique Identifier of the SIP Phone. This can be retrieved from the List SIP Phones API.

      Request body

      • authorization_name*string

        Authorization name of the user registered for SIP Phone.

      • domain*string

        The name or IP address of your provider’s SIP domain. (example: CDC.WEB).

      • password*string

        The password generated for the user in the SIP account.

      • proxy_server*string

        IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server.

      • proxy_server2*string

        IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server.

      • proxy_server3*string

        IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server.

      • register_server*string

        IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address.

      • register_server2*string

        IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address.

      • register_server3*string

        IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address.

      • user_name*string

        The phone number associated with the user in the SIP account.

      • voice_mail*string

        The number to dial for checking voicemail.

      • registration_expire_timeinteger

        The number of minutes after which the SIP registration of the Zoom client user will expire, and the client will auto register to the SIP server.

      • transport_protocolstring

        Protocols supported by the SIP provider.
        The value must be either `UDP`, `TCP`, `TLS`, `AUTO`.

      • transport_protocol2string

        Protocols supported by the SIP provider.
        The value must be either `UDP`, `TCP`, `TLS`, `AUTO`.

      • transport_protocol3string

        Protocols supported by the SIP provider.
        The value must be either `UDP`, `TCP`, `TLS`, `AUTO`.

    • Zoom’ 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

      This action 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. Use this API to delete a specific SIP phone on a Zoom account.

      **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.
      **Scope:** `sip_phone:read:admin`

      DELETEDeleteSIPPhone

      Request parameters

      • phoneId*string

        Unique Identifier of the SIP Phone. It can be retrieved from the List SIP Phones API.

  • metrics

    • A Cloud Room Connector allows H

      This action 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.



      **Prerequisites:**
      * Business, Education or API Plan. * Room Connector must be enabled on the account.

      **Scopes:** `dashboard_crc:read:admin`

      GETDashboardCRC

      Request parameters

      • from*string

        Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

      • to*string

        End date.

    • Get [metrics](https://support

      This action get [metrics](https://support.zoom.us/hc/en-us/articles/204654719-Dashboard#h_cc7e9749-1c70-4afb-a9a2-9680654821e4) on how users are utilizing the Zoom Chat Client.


      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. **Scope:** `dashboard_im:read:admin`
      **Prerequisites:**
      * Business or a higher plan.

      GETDashboardIM

      Request parameters

      • from*string

        Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

      • to*string

        End date.

      • page_sizeinteger

        The number of records returned within a single API call.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

    • Get information on top 25 Zoom Rooms with issues in a month

      This action 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.
      **Scope:** `dashboard_home:read:admin`

      **Prerequisites:**
      * Business or a higher plan. * Zoom Room must be enabled in the account.

      GETDashboardIssueZoomRoom

      Request parameters

      • from*string

        Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

      • to*string

        End date.

    • Get information about the issues that occured on the Top 25 **Zoom Rooms with issues** in an acount

      This action get information about the issues that occured on the Top 25 **Zoom Rooms with issues** in an acount.
      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. **Scope:** `dashboard_home:read:admin`

      **Prerequisites:**
      * Business or a higher plan. * Zoom Room must be enabled in the account.

      GETDashboardIssueDetailZoomRoom

      Request parameters

      • zoomroomId*string

        The Zoom room ID.

      • from*string

        Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

      • to*string

        End date.

      • page_sizeinteger

        The number of records returned within a single API call.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

    • List total live or past meetings that occurred during a specified period of time

      This action list total live or past meetings that occurred during a specified period of time. This overview will show 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.
      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.
      **Scopes:** `dashboard_meetings:read:admin`
      **Prerequisites:**
      * Business or a higher plan.

      GETDashboardMeetings

      Request parameters

      • from*string

        Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

      • to*string

        End date.

      • typestring

        The meeting types:
        `past` - Past meetings.
        `pastOne` - Past one user meetings.
        `live` - Live meetings.

      • page_sizeinteger

        The number of records returned within a single API call.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

    • Get details on live or past meetings

      This action get details on live or past meetings. This overview will show 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.
      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.
      **Scopes:** `dashboard_meetings:read:admin`

      **Prerequisites:**
      * Business or a higher plan.

      GETDashboardMeetingDetail

      Request parameters

      • meetingId*string

        The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

      • typestring

        The meeting types:
        `past` - Past meetings.
        `pastOne` - Past one user meetings.
        `live` - Live meetings.

    • Get a list of participants from live or past meetings

      This action get a list of participants from live or past meetings.

      If you do not provide the `type` query parameter, the default value will be set to `live` and thus, you will only see metrics for participants in a live meeting, if any meeting is currently being conducted. To view metrics on past meeting participants, provide the appropriate value for `type`.
      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. **Scopes:** `dashboard_meetings:read:admin`

      **Prerequisites:** Business or a higher plan.

      GETDashboardMeetingParticipants

      Request parameters

      • meetingId*string

        The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

      • typestring

        The meeting types:
        `past` - Past meetings.
        `pastOne` - Past one user meetings.
        `live` - Live meetings.

      • page_sizeinteger

        The number of records returned within a single API call.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

    • Get a list of meeting participants from live or past meetings along with the quality of service they recieve during the meeting such as connection quality for sending/receiving video, audio, and shared content

      This action get a list of meeting participants from live or past meetings along with the quality of service they recieve during the meeting such as connection quality for sending/receiving video, audio, and shared content.
      If you do not provide the `type` query parameter, the default value will be set to `live` and thus, you will only see metrics for participants in a live meeting, if any meeting is currently being conducted. To view metrics on past meeting participants, provide the appropriate value for `type`.

      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. **Scopes:** `dashboard_meetings:read:admin`

      **Prerequisites:**
      * Business or a higher plan.

      GETDashboardMeetingParticipantsQOS

      Request parameters

      • meetingId*string

        The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

      • typestring

        The meeting types:
        `past` - Past meetings.
        `live` - Live Meetings.

      • page_sizeinteger

        The number of items returned per page.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

    • Retrieve the sharing and recording details of participants from live or past meetings

      This action retrieve the sharing and recording details of participants from live or past meetings.

      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.
      **Scopes:** `dashboard:read:admin`

      **Prerequisites:**
      * Business or a higher plan.

      GETDashboardMeetingParticipantShare

      Request parameters

      • meetingId*string

        The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

      • typestring

        The meeting types:
        `past` - Past meetings.
        `live` - Live Meetings.

      • page_sizeinteger

        The number of records returned within a single API call.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.

    • Retrieve the quality of service for participants from live or past meetings

      This action retrieve the quality of service for participants from live or past meetings. This data indicates the connection quality for sending/receiving video, audio, and shared content. If nothing is being sent or received at that time, no information will be shown in the fields.

      **Scopes:** `dashboard:read:admin`

      GETDashboardMeetingParticipantQOS

      Request parameters

      • meetingId*string

        The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

      • participantId*string

        Participant ID.

      • typestring

        The meeting types:
        `past` - Past meetings.
        `live` - Live Meetings.

    • List all the live or past webinars from a specified period of time

      This action list all the live or past webinars from a specified period of time.

      **Scopes:** `dashboard:read:admin`
      **Prerequisites:**
      * Business, Education or API Plan with Webinar add-on.

      GETDashboardWebinars

      Request parameters

      • from*string

        Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

      • to*string

        End date.

      • typestring

        The webinar type.

      • page_sizeinteger

        The number of records returned within a single API call.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

    • Retrieve details from live or past webinars

      This action retrieve details from live or past webinars.

      **Scopes:** `dashboard:read:admin`

      **Prerequisites:**
      * Business, Education or API Plan with Webinar add-on.

      GETDashboardWebinarDetail

      Request parameters

      • webinarId*string

        The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

      • typestring

        The webinar type.

    • Retrieve details on participants from live or past webinars

      This action retrieve details on participants from live or past webinars.

      **Scopes:** `dashboard:read:admin`

      **Prerequisites:**
      * Business, Education or API Plan with Webinar add-on.

      GETDashboardWebinarParticipants

      Request parameters

      • webinarId*string

        The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

      • typestring

        The webinar type.

      • page_sizeinteger

        The number of records returned within a single API call.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

    • Retrieve a list of participants from live or past webinars and the quality of service they received

      This action retrieve a list of participants from live or past webinars and the quality of service they received.
      This data indicates the connection quality for sending/receiving video, audio, and shared content. If nothing is being sent or received at that time, no information will be shown in the fields.
      **Scopes:** `dashboard:read:admin`

      **Prerequisites:** * Business, Education or API Plan with Webinar add-on.

      GETDashboardWebinarParticipantsQOS

      Request parameters

      • webinarId*string

        The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

      • typestring

        The webinar type.

      • page_sizeinteger

        The number of items returned per page.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

    • Retrieve the sharing and recording details of participants from live or past webinars

      This action retrieve the sharing and recording details of participants from live or past webinars.

      **Scopes:** `dashboard:read:admin`

      **Prerequisites:**
      * Business, Education or API Plan with Webinar add-on.

      GETDashboardWebinarParticipantShare

      Request parameters

      • webinarId*string

        The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

      • typestring

        The webinar type.

      • page_sizeinteger

        The number of records returned within a single API call.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.

    • Retrieve details on the quality of service that participants from live or past webinars recieved

      This action retrieve details on the quality of service that participants from live or past webinars recieved.
      This data indicates the connection quality for sending/receiving video, audio, and shared content. If nothing is being sent or received at that time, no information will be shown in the fields.
      **Scopes:** `dashboard:read:admin`

      **Prerequisites:**
      * Business, Education or API Plan with Zoom Rooms set up.

      GETDashboardWebinarParticipantQOS

      Request parameters

      • webinarId*string

        The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

      • participantId*string

        Participant ID.

      • typestring

        The webinar type.

    • List information on all Zoom Rooms in an account

      This action list information on all Zoom Rooms in an account.

      **Scopes:** `dashboard_zr:read:admin` **Prerequisites:**
      * Business, Education or API Plan with Zoom Rooms set up.

      GETDashboardZoomRooms

      Request parameters

      • page_sizeinteger

        The number of records returned within a single API call.

      • page_numberinteger

        The current page number of returned records.

    • Get Top 25 issues of Zoom Rooms

      This action get Top 25 issues of Zoom Rooms.
      **Scopes:** `dashboard_zr:read:admin`

      **Prerequisites:**
      * Business, Education or API Plan with Zoom Rooms set up.

      GETDashboardZoomRoomIssue

      Request parameters

      • from*string

        Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

      • to*string

        End date.

    • 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

      This action 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.

      **Scopes:** `dashboard_zr:read:admin`

      **Prerequisites:**
      * Business, Education or API Plan with Zoom Rooms set up.

      GETDashboardZoomRoom

      Request parameters

      • zoomroomId*string

        The Zoom room ID.

      • from*string

        Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

      • to*string

        End date.

      • page_sizeinteger

        The number of records returned within a single API call.

      • page_numberinteger

        The current page number of returned records.

    • Retrieve survey results from [Zoom meetings client feedback](https://support

      This action retrieve survey results from [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. **Scope:** `account:read:admin`

      GETDashboardClientFeedback

      Request parameters

      • from*string

        Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

      • to*string

        End date.

    • Retrieve detailed information on a [Zoom meetings client feedback](https://support

      This action 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. **Scope:** `dashboard_home:read:admin`
      `

      GETDashboardClientFeedbackDetail

      Request parameters

      • feedbackId*string

        Feedback Detail Id

      • fromstring

      • tostring

      • page_sizeinteger

      • next_page_tokenstring

    • If the [End of Meeting Feedback Survey](https://support

      This action 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 API](https://marketplace.zoom.us/docs/api-reference/zoom-api/dashboards/dashboardclientfeedbackdetail).
      **Scopes:** `dashboard:read:admin`

      GETListMeetingSatisfaction

      Request parameters

      • fromstring

        The start date for the query in “yyyy-mm-dd” format.

      • tostring

        The end date for the query in “yyyy-mm-dd” format.

  • im

    • List [IM directory groups](https://support

      This action list [IM directory groups](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management).

      **Scopes**: `imgroup:read:admin`

      GETImGroups
    • Retrieve an [IM directory group](https://support

      This action retrieve an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.

      Scopes: `imgroup:read:admin`

      GETImGroup

      Request parameters

      • groupId*string

        The group ID.
        Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).

    • List the members of an [IM directory group](https://support

      This action list the members of an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management).

      **Scope:** `imgroup:read:admin`

      GETImGroupMembers

      Request parameters

      • groupId*string

        The group ID.
        Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).

      • page_sizeinteger

        The number of records returned within a single API call.

      • page_numberinteger

        The current page number of returned records.

    • Send chatbot messages from your marketplace chatbot app

      This action send chatbot messages from your marketplace chatbot app.

      **Scopes:** `imchat:bot`
      **Authorization Flow**: Client Credentials Flow

      To get authorized, make a POST request to `/oauth/token` endpoint with grant type as `client_credentials`.
      Use `https://api.zoom.us/oauth/token?grant_type=client_credentials` as the endpoint for the request. You will need to send your ClientID and Secret as a Basic base64 encoded AUthorization header. Ex. `Basic base64Encode({client_id}:{client_sceret})`

      Next, use the token recieved (access_token) as a bearer token while making the POST /im/chat/messages request to send chatbot messages.

      Learn more about how to authorize chatbots in the [Chatbot Authorization](https://marketplace.zoom.us/docs/guides/chatbots/authorization) guide.

      POSTSendchatbot

      Request body

      • account_id*string

        Account ID of the authorized account.

      • content*string

        JSON template describing how the message should be displayed for the user. For more information please see our ["Send Message" templates](https://marketplace.zoom.us/docs/guides/chatbots/sending-messages#example-request).

      • robot_jid*string

        Robot JID created when enabling chatbot features on your marketplace app.

      • to_jid*string

        Unique JID of reciever. Can be a group or user.

      • is_markdown_supportboolean

        **Optional**
        Applies the markdown parser to your chatbot message if the value of this field is set to `true`.
        To learn more, refer to the Chatbot message [markdown reference](https://marketplace.zoom.us/docs/guides/chatbots/customizing-messages/message-with-markdown).

      • user_jidstring

        **Optional**
        The UserJID of the user on whose behalf the message is being sent. Use this field to prevent members of a channel from getting notifications that were set up by a user who has left the channel.

      • visible_to_userstring

        **Optional**
        Allow a Chatbot to send a message to a group channel, but have only one designated person in that group channel see the message by providing the person's UserID in this field.

    • Create an [IM directory group](https://support

      This action create an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.

      **Scopes**: `imgroup:write:admin`

      POSTImGroupCreate

      Request body

      • namestring

        Group name: must be unique to one account.

      • search_by_accountboolean

        Members can search for others under same account.

      • search_by_domainboolean

        Members can search for others in the same email domain.

      • search_by_ma_accountboolean

        Members can search for others under same master account, including all sub accounts.

      • typestring

        IM Group types:
        `normal` - Only members can see automatically see the other members of this group. Other people can search for members within this group.
        `shared` - Everyone under an account can see the group members automatically.
        `restricted` - Nobody can see the group or search for members except the members in the group.

    • Add members to an [IM directory group](https://support

      This action add members to an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under an account.

      **Scope:** `imgroup:write:admin`

      POSTImGroupMembersCreate

      Request parameters

      • groupId*string

        The group ID.
        Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).

      Request body

      • membersarray

        List of IM group members.

    • Edit a message that was [sent](https://marketplace

      This action edit a message that was [sent](https://marketplace.zoom.us/docs/api-reference/zoom-api/im-chat/sendchatbot) by your Chatbot app.
      After sending a message using the Send Chatbot Message API, you must store the messageId returned in the response so that you can make edits to the associated message using this API. **Scope:** `imchat:bot`

      **Authorization Flow**: Client Credentials Flow

      To get authorized, make a POST request to `/oauth/token` endpoint with grant type as `client_credentials`.
      Use `https://api.zoom.us/oauth/token?grant_type=client_credentials` as the endpoint for the request. You will need to send your ClientID and Secret as a Basic base64 encoded AUthorization header. Ex. `Basic base64Encode({client_id}:{client_sceret})`

      Next, use the token received (access_token) as a bearer token while making the PUT /im/chat/messages/{message_id} request to edit a chatbot message.

      Learn more about how to authotize chatbots in the [Chatbot Authorization](https://marketplace.zoom.us/docs/guides/chatbots/authorization) guide.

      PUTEditChatbotMessage

      Request parameters

      • message_id*string

        Unique Identifier of the message that needs to be updated. This should be retrieved from the response of [Send Chatbot Message API](https://marketplace.zoom.us/docs/api-reference/zoom-api/im-chat/sendchatbot).

      Request body

      • account_id*string

        The AccountID of the Zoom account to which the message was sent. Retrieve this from the Chatbot request sent to your server as shown in the example [here]( https://marketplace.zoom.us/docs/guides/chatbots/sending-messages).

      • content*string

        JSON template describing how the edited message should be displayed for the user. For more information please see our ["Send Message" templates](https://marketplace.zoom.us/docs/guides/chatbots/sending-messages#example-request).

      • robot_jid*string

        Robot JID created when enabling chatbot features on your marketplace app.

      • is_markdown_supportboolean

        **Optional**
        Enable or disable markdown parser to your chatbot message. Applies the markdown parser to your chatbot message if the value of this field is set to `true`.
        To learn more, refer to the Chatbot message [markdown reference](https://marketplace.zoom.us/docs/guides/chatbots/customizing-messages/message-with-markdown).

      • user_jidstring

        **Optional**
        The UserJID of the user on whose behalf the message is being sent. Use this field to prevent members of a channel from getting notifications that were set up by a user who has left the channel.

    • Update an [IM directory group](https://support

      This action update an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.

      **Scopes**: `imgroup:write:admin`

      PATCHImGroupUpdate

      Request parameters

      • groupId*string

        The group ID.
        Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).

      Request body

      • namestring

        Group name: must be unique to one account.

      • search_by_accountboolean

        Members can search for others under same account.

      • search_by_domainboolean

        Members can search for others in the same email domain.

      • search_by_ma_accountboolean

        Members can search for others under same master account, including all sub accounts.

      • typestring

        IM Group types:
        `normal` - Only group members can automatically see others in their group. Other people can search for members in the group.
        `shared` - Everyone under the account can see the group and members automatically.
        `restricted` - Nobody can see the group or search for members except for the members in the group.

    • Delete a message that was sent by your chatbot app

      This action delete a message that was sent by your chatbot app. **Scopes:** `imchat:bot`
      **Authorization Flow**: Client Credentials Flow

      To get authorized, make a POST request to `/oauth/token` endpoint with grant type as `client_credentials`.
      Use `https://api.zoom.us/oauth/token?grant_type=client_credentials` as the endpoint for the request. You will need to send your ClientID and Secret as a Basic base64 encoded AUthorization header. Ex. `Basic base64Encode({client_id}:{client_sceret})`

      Next, use the token received (access_token) as a bearer token while making the DELETE /im/chat/messages/{message_id} request to delete a message.

      Learn more about how to authotize chatbots in the [Chatbot Authorization](https://marketplace.zoom.us/docs/guides/chatbots/authorization) guide.

      DELETEDeleteAChatbotMessage

      Request parameters

      • message_id*string

      Request body

      • account_id*string

        The AccountID of the Zoom account to which the message was sent. Retrieve this from the Chatbot request sent to your server as shown in the example [here]( https://marketplace.zoom.us/docs/guides/chatbots/sending-messages).

      • robot_jid*string

        The BotJID found in the Chat Subscription Section on the Features page of your App Dashboard.

      • user_jidstring

        The UserJID of the user on whose behalf the message is being sent. Used to prevent members of a channel from getting notifications that were set up by a user who has left the channel.

    • Delete an [IM directory group](https://support

      This action delete an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.

      Scopes: `imgroup:write:admin`

      DELETEImGroupDelete

      Request parameters

      • groupId*string

        The group ID.
        Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).

    • Delete a member from an [IM directory group](https://support

      This action 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`

      DELETEImGroupMembersDelete

      Request parameters

      • groupId*string

        The group ID.
        Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).

      • memberId*string

        The member ID.

  • h323

    • A H

      This action 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:** `h323:read:admin`

      GETDeviceList

      Request parameters

      • page_sizeinteger

        The number of records returned within a single API call.

      • page_numberinteger

        The current page number of returned records.

    • A H

      This action 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:** `h323:write:admin`

      POSTDeviceCreate

      Request body

      • encryption*string

        Device encryption:
        `auto` - auto.
        `yes` - yes.
        `no` - no.

      • ip*string

        Device IP.

      • name*string

        Device name.

      • protocol*string

        Device protocol:
        `H.323` - H.323.
        `SIP` - SIP.

    • A H

      This action 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 edit information of a H.323/SIP device from your Zoom account.

      **Scopes:** `h323:write:admin`

      PATCHDeviceUpdate

      Request parameters

      • deviceId*string

        The device ID.

      Request body

      • encryption*string

        Device encryption:
        `auto` - auto.
        `yes` - yes.
        `no` - no.

      • ip*string

        Device IP.

      • name*string

        Device name.

      • protocol*string

        Device protocol:
        `H.323` - H.323.
        `SIP` - SIP.

    • A H

      This action a H.323 or SIP device can make a video call to a [Room Connector](https://support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to delete a H.323/SIP device from your Zoom account.

      **Scopes:** `h323:write:admin`

      DELETEDeviceDelete

      Request parameters

      • deviceId*string

        The device ID.

  • report

    • Retrieve a list of sign in / sign out activity logs [report](https://support

      This action 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:** `report:read:admin`

      GETReportSignInSignOutActivities

      Request parameters

      • fromstring

        Start date for which you would like to view the activity logs report.

      • tostring

        End date up to which you would like to view the activity logs report.

      • page_sizeinteger

        The number of records to be returned within a single API call

      • next_page_tokenstring

        Next page token is used to paginate through large result sets

    • Get billing reports of a Zoom account

      This action get billing reports of a Zoom account. **Prerequisites:**
      * Pro or a higher account with Billing Report option enabled. **Scopes:** `report:read:admin`, `report:master`

      GETGetBillingReport
    • Get billing invoices reports for a specific billing period

      This action get 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 for. This ID can be retrieved from **Get Billing Reports** API. **Prerequisites:**
      * Pro or a higher account with **Billing Report** option enabled. **Scopes:** `report:read:admin`, `report:master`

      GETGetBillingInvoicesReports

      Request parameters

      • billing_idstring

        Unique Identifier of the Billing Report. Retrieve this ID from the response of **Get Billing Reports** API request.

    • Retrieve cloud recording usage report for a specified period

      This action retrieve cloud recording usage report for a specified period. You can only get cloud recording reports that is one day ealier 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:** `report:read:admin`

      GETReportCloudRecording

      Request parameters

      • from*string

        Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

      • to*string

        End date.

    • Retrieve daily report to access the account-wide usage of Zoom services for each day in a given month

      This action 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:** `report:read:admin`

      GETReportDaily

      Request parameters

      • yearinteger

        Year for this report

      • monthinteger

        Month for this report

    • Get a detailed report for a past meeting

      This action get a detailed report for a past meeting.
      **Scopes:** `report:read:admin`
      **Prerequisites:**
      * Pro or a higher plan.

      GETReportMeetingDetails

      Request parameters

      • meetingId*string

        The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

    • Get participant report for a past meeting

      This action get participant report for a past meeting.

      **Scopes:** `report:read:admin`
      **Prerequisites:**
      * Pro or a higher plan.

      GETReportMeetingParticipants

      Request parameters

      • meetingId*string

        The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

      • page_sizeinteger

        The number of records returned within a single API call.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

    • Retrieve a report of [poll](https://support

      This action retrieve a report of [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) results for a past meeting.

      **Scopes:** `report:read:admin`
      **Prerequisites:**
      * Pro or a higher plan.

      GETReportMeetingPolls

      Request parameters

      • meetingId*string

        The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

    • The [Operations Logs](https://support

      This action 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.
      **Scopes:** `report:read:admin`

      **Prerequisites:**
      * Pro or higher plan.

      GETReportOperationLogs

      Request parameters

      • from*string

        Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

      • to*string

        End date.

      • page_sizeinteger

        The number of records returned within a single API call.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

    • The Telephone report 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

      This action the Telephone report 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. **Scopes:** `report:read:admin`

      **Prerequisites:**
      * Pro or higher plan.

      GETReportTelephone

      Request parameters

      • from*string

        Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

      • to*string

        End date.

      • typestring

        Audio types:
        `1` - Toll-free Call-in & Call-out. `3` - SIP Connected Audio

      • page_sizeinteger

        The number of records returned within a single API call.

      • page_numberinteger

        The current page number of returned records.

    • A user is considered to be an active host during the month specified in the "from" and "to" range, if the user has hosted at least one meeting during this period

      This action a user is considered to be an active host during the month specified in the "from" and "to" range, if the user has hosted at least one meeting during this period. If the user didn't host any meetings during this period, the user is considered to be inactive.
      The Active Hosts report displays a list of meetings, participants, and meeting minutes for a specific time range, up to one month. The month should fall within the last six months.
      The Inactive Hosts report pulls a list of users who were not active during a specific period of time. Use this API to retrieve an active or inactive host report for a specified period of time. The time range for the report is limited to a month and the month should fall under the past six months.
      You can specify the type of report and date range using the query parameters.
      **Scopes:** `report:read:admin`

      **Prerequisites:**
      * Pro or higher plan.

      GETReportUsers

      Request parameters

      • from*string

        Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

      • to*string

        End date.

      • typestring

        Active or inactive hosts.
        `active` - Active hosts.
        `inactive` - Inactive hosts.

      • page_sizeinteger

        The number of records returned within a single API call.

      • page_numberinteger

        The current page number of returned records.

    • Retrieve [report](https://support

      This action retrieve [report](https://support.zoom.us/hc/en-us/articles/216378603-Meeting-Reporting) on a past meeting for a specified period of time. The time range for the report is limited to a month and the month should fall under the past six months. Meetings will only be returned in the response if the meeting has two or more unique participants.

      **Scopes:** `report:read:admin`

      **Prerequisites:**
      * Pro or higher plan.

      GETReportMeetings

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

      • from*string

        Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

      • to*string

        End date.

      • page_sizeinteger

        The number of records returned within a single API call.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

      • typestring

        The meeting types:
        `past` - Past meetings.
        `pastOne` - Past one user meetings.

    • Retrieve a [report](https://support

      This action retrieve a [report](https://support.zoom.us/hc/en-us/articles/201393719-Webinar-Reporting) containing past webinar details.

      **Scopes:** `report:read:admin`

      **Prerequisites:**
      * Pro or higher plan with Webinar add-on.

      GETReportWebinarDetails

      Request parameters

      • webinarId*string

        The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

    • Get detailed report on each attendee of a webinar

      This action get detailed report on each attendee of a webinar.

      **Scopes:** `report:read:admin`

      **Prerequisites:**
      * Pro or a higher plan with Webinar add-on enabled.

      GETReportWebinarParticipants

      Request parameters

      • webinarId*string

        The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

      • page_sizeinteger

        The number of records returned within a single API call.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

    • Retrieve a report on past [webinar polls](https://support

      This action retrieve a report on past [webinar polls](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars).

      **Scopes:** `report:read:admin`

      **Prerequisites:**
      * Pro or a higher plan with Webinar add-on enabled.

      GETReportWebinarPolls

      Request parameters

      • webinarId*string

        The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

    • The Question & Answer (Q&A) feature for webinars allows attendees to ask questions during the webinar and for the panelists, co-hosts and host to answer their questions

      This action the Question & Answer (Q&A) feature for webinars allows attendees to ask questions during the webinar and for the panelists, co-hosts and host to answer their questions. Use this API to retrieve a report on question and answers from past webinars.

      **Scopes:** `report:read:admin`

      **Prerequisites:**
      * Pro or a higher plan with Webinar add-on enabled.

      GETReportWebinarQA

      Request parameters

      • webinarId*string

        The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

  • groups

    • List [groups](https://support

      This action list [groups](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account. **Prerequisite**: Pro or higher account.
      **Scopes**: `group:read:admin`

      GETGroups
    • Get a [group](https://support

      This action get a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account. **Prerequisite**: Pro, Business, or Education account
      **Scopes**: `group:read:admin`

      GETGroup

      Request parameters

      • groupId*string

        The group ID.
        Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).

    • Retrieve a [group's](https://support

      This action 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 planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.

      **Prerequisite**: Pro, Business, or Education account
      **Scopes**: `group:read:admin`

      GETGetGroupLockSettings

      Request parameters

      • groupId*string

        Id of the group.

    • List the members of a [group](https://support

      This action list the members of a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. **Prerequisite**: Pro, Business, or Education account
      **Scopes**: `group:read:admin`

      GETGroupMembers

      Request parameters

      • groupId*string

        The group ID.
        Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).

      • page_sizeinteger

        The number of records returned within a single API call.

      • page_numberinteger

        The current page number of returned records.

    • Get settings for a [group](https://support

      This action get settings for a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-). **Prerequisite**: Pro, Business, or Education account
      **Scopes**: `group:read:admin`

      GETGetGroupSettings

      Request parameters

      • groupId*string

      • optionstring

        `meeting_authentication`: Use this query parameter to view [meeting authentication configuration](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied on the account.
        `recording_authentication`: Use this query parameter to view [recording authentication configuration](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied on the account.

    • Create a [group](https://support

      This action create a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account. **Prerequisite**: Pro or higher account.
      **Scopes**: `group:write:admin`

      POSTGroupCreate

      Request body

      • namestring

        Group name.

    • Add members to a [group](https://support

      This action add members to a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. **Prerequisite**: Pro, Business, or Education account
      **Scopes**: `group:write:admin`

      POSTGroupMembersCreate

      Request parameters

      • groupId*string

        The group ID.
        Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).

      Request body

      • membersarray

        List of Group members

    • Update a [group](https://support

      This action update a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. **Prerequisite**: Pro, Business, or Education account
      **Scopes**: `group:write:admin`

      PATCHGroupUpdate

      Request parameters

      • groupId*string

        The group ID.
        Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).

      Request body

      • namestring

        Group name. It must be unique to one account and less than 128 characters.

    • Update a [group's](https://support

      This action 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 will not be able to modify it individually.


      Note: The `force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.

      **Prerequisite**: Pro, Business, or Education account
      **Scopes**: `group:write:admin`

      PATCHGroupLockedSettings

      Request parameters

      • groupId*string

        The Id of the group.

      Request body

      • email_notificationobject

      • in_meetingobject

      • recordingobject

      • schedule_meetingobject

      • telephonyobject

    • If a user is a member in multiple groups, you can [set a primary group](https://support

      This action if a user is a member in multiple groups, you can [set a primary group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-#h_d07c7dcd-4fd8-485a-b5fe-a322e8d21c09) for the user. The group member will use the primary group's settings by default. However, if settings are locked in other groups, those settings will continue to be locked for that user. By default, the primary group is the first group that user is added to.

      Use this API to perform either of the following tasks: * Simultaneously remove a member from one group and move the member to a different group. * Set a primary group for the user

      **Prerequisites:** * Pro or higher account
      **Scopes:** `group:write:admin`

      PATCHUpdateAGroupMember

      Request parameters

      • groupId*string

        Unique Identifier of the group. Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API.
        To change a member's primary group, provide the groupId of the member's current primary group as the value of this field.
        To remove a member from one group and move the member to another group, provide the groupId of the group from which the member is to be moved.

      • memberId*string

        Unique Identifier of the group member. Can be retrieved by calling the [List Group Members](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groupmembers) API.

      Request body

      • action*string

        Specify the type of action to be performed:

        `move`: Simultaneously remove a member from one group and move the member to a different group.
        `set_primary`: Set a primary group for the user.

      • target_group_idstring

        Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API.
        To move a user, use this field to specify the groupId of the group where the member is to be moved.
        To set a primary group for the user, provide the groupId of the group which is going to be the primary group.

    • Update settings for a [group](https://support

      This action update settings for a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-).


      Note: The `force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.

      **Prerequisite**: Pro, Business, or Education account
      **Scopes**: `group:write:admin`

      PATCHUpdateGroupSettings

      Request parameters

      • groupId*string

        Id of the group.

      • optionstring

      Request body

      • email_notificationobject

      • in_meetingobject

      • recordingobject

      • schedule_meetingobject

      • telephonyobject

    • Delete a [group](https://support

      This action delete a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-). **Prerequisite**: Pro, Business, or Education account
      **Scopes**: `group:write:admin`

      DELETEGroupDelete

      Request parameters

      • groupId*string

        The group ID.
        Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).

    • Delete a member from a [group](https://support

      This action delete a member from a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) in a Zoom account. **Prerequisite**: Pro, Business, or Education account
      **Scopes**: `group:write:admin`

      DELETEGroupMembersDelete

      Request parameters

      • groupId*string

        The group ID.
        Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).

      • memberId*string

        The member ID.

  • webinars

    • Zoom users with a [Webinar Plan](https://zoom

      This action zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.
      Use this API to get details of a scheduled webinar.

      **Scopes:** `webinar:read:admin` `webinar:read`

      **Prerequisites:** * Pro or higher plan with a Webinar Add-on.

      GETWebinar

      Request parameters

      • webinarId*integer

        The webinar ID.

      • occurrence_idstring

        Unique Identifier that identifies an occurrence of a recurring webinar. [Recurring webinars](https://support.zoom.us/hc/en-us/articles/216354763-How-to-Schedule-A-Recurring-Webinar) can have a maximum of 50 occurrences. When you create a recurring Webinar using [Create a Webinar API](https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinarcreate), you can retrieve the Occurrence ID from the response of the API call.

    • Panelist in a Webinar can view and send video, screen share, annotate, etc and do much more compared to attendees in a Webinar

      This action panelists in a Webinar can view and send video, screen share, annotate, etc and do much more compared to attendees in a Webinar. Use this API to list all the panelists of a Webinar.

      **Scopes:** `webinar:read:admin` `webinar:read`

      **Prerequisites:**
      * Pro or a higher plan with [Webinar Add-on](https://zoom.us/webinar).

      GETWebinarPanelists

      Request parameters

      • webinarId*integer

        The webinar ID.

    • List all the [polls](https://support

      This action list all the [polls](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) of a Webinar.

      **Scopes:** `webinar:read:admin` `webinar:read`

      GETWebinarPolls

      Request parameters

      • webinarId*integer

        The webinar ID.

    • Get a webinar's [poll](https://support

      This action get a webinar's [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) details.

      **Scopes:** `webinar:read:admin` `webinar:read`

      GETWebinarPollGet

      Request parameters

      • webinarId*integer

        The webinar ID.

      • pollId*string

        The poll ID

    • Zoom users with a [Webinar Plan](https://zoom

      This action zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a [Webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form before receiving the link to join the Webinar.
      Use this API to list all the users that have registered for a webinar.

      **Prerequisites:** * Pro or higher plan with a Webinar Add-on.
      **Scopes:** `webinar:read:admin` `webinar:read`

      GETWebinarRegistrants

      Request parameters

      • webinarId*integer

        The webinar ID.

      • occurrence_idstring

        The meeting occurrence ID.

      • statusstring

        The registrant status:
        `pending` - Registrant's status is pending.
        `approved` - Registrant's status is approved.
        `denied` - Registrant's status is denied.

      • page_sizeinteger

        The number of records returned within a single API call.

      • page_numberinteger

        The current page number of returned records.

    • Scheduling a [Webinar with registration](https://support

      This action scheduling a [Webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form with fields and questions before they can receive the link to join the Webinar.
      Use this API to list registration questions and fields that are to be answered by users while registering for a Webinar.
      **Prerequisites:**
      * Pro or higher plan with a Webinar Add-on. **Scopes:** `webinar:read:admin` `webinar:read`

      GETWebinarRegistrantsQuestionsGet

      Request parameters

      • webinarId*integer

        The webinar ID.

    • Zoom users with a [Webinar Plan](https://zoom

      This action zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a [Webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form before receiving the link to join the Webinar.
      Use this API to get details on a specific user who has registered for the Webinar.

      **Scopes:** `webinar:read:admin` `webinar:read`

      **Prerequisites:**
      * The account must have a Webinar plan.

      GETWebinarRegistrantGet

      Request parameters

      • webinarId*integer

        The webinar ID.

      • registrantId*string

        The registrant ID.

      • occurrence_idstring

        The meeting occurrence ID.

    • [Webinar Registration Tracking Sources](https://support

      This action [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.
      **Scopes:** `webinar:read:admin`, `webinar:read`

      **Prerequisites**:
      * [Webinar license](https://zoom.us/webinar). * Registration must be required for the Webinar.

      GETGetTrackingSources

      Request parameters

      • webinarId*integer

        The webinar ID.

    • Panelist in a Webinar can view and send video, screen share, annotate, etc and do much more compared to attendees in a webinar

      This action panelists in a Webinar can view and send video, screen share, annotate, etc and do much more compared to attendees in a webinar.
      Use this API to [add panelists](https://support.zoom.us/hc/en-us/articles/115005657826-Inviting-Panelists-to-a-Webinar#h_7550d59e-23f5-4703-9e22-e76bded1ed70) to a scheduled webinar.

      **Scopes:** `webinar:write:admin` `webinar:write`

      **Prerequisites:** * Pro or a higher plan with [Webinar Add-on](https://zoom.us/webinar).

      POSTWebinarPanelistCreate

      Request parameters

      • webinarId*integer

        The webinar ID.

      Request body

      • panelistsarray

        List of panelist objects.

    • Create a [poll](https://support

      This action create a [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) for a webinar.

      **Scopes:** `webinar:write:admin` `webinar:write`

      POSTWebinarPollCreate

      Request parameters

      • webinarId*integer

        The webinar ID.

      Request body

      • questionsarray

        Array of Polls

      • titlestring

        Title for the poll.

    • Zoom users with a [Webinar Plan](https://zoom

      This action zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a [Webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form before receiving the link to join the Webinar.
      Use this API to create and submit the registration of a user for a webinar.

      **Scopes:** `webinar:write:admin` `webinar:write`

      **Prerequisites:** * Pro or higher plan with a Webinar Add-on.

      POSTWebinarRegistrantCreate

      Request parameters

      • webinarId*integer

        The webinar ID.

      • occurrence_idsstring

        Occurrence ID. Get this value from the webinar get API. Multiple values separated by a comma.

      Request body

      • addressstring

        Registrant's address.

      • citystring

        Registrant's city.

      • commentsstring

        A field that allows registrants to provide any questions or comments that they might have.

      • countrystring

        Registrant's country.

      • custom_questionsarray

        Custom questions.

      • emailstring

        A valid email address of the registrant.

      • first_namestring

        Registrant's first name.

      • industrystring

        Registrant's Industry.

      • job_titlestring

        Registrant's job title.

      • last_namestring

        Registrant's last name.

      • no_of_employeesstring

        Number of Employees:
        `1-20`
        `21-50`
        `51-100`
        `101-500`
        `500-1,000`
        `1,001-5,000`
        `5,001-10,000`
        `More than 10,000`

      • orgstring

        Registrant's Organization.

      • phonestring

        Registrant's Phone number.

      • purchasing_time_framestring

        This field can be included to gauge interest of webinar attendees towards buying your product or service. Purchasing Time Frame:
        `Within a month`
        `1-3 months`
        `4-6 months`
        `More than 6 months`
        `No timeframe`

      • role_in_purchase_processstring

        Role in Purchase Process:
        `Decision Maker`
        `Evaluator/Recommender`
        `Influencer`
        `Not involved`

      • statestring

        Registrant's State/Province.

      • zipstring

        Registrant's Zip/Postal Code.

    • Update a webinar's [poll](https://support

      This action update a webinar's [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars).

      **Scopes:** `webinar:write:admin` `webinar:write`

      PUTWebinarPollUpdate

      Request parameters

      • webinarId*integer

        The webinar ID.

      • pollId*string

        The poll ID

      Request body

      • questionsarray

        Array of Polls

      • titlestring

        Title for the poll.

    • Update a webinar registrant's status

      This action update a webinar registrant's status. Using this API, you can specify whether you want to approve a registration, deny a registration or cancel a previously approved registration.

      **Scopes:** `webinar:write:admin` `webinar:write`

      PUTWebinarRegistrantStatus

      Request parameters

      • webinarId*integer

        The webinar ID.

      • occurrence_idstring

        The meeting occurrence ID.

      Request body

      • action*string

        Used to approve, deny, or cancel the webinar registrant.

      • registrantsarray

        List of registrants.

    • Update a webinar's status

      This action update a webinar's status. Use this API to end an ongoing webinar.

      **Scopes:** `webinar:write:admin` `webinar:write`

      **Prerequisites:**
      * The account must hold a valid [Webinar plan](https://zoom.us/webinar).

      PUTWebinarStatus

      Request parameters

      • webinarId*integer

        The webinar ID.

      Request body

      • actionstring

    • Zoom users with a [Webinar Plan](https://zoom

      This action zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.
      Use this API to make updates to a scheduled Webinar.

      **Scopes:** `webinar:write:admin` `webinar:write`

      **Prerequisites:**
      * Pro or higher plan with a Webinar Add-on.

      PATCHWebinarUpdate

      Request parameters

      • webinarId*integer

        The webinar ID.

      • occurrence_idstring

        Webinar occurrence id. Support change of agenda, start_time, duration, settings: {host_video, panelist_video, hd_video, watermark, auto_recording}

      Request body

      • agendastring

        Webinar description.

      • durationinteger

        Webinar duration (minutes). Used for scheduled webinar only.

      • passwordstring

        Webinar password. Password may only contain the following characters: [a-z A-Z 0-9 @ - _ * !]. Max of 10 characters.

      • recurrenceobject

        Recurrence object.

      • settingsstring

      • start_timestring

        Webinar start time, in the format "yyyy-MM-dd'T'HH:mm:ss'Z'." Should be in GMT time. In the format "yyyy-MM-dd'T'HH:mm:ss." This should be in local time and the timezone should be specified. Only used for scheduled webinars and recurring webinars with a fixed time.

      • timezonestring

        Time zone to format start_time. For example, "America/Los_Angeles". For scheduled meetings only. Please reference our [time zone](#timezones) list for supported time zones and their formats.

      • topicstring

        Webinar topic.

      • tracking_fieldsarray

        Tracking fields

      • typeinteger

        Webinar Types:
        `5` - webinar.
        `6` - Recurring webinar with no fixed time.
        `9` - Recurring webinar with a fixed time.

    • Scheduling a [Webinar with registration](https://support

      This action scheduling a [Webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form with fields and questions before they can receive the link to join the Webinar.
      Use this API to update registration questions and fields of a scheduled Webinar that are to be answered by users while registering for a Webinar.

      **Prerequisites:**
      * Pro or higher plan with a Webinar Add-on. * Registration option for Webinar should be set as required to use this API. **Scopes:** `webinar:write:admin` `webinar:write`

      PATCHWebinarRegistrantQuestionUpdate

      Request parameters

      • webinarId*integer

        The webinar ID.

      Request body

      • custom_questionsarray

        Array of Registrant Custom Questions.

      • questionsarray

        Array of registration fields whose values should be provided by registrants during registration.

    • Delete a Webinar

      This action delete a Webinar.

      **Scopes:** `webinar:write:admin` `webinar:write`

      **Prerequisites:**
      * Pro or higher plan with a Webinar Add-on.

      DELETEWebinarDelete

      Request parameters

      • webinarId*integer

        The webinar ID.

      • occurrence_idstring

        The meeting occurrence ID.

    • Remove all the panelists from a Webinar

      This action remove all the panelists from a Webinar.
      **Scopes:** `webinar:write:admin` `webinar:write`

      **Prerequisites:**
      * Pro or a higher plan with [Webinar Add-on](https://zoom.us/webinar).

      DELETEWebinarPanelistsDelete

      Request parameters

      • webinarId*integer

        The webinar ID.

    • [Remove](https://support

      This action [Remove](https://support.zoom.us/hc/en-us/articles/115005657826-Inviting-Panelists-to-a-Webinar#h_de31f237-a91c-4fb2-912b-ecfba8ec5ffb) a single panelist from a webinar.
      You can retrieve the `panelistId` by calling **List Panelists API**.

      **Scopes:** `webinar:write:admin` `webinar:write`

      **Prerequisites:**
      * Pro or a higher plan with [Webinar Add-on](https://zoom.us/webinar).

      DELETEWebinarPanelistDelete

      Request parameters

      • webinarId*integer

        The webinar ID.

      • panelistId*integer

        The panelist ID or panelist email.

    • Delete a webinar's [poll](https://support

      This action delete a webinar's [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars).

      **Scopes:** `webinar:write:admin` `webinar:write`

      DELETEWebinarPollDelete

      Request parameters

      • webinarId*integer

        The webinar ID.

      • pollId*string

        The poll ID

  • past_meetings

    • List files sent via in-meeting chat during a meeting

      This action list files sent via in-meeting chat during a meeting. The in-meeting files are deleted after 24 hours of the meeting completion time.

      **Scope:** `meeting:read`, `meeting:read:admin`

      GETListPastMeetingFiles

      Request parameters

      • meetingId*integer

        The meeting ID.

    • Get a list of ended meeting instances

      **Scopes:** `meeting:read:admin` `meeting:read`

      This action get a list of ended meeting instances

      **Scopes:** `meeting:read:admin` `meeting:read`

      GETPastMeetings

      Request parameters

      • meetingId*integer

        The meeting ID.

    • [Polls](https://support

      This action [Polls](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) allow the meeting host to survey attendees. Use this API to list poll results of a meeting.

      **Scopes**: `meeting:read:admin`, `meeting:read`
      **Prerequisites**:
      * Host user type must be **Pro**. * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.

      GETListPastMeetingPolls

      Request parameters

      • meetingId*string

        The meeting ID or meeting UUID. If meeting ID is provided, it will take the last meeting instance.

    • Get details on a past meeting

      This action get details on a past meeting.

      **Scopes:** `meeting:read:admin` `meeting:read` > **Note**: Please double encode your UUID when using this API if the UUID begins with a '/'or contains '//' in it.

      GETPastMeetingDetails

      Request parameters

      • meetingUUID*string

        The meeting UUID. Please double encode your UUID when using it for other API calls if the UUID begins with a '/'or contains '//' in it.

    • Retrieve information on participants from a past meeting

      This action retrieve information on participants from a past meeting.

      **Scopes:** `meeting:read:admin` `meeting:read` **Prerequisites:**
      * Paid account on a Pro or higher plan.

      **Note**: Please double encode your UUID when using this API if the UUID begins with a '/'or contains '//' in it.

      GETPastMeetingParticipants

      Request parameters

      • meetingUUID*string

        The meeting UUID. Please double encode your UUID when using it for other API calls if the UUID begins with a '/'or contains '//' in it.

      • page_sizeinteger

        The number of records returned within a single API call.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

  • past_webinars

    • List absentees of a webinar

      This action list absentees of a webinar.

      **Scopes:** `webinar:read:admin` `webinar:read`

      GETWebinarAbsentees

      Request parameters

      • WebinarUUID*string

        The webinar UUID. Please double encode your UUID when using it for API calls if the UUID begins with a '/'or contains '//' in it.

      • occurrence_idstring

        The meeting occurrence ID.

      • page_sizeinteger

        The number of records returned within a single API call.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

    • List files sent via in-meeting chat during a meeting

      This action list files sent via in-meeting chat during a meeting. The in-meeting files are deleted after 24 hours of the meeting completion time.

      **Scope:** `webinar:read`, `webinar:read:admin`

      GETListPastWebinarFiles

      Request parameters

      • webinarId*string

    • List past webinar instances

      This action list past webinar instances.

      **Scopes:** `webinar:read:admin` `webinar:read`

      GETPastWebinars

      Request parameters

      • webinarId*integer

        The webinar ID.

    • The polling feature for webinar allows you to create single choice or multiple choice polling questions for your webinars

      This action the polling feature for webinar allows you to create single choice or multiple choice polling questions for your webinars. Use this API to retrieve the results for Webinar Polls of a specific Webinar. **Prerequisites:**
      * [Webinar license](https://zoom.us/webinar)
      **Scopes**: `webinar:read:admin`, `webinar:read`

      GETListPastWebinarPollResults

      Request parameters

      • webinarId*string

        The Webinar ID or Webinar UUID. If the webinar ID is passed, it will take the last webinar instance.

    • The [Question & Answer (Q&A)](https://support

      This action the [Question & Answer (Q&A)](https://support.zoom.us/hc/en-us/articles/203686015-Getting-Started-with-Question-Answer) feature for Webinars allows attendees to ask questions during the Webinar and for the panelists, co-hosts and host to answer their questions.
      Use this API to list Q&A of a specific Webinar. **Prerequisites:**
      * [Webinar license](https://zoom.us/webinar)
      **Scopes**: `webinar:read:admin`, `webinar:read`

      GETListPastWebinarQA

      Request parameters

      • webinarId*string

        The Webinar ID or Webinar UUID. If the webinar ID is passed, it will take the last webinar instance.

  • sip_trunk

    • With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer’s network and the Zoom cloud

      This action with SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer’s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers' IP telephony network, will be connected over this trunk rather than over the PSTN.

      Use this API to list all the internal numbers that are configured for SIP Connected Audio in a Zoom Account. **Prerequisites:**
      * Pro or a higher account with SIP Connected Audio plan enabled. * The account must be a Master Account
      **Scopes:** `sip_trunk:master`

      GETListSipTrunkNumbers
  • meetings

    • Retrieve the details of a meeting

      This action retrieve the details of a meeting.

      **Scopes:** `meeting:read:admin` `meeting:read`

      GETMeeting

      Request parameters

      • meetingId*integer

        The meeting ID.

      • occurrence_idstring

        Meeting occurrence id

    • Retrieve the meeting invite note that was sent for a specific meeting

      This action retrieve the meeting invite note that was sent for a specific meeting.

      **Scopes:** `meeting:read:admin` `meeting:read`

      GETMeetingInvitation

      Request parameters

      • meetingId*integer

        The meeting ID.

    • Poll allow the meeting host to survey attendees

      This action polls allow the meeting host to survey attendees. Use this API to list [polls](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) of a meeting.

      **Scopes**: `meeting:read:admin` `meeting:read`
      **Prerequisites**:
      * Host user type must be **Pro**. * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.

      GETMeetingPolls

      Request parameters

      • meetingId*integer

        The meeting ID.

    • Poll allow the meeting host to survey attendees

      This action polls allow the meeting host to survey attendees. Use this API to get information about a specific meeting [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings).

      **Scopes**: `meeting:read:admin` `meeting:read`

      GETMeetingPollGet

      Request parameters

      • meetingId*integer

        The meeting ID.

      • pollId*string

        The poll ID

    • Get all the [recordings](https://support

      This action get all the [recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording#h_7420acb5-1897-4061-87b4-5b76e99c03b4) from a meeting.

      **Scopes:** `recording:read:admin` `recording:read`

      GETRecordingGet

      Request parameters

      • meetingId*string

        The meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must **double encode** the UUID before making an API request.

    • Cloud Recordings of past Zoom Meetings can be made [on-demand](https://support

      This action 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](https://marketplace.zoom.us/docs/api-reference/zoom-api/cloud-recording/meetingrecordingregistrantcreate) to view these recordings. Use this API to list registrants of **On-demand Cloud Recordings** of a past meeting.
      **Scopes:** `recording:read:admin`, `recording:read`.

      GETMeetingRecordingRegistrants

      Request parameters

      • meetingId*integer

        The meeting ID.

      • statusstring

        The registrant status:
        `pending` - Registrant's status is pending.
        `approved` - Registrant's status is approved.
        `denied` - Registrant's status is denied.

      • page_sizeinteger

        The number of records returned within a single API call.

      • page_numberinteger

        The current page number of returned records.

    • For [on-demand](https://support

      This action for [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) meeting recordings, you can include fields with questions that will be shown to registrants when they register to view the recording. Use this API to retrieve a list of questions that are displayed for users to complete when registering to view the recording of a specific meeting.
      **Scopes:** `recording:read:admin`, `recording:read`

      GETRecordingRegistrantsQuestionsGet

      Request parameters

      • meetingId*string

        The meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must **double encode** the UUID before making an API request.

    • Retrieve settings applied to a meeting's [Cloud Recording](https://support

      This action retrieve settings applied to a meeting's [Cloud Recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording).

      **Scopes**: `recording:read:admin` `recording:read`

      GETRecordingSettingUpdate

      Request parameters

      • meetingId*string

        The meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must **double encode** the UUID before making an API request.

    • A host or a user with admin permission can require [registration for a Zoom meeting](https://support

      This action 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). Use this API to list users that have registered for a meeting.

      **Scopes**: `meeting:read:admin` `meeting:read`

      GETMeetingRegistrants

      Request parameters

      • meetingId*integer

        The meeting ID.

      • occurrence_idstring

        The meeting occurrence ID.

      • statusstring

        The registrant status:
        `pending` - Registrant's status is pending.
        `approved` - Registrant's status is approved.
        `denied` - Registrant's status is denied.

      • page_sizeinteger

        The number of records returned within a single API call.

      • page_numberinteger

        The current page number of returned records.

    • List registration questions that will be displayed to users while [registering for a meeeting](https://support

      This action list registration questions that will be displayed to users while [registering for a meeeting](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings).
      **Scopes:** `meeting:read`, `meeting:read:admin`

      GETMeetingRegistrantsQuestionsGet

      Request parameters

      • meetingId*integer

        The meeting ID.

    • Poll allow the meeting host to survey attendees

      This action polls allow the meeting host to survey attendees. Use this API to create a [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) for a meeting.

      **Scopes**: `meeting:write:admin` `meeting:write`
      **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.

      POSTMeetingPollCreate

      Request parameters

      • meetingId*integer

        The meeting ID.

      Request body

      • questionsarray

        Array of Polls

      • titlestring

        Title for the poll.

    • Cloud Recordings of past Zoom Meetings can be made [on-demand](https://support

      This action 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](https://marketplace.zoom.us/docs/api-reference/zoom-api/cloud-recording/meetingrecordingregistrantcreate) to view these recordings. Use this API to register a user to gain access to **On-demand Cloud Recordings** of a past meeting.
      **Scopes:** `recording:write:admin`, `recording:write`.

      POSTMeetingRecordingRegistrantCreate

      Request parameters

      • meetingId*integer

        The meeting ID.

      Request body

      • addressstring

        Registrant's address.

      • citystring

        Registrant's city.

      • commentsstring

        A field that allows registrants to provide any questions or comments that they might have.

      • countrystring

        Registrant's country.

      • custom_questionsarray

        Custom questions.

      • emailstring

        A valid email address of the registrant.

      • first_namestring

        Registrant's first name.

      • industrystring

        Registrant's Industry.

      • job_titlestring

        Registrant's job title.

      • last_namestring

        Registrant's last name.

      • no_of_employeesstring

        Number of Employees:
        `1-20`
        `21-50`
        `51-100`
        `101-500`
        `500-1,000`
        `1,001-5,000`
        `5,001-10,000`
        `More than 10,000`

      • orgstring

        Registrant's Organization.

      • phonestring

        Registrant's Phone number.

      • purchasing_time_framestring

        This field can be included to gauge interest of webinar attendees towards buying your product or service. Purchasing Time Frame:
        `Within a month`
        `1-3 months`
        `4-6 months`
        `More than 6 months`
        `No timeframe`

      • role_in_purchase_processstring

        Role in Purchase Process:
        `Decision Maker`
        `Evaluator/Recommender`
        `Influencer`
        `Not involved`

      • statestring

        Registrant's State/Province.

      • zipstring

        Registrant's Zip/Postal Code.

    • Register a participant for a meeting

      This action register a participant for a meeting.

      **Scopes:** `meeting:write:admin` `meeting:write`

      POSTMeetingRegistrantCreate

      Request parameters

      • meetingId*integer

        The meeting ID.

      • occurrence_idsstring

        Occurrence IDs. You can find these with the meeting get API. Multiple values separated by comma.

      Request body

      • addressstring

        Registrant's address.

      • citystring

        Registrant's city.

      • commentsstring

        A field that allows registrants to provide any questions or comments that they might have.

      • countrystring

        Registrant's country.

      • custom_questionsarray

        Custom questions.

      • emailstring

        A valid email address of the registrant.

      • first_namestring

        Registrant's first name.

      • industrystring

        Registrant's Industry.

      • job_titlestring

        Registrant's job title.

      • last_namestring

        Registrant's last name.

      • no_of_employeesstring

        Number of Employees:
        `1-20`
        `21-50`
        `51-100`
        `101-500`
        `500-1,000`
        `1,001-5,000`
        `5,001-10,000`
        `More than 10,000`

      • orgstring

        Registrant's Organization.

      • phonestring

        Registrant's Phone number.

      • purchasing_time_framestring

        This field can be included to gauge interest of webinar attendees towards buying your product or service. Purchasing Time Frame:
        `Within a month`
        `1-3 months`
        `4-6 months`
        `More than 6 months`
        `No timeframe`

      • role_in_purchase_processstring

        Role in Purchase Process:
        `Decision Maker`
        `Evaluator/Recommender`
        `Influencer`
        `Not involved`

      • statestring

        Registrant's State/Province.

      • zipstring

        Registrant's Zip/Postal Code.

    • Poll allow the meeting host to survey attendees

      This action polls allow the meeting host to survey attendees. Use this API to update information of a specific meeting [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings)

      **Scopes**: `meeting:write:admin` `meeting:write`

      PUTMeetingPollUpdate

      Request parameters

      • meetingId*integer

        The meeting ID.

      • pollId*string

        The poll ID

      Request body

      • questionsarray

        Array of Polls

      • titlestring

        Title for the poll.

    • A registrant can either be approved or denied from viewing the [on-demand](https://support

      This action a registrant can either be approved or denied from viewing the [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) recording. Use this API to update a registrant's status. **Scopes:** `recording:write:admin`, `recording:write`

      PUTMeetingRecordingRegistrantStatus

      Request parameters

      • meetingId*integer

        The meeting ID.

      Request body

      • action*string

      • registrantsarray

        List of registrants

    • Zoom allows users to recover recordings from trash for up to 30 days from the deletion date

      This action zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use this API to recover all deleted [Cloud Recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) of a specific meeting.

      **Scopes**: `recording:write:admin` `recording:write`

      **Prerequisites**:
      * A Pro user with Cloud Recording enabled.

      PUTRecordingStatusUpdate

      Request parameters

      • meetingId*string

        The meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must **double encode** the UUID before making an API request.

      Request body

      • actionstring

    • Zoom allows users to recover recordings from trash for up to 30 days from the deletion date

      This action zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use this API to recover a single recording file from the meeting.
      **Scopes:** `recording:write:admin` `recording:write`

      PUTRecordingStatusUpdateOne

      Request parameters

      • meetingId*string

        The meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must **double encode** the UUID before making an API request.

      • recordingId*string

        The recording ID.

      Request body

      • actionstring

    • Update a meeting registrant's status by either approving, cancelling or denying a registrant from joining the meeting

      This action update a meeting registrant's status by either approving, cancelling or denying a registrant from joining the meeting.

      **Scopes:** `meeting:write:admin` `meeting:write`

      PUTMeetingRegistrantStatus

      Request parameters

      • meetingId*integer

        The meeting ID.

      • occurrence_idstring

        The meeting occurrence ID.

      Request body

      • action*string

      • registrantsarray

        List of registrants.

    • End a meeting by updating its status

      This action end a meeting by updating its status.

      **Scopes:** `meeting:write:admin` `meeting:write`

      PUTMeetingStatus

      Request parameters

      • meetingId*integer

        The meeting ID.

      Request body

      • actionstring

        `end` - End a meeting.

    • Update the details of a meeting

      This action update the details of a meeting.
      This API has a rate limit of 100 requests per day. Therefore, a meeting can only be updated for a maximum of 100 times within a 24 hour window.
      **Scopes:** `meeting:write:admin` `meeting:write`

      PATCHMeetingUpdate

      Request parameters

      • meetingId*integer

        The meeting ID.

      • occurrence_idstring

        Meeting occurrence id. Support change of agenda, start_time, duration, settings: {host_video, participant_video, join_before_host, mute_upon_entry, waiting_room, watermark, auto_recording}

      Request body

      • schedule_forstring

        Email or userId if you want to schedule meeting for another user.

    • Zoom allows users to [live stream a meeting](https://support

      This action zoom allows users to [live stream a meeting](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. Use this API to update a meeting's live stream information.

      **Prerequisites:**
      * Meeting host must have a Pro license.
      **Scopes:** `meeting:write:admin` `meeting:write`

      PATCHMeetingLiveStreamUpdate

      Request parameters

      • meetingId*integer

        The meeting ID.

      Request body

      • stream_key*string

        Stream name and key.

      • stream_url*string

        Streaming URL.

      • page_urlstring

        The livestream page URL.

    • Zoom allows users to [live stream a meeting](https://support

      This action zoom allows users to [live stream a meeting](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. Use this API to update the status of a meeting's live stream.

      **Prerequisites:**
      * Meeting host must have a Pro license.
      **Scopes:** `meeting:write:admin` `meeting:write`

      PATCHMeetingLiveStreamStatusUpdate

      Request parameters

      • meetingId*integer

        The meeting ID.

      Request body

      • actionstring

        Action.

      • settingsobject

    • For [on-demand](https://support

      This action for [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) meeting recordings, you can include fields with questions that will be shown to registrants when they register to view the recording. Use this API to update registration questions that are to be answered by users while registering to view a recording.
      **Scopes:** `recording:write:admin`, `recording:write`

      PATCHRecordingRegistrantQuestionUpdate

      Request parameters

      • meetingId*string

        The meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must **double encode** the UUID before making an API request.

      Request body

      • custom_questionsarray

        Array of Registrant Custom Questions

      • questionsarray

        Array of Registrant Questions

    • Update settings applied to a meeting's [Cloud Recording](https://support

      This action update settings applied to a meeting's [Cloud Recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording)

      **Scopes**: `recording:write:admin` `recording:write`

      PATCHRecordingSettingsUpdate

      Request parameters

      • meetingId*string

        The meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must **double encode** the UUID before making an API request.

      Request body

      • approval_typeinteger

        Approval type for the registration.
        `0`- Automatically approve the registration when a user registers.
        `1` - Manually approve or deny the registration of a user.
        `2` - No registration required to view the recording.

      • authentication_domainsstring

        Authentication domains.

      • authentication_optionstring

        Authentication Options.

      • on_demandboolean

        Determine whether registration isrequired to view the recording.

      • passwordstring

        Enable password protection for the recording by setting a password.

      • recording_authenticationboolean

        Only authenticated users can view.

      • send_email_to_hostboolean

        Send an email to host when someone registers to view the recording. This applies for On-demand recordings only.

      • share_recordingstring

        Determine how the meeting recording is shared.

      • show_social_share_buttonsboolean

        Show social share buttons on registration page. This applies for On-demand recordings only.

      • viewer_downloadboolean

        Determine whether a viewer can download the recording file or not.

    • Update registration questions that will be displayed to users while [registering for a meeeting](https://support

      This action update registration questions that will be displayed to users while [registering for a meeeting](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings).

      **Scopes:** `meeting:write`, `meeting:write:admin`

      PATCHMeetingRegistrantQuestionUpdate

      Request parameters

      • meetingId*integer

        The meeting ID.

      Request body

      • custom_questionsarray

        Array of Registrant Custom Questions

      • questionsarray

        Array of Registrant Questions

    • Delete a meeting

      This action delete a meeting.

      **Scopes:** `meeting:write:admin` `meeting:write`

      DELETEMeetingDelete

      Request parameters

      • meetingId*integer

        The meeting ID.

      • occurrence_idstring

        The meeting occurrence ID.

      • schedule_for_reminderboolean

        `true`: Notify host and alternative host about the meeting cancellation via email. `false`: Do not send any email notification.

    • Poll allow the meeting host to survey attendees

      This action polls allow the meeting host to survey attendees. Use this API to delete a meeting [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings).
      **Scopes**: `meeting:write:admin` `meeting:write`
      **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.

      DELETEMeetingPollDelete

      Request parameters

      • meetingId*integer

        The meeting ID.

      • pollId*string

        The poll ID

    • Delete all recording files of a meeting

      This action delete all recording files of a meeting.

      **Scopes:** `recording:write:admin` `recording:write`

      **Prerequisites**: * Cloud Recording should be enabled on the user's account.

      DELETERecordingDelete

      Request parameters

      • meetingId*string

        The meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must **double encode** the UUID before making an API request.

      • actionstring

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

    • Delete a sprecific recording file from a meeting

      This action delete a sprecific recording file from a meeting.

      **Scopes**: `recording:write:admin` `recording:write`

      DELETERecordingDeleteOne

      Request parameters

      • meetingId*string

        The meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must **double encode** the UUID before making an API request.

      • recordingId*string

        The recording ID.

      • actionstring

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

  • users

    • A Zoom account can have one or more users

      This action a Zoom account can have one or more users. Use this API to list users on your account.

      Note: Starting August 18, 2019, if an account holds more than 5000 users, the response data will no longer be sorted by email.

      **Scopes:** `user:read:admin`

      GETUsers

      Request parameters

      • statusstring

        User statuses:
        `active` - Users with an active status.
        `inactive` - Users with an inactive status.
        `pending` - Users with a pending status.

      • page_sizeinteger

        The number of records returned within a single API call.

      • page_numberinteger

        The current page number of returned records.

      • role_idstring

        Unique identifier for the role. Provide this parameter if you would like to filter the response by a specific role. You can retrieve Role IDs from [List Roles](https://marketplace.zoom.us/docs/api-reference/zoom-api/roles/roles) API.

    • Verify if a user's email is registered with Zoom

      This action verify if a user's email is registered with Zoom.

      Note: Starting November 17, 2019, the behavior of this API will change so that you will be able to successfully check to see if a user is a registered Zoom user only if the user 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.

      **Scopes:** `user:read:admin` `user:read`

      GETUserEmail

      Request parameters

      • email*string

        The email address to be verified.

    • A personal meeting room is a virtual meeting room that can be permanently assigned to a user

      This action 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:** `user:read:admin` `user:read`

      GETUserVanityName

      Request parameters

      • vanity_name*string

        Personal meeting room name.

    • A Zoom account can have one or more users

      This action a Zoom account can have one or more users. Use this API to view information of a specific user on a Zoom account.

      **Scopes:** `user:read:admin` `user:read`

      Note: If a user's status is pending, only `id` and `created_at` fields will be returned. The value of `created_at` will be the time at which the API call was made until the user activates their account.

      GETUser

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

      • login_typestring

        `0` - Facebook.
        `1` - Google.
        `99` - API.
        `100` - Zoom.
        `101` - SSO.

    • List a user's assistants

      This action list a user's assistants. Assistants are the users to whom 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**:
      * 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**: `user:read:admin` `user:read`

      GETUserAssistants

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

    • List all the meetings that were scheduled for a user (meeting host)

      This action list all the meetings that were scheduled for a user (meeting host).

      **Scopes:** `meeting:read:admin` `meeting:read`

      GETMeetings

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

      • typestring

        The meeting types:
        `scheduled` - All the scheduled meetings.
        `live` - All the live meetings.
        `upcoming` - All the upcoming meetings.

      • page_sizeinteger

        The number of records returned within a single API call.

      • page_numberinteger

        The current page number of returned records.

    • [Personal Audio Conference](https://support

      This action [Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC) allows Pro or higher account holders to host meetings through PSTN (phone dial-in) only.
      Use this API to list a user's PAC accounts.

      **Scopes:** `user:read:admin` `user:read`


      **Prerequisites:**
      * A Pro or higher plan with [Premium Audio Conferencing](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) add-on. * Personal Audio Conference must be enabled in the user's profile.

      GETUserPACs

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

    • User can be assigned a set of permissions that allows them to access only the pages/information that a user needs to view or edit

      This action users can be assigned a set of permissions that allows them to access only the pages/information that a user needs to view or edit.
      Use this API to get permissions that have been granted to the user.

      **Scopes:** `user:read:admin` `user:read`

      GETUserPermission

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

    • When a user records a meeting by choosing the **Record to the Cloud** option, the video, audio, and chat text are recorded in the Zoom cloud

      This action when a user records a meeting by choosing the **Record to the Cloud** option, the video, audio, and chat text are recorded in the Zoom cloud. Use this API to list all [Cloud recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) of a user.

      **Scopes:** `recording:read:admin` `recording:read`

      **Prerequisites:** * Pro or a higher plan. * Cloud Recording must be enabled on the user's account.

      GETRecordingsList

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

      • page_sizeinteger

        The number of records returned within a single API call.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

      • mcstring

        Query Metadata of Recording if an On-Premise Meeting Connector was used for the meeting.

      • trashboolean

        Query trash. `true`: List recordings from trash.
        `false`: Do not list recordings from the trash.
        The default value is `false`. If you set it to `true`, you can use the `trash_type` property to indicate the type of Cloud recording that you need to retrieve.

      • fromstring

        Start date in 'yyyy-mm-dd' format. (Within 6 month range)

      • tostring

        End date in 'yyyy-mm-dd' format. (Within 6 month range)

      • trash_typestring

        The type of Cloud recording that you would like to retrieve from the trash. The value can be one of the following:
        `meeting_recordings`: List all meeting recordings from the trash.
        `recording_file`: List all individual recording files from the trash.

    • List all the schedulers of a user

      This action list all the schedulers of a user. Schedulers in this context are the users for whom the current user can schedule meetings for. For instance, if the current user (i.e., the user whose userId was passed in the path parameter of this API call) is user A, the response of this API will contain a list of user(s), for whom user A can schedule and manage meetings. User A is the assistant of these users and thus has scheduling privilege for these user(s). **Prerequisites**: * Current user must be under the same account as the scheduler.
      **Scopes**: `user:read:admin` `user:read`

      GETUserSchedulers

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

    • Retrieve a user's settings

      This action retrieve a user's settings.

      **Scopes:** `user:read:admin` `user:read`

      GETUserSettings

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

      • login_typestring

        `0` - Facebook.
        `1` - Google.
        `99` - API.
        `100` - Zoom.
        `101` - SSO.

      • optionstring

        `meeting_authentication`: Use this query parameter to view [meeting authentication configuration](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied on the account.
        `recording_authentication`: Use this query parameter to view [recording authentication configuration](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied on the account.

    • Retrieve a user's token

      This action retrieve a user's token.

      This token is used for starting meetings with the Client SDK.
      **Scopes:** `user:read:admin` `user:read`
      If a user signed into Zoom using Google or Facebook, a null value will be returned for the token. To get the token with this API, ask the user to sign into Zoom using their email and password instead.

      GETUserToken

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

      • typestring

        User token types:
        `token` - Used for starting meetings with the client SDK.
        `zpk` - Used for generating the start meeting URL (Deprecated).
        `zak` - Used for generating the start meeting URL. The token expiration time is two hours. For API users, the expiration time is 90 days.

    • A user can have a maximum of two TSP accounts

      This action a user can have a maximum of two TSP accounts. Use this API to list all TSP accounts of a user.

      **Scopes:** `tsp:read:admin` `tsp:read`

      GETUserTSPs

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

    • Each user can have a maximum of two TSP accounts

      This action each user can have a maximum of two TSP accounts. Use this API to retrieve details of a specific TSP account enabled for a specific user.

      **Scopes:** `tsp:read:admin` `tsp:read`

      GETUserTSP

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

      • tspId*string

        TSP account ID.

    • Zoom users with a [Webinar Plan](https://zoom

      This action zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.
      Use this API to list all the webinars that are scheduled by or on-behalf a user (Webinar host).

      **Scopes:** `webinar:read:admin` `webinar:read`

      **Prerequisites:** * Pro or higher plan with a Webinar Add-on.

      GETWebinars

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

      • page_sizeinteger

        The number of records returned within a single API call.

      • page_numberinteger

        The current page number of returned records.

    • A Zoom account can have one or more users

      This action a Zoom account can have one or more users. Use this API to add a new user to your account.

      **Scopes:** `user:write:admin` `user:write`

      POSTUserCreate

      Request body

      • action*string

        Specify how to create the new user:
        `create` - User will get an email sent from Zoom. There is a confirmation link in this email. The user will then need to use the link to activate their Zoom account. The user can then set or change their password.
        `autoCreate` - This action is provided for the enterprise customer who has a managed domain. This feature is disabled by default because of the security risk involved in creating a user who does not belong to your domain.
        `custCreate` - Users created via this option do not have passwords and will not have the ability to log into the Zoom Web Portal or the Zoom Client. To use this option, you must contact the ISV Platform Sales team at [email protected]
        `ssoCreate` - This action is provided for the enabled “Pre-provisioning SSO User” option. A user created in this way has no password. If not a basic user, a personal vanity URL using the user name (no domain) of the provisioning email will be generated. If the user name or PMI is invalid or occupied, it will use a random number or random personal vanity URL.

      • user_infoobject

    • Assistant are the users to whom the current user has assigned [scheduling privilege](https://support

      This action assistants are the users to whom 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.
      Use this API to assign assistants to a user.
      In the request body, provide either the User ID or the email address of the user.

      **Prerequisite**: * 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**: `user:write:admin` `user:write`

      POSTUserAssistantCreate

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

      Request body

      • assistantsarray

        List of User's assistants.

    • Create a meeting for a user

      This action create a meeting for a user.
      This API has a daily rate limit of 100 requests per day. Therefore, only 100 **Create a Meeting** API requests are permitted within a 24 hour window for a user.



      Scopes: `meeting:write:admin` `meeting:write`

      POSTMeetingCreate

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

      Request body

      • agendastring

        Meeting description.

      • durationinteger

        Meeting duration (minutes). Used for scheduled meetings only.

      • passwordstring

        Password to join the meeting. Password may only contain the following characters: [a-z A-Z 0-9 @ - _ *]. Max of 10 characters.

      • recurrenceobject

        Recurrence object.

      • settingsobject

        Meeting settings.

      • start_timestring

        Meeting start time. We support two formats for `start_time` - local time and GMT.
        To set time as GMT the format should be `yyyy-MM-dd`T`HH:mm:ssZ`. To set time using a specific timezone, use `yyyy-MM-dd`T`HH:mm:ss` format and specify the timezone [ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones) in the `timezone` field OR leave it blank and the timezone set on your Zoom account will be used. You can also set the time as UTC as the timezone field. The `start_time` should only be used for scheduled and / or recurring webinars with fixed time.

      • timezonestring

        Time zone to format start_time. For example, "America/Los_Angeles". For scheduled meetings only. Please reference our [time zone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones) list for supported time zones and their formats.

      • topicstring

        Meeting topic.

      • tracking_fieldsarray

        Tracking fields

      • typeinteger

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

    • Upload a user's profile picture

      This action upload a user's profile picture.

      Provide `multipart/form-data` as the value of the `content-type` header for this request. **Scopes:** `user:write:admin` `user:write`

      POSTUserPicture

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

    • Add a user's TSP account

      This action add a user's TSP account.

      **Scopes:** `tsp:write:admin` `tsp:write`

      POSTUserTSPCreate

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

      Request body

      • conference_code*string

        Conference code: numeric value, length is less than 16.

      • leader_pin*string

        Leader PIN: numeric value, length is less than 16.

      • dial_in_numbersarray

        List of dial in numbers.

      • tsp_bridgestring

        Telephony bridge

    • Zoom users with a [Webinar Plan](https://zoom

      This action zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.
      Use this API to schedule a Webinar for a user (host).

      **Scopes:** `webinar:write:admin` `webinar:write`

      **Prerequisites:** * Pro or higher plan with a Webinar Add-on.

      POSTWebinarCreate

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

      Request body

      • agendastring

        Webinar description.

      • durationinteger

        Webinar duration (minutes). Used for scheduled webinars only.

      • passwordstring

        Webinar password. Password may only contain the following characters: [a-z A-Z 0-9 @ - _ * !]. Max of 10 characters.

      • recurrenceobject

        Recurrence object.

      • settingsobject

        Create Webinar settings.

      • start_timestring

        Webinar start time. We support two formats for `start_time` - local time and GMT.
        To set time as GMT the format should be `yyyy-MM-dd`T`HH:mm:ssZ`. To set time using a specific timezone, use `yyyy-MM-dd`T`HH:mm:ss` format and specify the timezone [ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones) in the `timezone` field OR leave it blank and the timezone set on your Zoom account will be used. You can also set the time as UTC as the timezone field. The `start_time` should only be used for scheduled and / or recurring webinars with fixed time.

      • timezonestring

        Time zone to format start_time. For example, "America/Los_Angeles". For scheduled meetings only. Please reference our [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones) list for supported time zones and their formats.

      • topicstring

        Webinar topic.

      • tracking_fieldsarray

        Tracking fields

      • typeinteger

        Webinar Types:
        `5` - Webinar.
        `6` - Recurring webinar with no fixed time.
        `9` - Recurring webinar with a fixed time.

    • Change a user's [email address](https://support

      This action 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.
      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-), the email to be updated must match one of the managed domains.
      **Scopes:** `user:write:admin` `user:write`
      **Prerequisite:**
      * Managed domain must be enabled in the account. * The new email address should not already exist in Zoom.

      PUTUserEmailUpdate

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

      Request body

      • email*string

        User’s email. The length should be less than 128 characters.

    • Update the [password](https://support

      This action 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.

      **Scopes:** `user:write:admin` `user:write`
      **Prerequisites:**
      * Owner or admin of the Zoom account.

      PUTUserPassword

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

      Request body

      • password*string

        User password. Should be less than 32 characters.

    • An account owner or admins can deactivate as well as activate a user in a Zoom account

      This action an account owner or admins can deactivate as well as activate a user in a Zoom account. Deactivating a user will remove all licenses associated with a user. It will prevent the deactivated user from logging into their Zoom account. A deactivated user can be reactivated. Reactivating a user grants the user access to login to their Zoom account.
      Use this API to either [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 .

      **Scopes:** `user:write:admin` `user:write`

      PUTUserStatus

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

      Request body

      • action*string

        The action types:
        `activate` - Activate a deactivated user.
        `deactivate` - Deactivate a user.

    • Update information on a user's Zoom [profile](https://support

      This action update information on a user's Zoom [profile](https://support.zoom.us/hc/en-us/articles/201363203-My-Profile).

      **Scopes:** `user:write:admin` `user:write`

      PATCHUserUpdate

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

      • login_typestring

        `0` - Facebook.
        `1` - Google.
        `99` - API.
        `100` - Zoom.
        `101` - SSO.

      Request body

      • cms_user_idstring

        Kaltura user ID.

      • companystring

        User's company.

      • deptstring

        Department for user profile: use for report.

      • first_namestring

        User's first name. Cannot contain more than 5 Chinese characters.

      • host_keystring

        Host key. It should be a 6-10 digit number.

      • job_titlestring

        User's job title.

      • languagestring

        language

      • last_namestring

        User's last name. Cannot contain more than 5 Chinese characters.

      • locationstring

        User's location.

      • phone_countrystring

        [Country ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries) of the phone number. For example, if the phone number provided in the `phone_number` field is a Brazil based number, the value of the `phone_country` field should be `BR`.

      • phone_numberstring

        Phone number of the user. To update a phone number, you must also provide the `phone_country` field.

      • pmiinteger

        Personal meeting ID: length must be 10.

      • timezonestring

        The time zone ID for a user profile. For this parameter value please refer to the ID value in the [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones) list.

      • typeinteger

        User types:
        `1` - Basic.
        `2` - Licensed.
        `3` - On-prem.

      • use_pmiboolean

        Use Personal Meeting ID for instant meetings.

      • vanity_namestring

        Personal meeting room name.

    • Update a user's settings

      This action update a user's settings.

      **Scopes:** `user:write:admin` `user:write`

      PATCHUserSettingsUpdate

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

      • optionstring

      Request body

      • email_notificationobject

      • featureobject

      • in_meetingobject

      • recordingobject

      • schedule_meetingobject

      • telephonyobject

      • tspobject

        Account Settings: TSP.

    • A global dial-in page can provide a list of global access numbers using which audio conferencing can be conducted

      This action a global dial-in page can provide a list of global access numbers using which audio conferencing can be conducted. By calling this API, you can set the url for the global dial-in page of a user whose Zoom account has TSP and special TSP with third-party audio conferencing options enabled.

      **Scopes:**`tsp:write:admin` `tsp:write`

      PATCHTspUrlUpdate

      Request parameters

      • userId*string

        The userId or email address of the user.

      Request body

      • audio_urlstring

        The global dial-in URL for a TSP enabled account. The URL must be valid with a max-length of 512 characters.

    • Update a user's TSP account

      This action update a user's TSP account.

      **Scopes:** `tsp:write:admin` `tsp:write`

      PATCHUserTSPUpdate

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

      • tspId*string

        TSP account ID.

      Request body

      • conference_code*string

        Conference code: numeric value, length is less than 16.

      • leader_pin*string

        Leader PIN: numeric value, length is less than 16.

      • dial_in_numbersarray

        List of dial in numbers.

      • tsp_bridgestring

        Telephony bridge

    • Deleting a user permanently removes them and their data from Zoom

      This action deleting a user permanently removes them and their data from Zoom. They will be able to create a new Zoom account with the same email address if they have access to it. An account owner or an account admin can transfer meetings, webinars and cloud recordings to another Zoom user before deleting, but if not transferred, they will be permanently deleted.

      By default, this API disassociates (unlinks) a user from the associated account. The disassociation will give them their own basic, free Zoom account. It will not be associated with your account, and they will be able to purchase their own licenses. You can transfer the user's data (meetings, webinars and cloud recordings) to another user before disassociation.
      To permanently delete a user, specify "delete" as the value of the `action` query parameter. **Scopes:** `user:write:admin` `user:write`

      DELETEUserDelete

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

      • actionstring

        Delete action options:
        `disassociate` - Disassociate a user.
        `delete`- Permanently delete a user.
        Note: To delete pending user in the account, use `disassociate`

      • transfer_emailstring

        Transfer email.

      • transfer_meetingboolean

        Transfer meeting.

      • transfer_webinarboolean

        Transfer webinar.

      • transfer_recordingboolean

        Transfer recording.

    • Delete all assistants of the current user

      This action delete all assistants of the current user.
      Assistants are the users to whom 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.
      **Prerequisite**: * 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**: `user:write:admin` `user:write`

      DELETEUserAssistantsDelete

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

    • Delete a specific assistant of a user

      This action delete a specific assistant of a user. Assistants are the users to whom 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**: `user:write:admin` `user:write`

      DELETEUserAssistantDelete

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

      • assistantId*string

        Assistant ID.

    • Delete all of a user's schedulers

      This action delete all of a user's schedulers. 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. **Prerequisite**: Current user (assistant) must be under the same account as the scheduler.
      **Scopes**: `user:write:admin` `user:write`

      DELETEUserSchedulersDelete

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

    • Delete a Scheduler

      This action delete a Scheduler. 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 this scheduler. **Prerequisite**: Current user must be under the same account as the scheduler.
      **Scopes**: `user:write:admin` `user:write`

      DELETEUserSchedulerDelete

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

      • schedulerId*string

        Scheduler's ID.

    • Revoke a user's SSO token

      This action revoke a user's SSO token.

      After calling this API, the SSO user will be logged out of their current Zoom session.
      **Scopes:** `user:write:admin` `user:write`

      DELETEUserSSOTokenDelete

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

    • Delete a user's TSP account

      This action delete a user's TSP account.

      **Scopes:** `tsp:write:admin` `tsp:write`

      DELETEUserTSPDelete

      Request parameters

      • userId*string

        The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

      • tspId*string

        TSP account ID.

  • contacts

    • A user under an organization's Zoom account has internal users listed under Company Contacts in the Zoom Client

      This action a user under an organization's Zoom account has internal users listed under Company Contacts in the Zoom Client. Use this API to search users that are in the company contacts of a Zoom account. Using the `search_key` query parameter, provide either first name, last name or the email address of the user that you would like to search for. Optionally, set `query_presence_status` to `true` in order to include the presence status of a contact.

      **Scopes:** `contact:read:admin`, `contact:read`

      GETSearchCompanyContacts

      Request parameters

      • search_key*string

        Provide the keyword - either first name, last name or email of the contact whom you have to search for.

      • query_presence_statusstring

        Set `query_presence_status` to `true` in order to include the presence status of a contact in the response.

      • page_sizeinteger

        The number of records to be returned with a single API call.

      • next_page_tokenstring

        The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

  • tracking_fields

    • [Tracking fields](https://support

      This action [Tracking fields](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) allow you to analyze usage by various fields within an organization.
      Use this API to list all the tracking fields on your Zoom account.

      **Scopes:** `trackingfield:read:admin`

      **Prerequisites:** * Business, Education, API or higher plan

      GETTrackingfieldList
    • [Tracking fields](https://support

      This action [Tracking fields](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) allow you to analyze usage by various fields within an organization.

      When scheduling a meeting, the tracking field will be included in the meeting options.
      Use this API to get information on a tracking field.

      **Scopes:** `trackingfield:read:admin`

      **Prerequisites:** * Business, Education, API or higher plan

      GETTrackingfieldGet

      Request parameters

      • fieldId*string

        The Tracking Field ID

    • [Tracking fields](https://support

      This action [Tracking fields](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) allow you to analyze usage by various fields within an organization.
      Use this API to create a new tracking field.

      **Scope:** `trackingfield:write:admin`

      **Prerequisites:** * Business, Education, API or higher plan

      POSTTrackingfieldCreate

      Request body

      • fieldstring

        Label/ Name for the tracking field.

      • recommended_valuesarray

        Array of recommended values

      • requiredboolean

        Tracking Field Required

      • visibleboolean

        Tracking Field Visible

    • [Tracking fields](https://support

      This action [Tracking fields](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) allow you to analyze usage by various fields within an organization.
      Use this API to update a tracking field.

      **Scope:** `trackingfield:write:admin`

      **Prerequisites:** * Business, Education, API or higher plan

      PATCHTrackingfieldUpdate

      Request parameters

      • fieldId*string

        The Tracking Field ID

      Request body

      • fieldstring

        Label/ Name for the tracking field.

      • recommended_valuesarray

        Array of recommended values

      • requiredboolean

        Tracking Field Required

      • visibleboolean

        Tracking Field Visible

    • [Tracking fields](https://support

      This action [Tracking fields](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) allow you to analyze usage by various fields within an organization.
      Use this API to delete a tracking field.

      **Scope:** `trackingfield:write:admin`

      **Prerequisites:** * Business, Education, API or higher plan

      DELETETrackingfieldDelete

      Request parameters

      • fieldId*string

        The Tracking Field ID

  • tsp

    • Get information on Telephony Service Provider on an account level

      This action get information on Telephony Service Provider on an account level.

      **Scopes:** `tsp:read:admin` `tsp:read`
      **Prerequisites:**
      * A Pro or a higher plan.

      GETTsp
    • Update information of the Telephony Service Provider set up on an account

      This action update information of the Telephony Service Provider set up on an account.
      **Prerequisites**:
      TSP account option should be enabled.
      **Scopes:** `tsp:write:admin` `tsp:write`

      PATCHTspUpdate

      Request body

      • dial_in_number_unrestrictedboolean

        Control restriction on account users adding a TSP number outside of account's dial in numbers.

      • enableboolean

        Enable 3rd party audio conferencing for account users

      • master_account_setting_extendedboolean

        For master account, extend its TSP setting to all sub accounts. For sub account, extend TSP setting from master account.

      • modify_credential_forbiddenboolean

        Control restriction on account users being able to modify their TSP credentials.

      • tsp_bridgestring

        Telephony bridge

      • tsp_enabledboolean

        Enable TSP feature for account. This has to be enabled to use any other tsp settings/features.

      • tsp_providerstring

        3rd party audio conferencing provider