Connectors
Communication, Email & Calendar
Zoom
Video conferencing: meetings, webinars, recordings, and registrant management
Zoom API referenceAPI checked August 18, 2026
- Signs in with
- API token
- Runs on
- Cloud or On-Prem Worker
- Operations
- 1,860
- Ready-made triggers
- 218
Connect Zoom
- In Neblex open Connect › Connections and click New Connection.
- Search for Zoom and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
| Field | What to enter |
|---|---|
| OAuth access tokenRequiredSecret |
Triggers
Start a flow when something changes in Zoom: add a Poll for changes trigger, choose Zoom and pick the event.
| Event | What it does | How |
|---|---|---|
| New or updated comment | Fires for each comment that appears or changes since the last check. | Checks for changes |
| New or updated fax | Fires for each fax that appears or changes since the last check. | Checks for changes |
| New or updated knowledge management | Fires for each knowledge management created or changed since the last check. | Checks for changes by updated_at |
| New or updated engagement | Fires for each engagement that appears or changes since the last check. | Checks for changes |
| New or updated clinicalnote | Fires for each clinicalnote that appears or changes since the last check. | Checks for changes |
| New or updated data request | Fires for each data request that appears or changes since the last check. | Checks for changes |
| New or updated api connector | Fires for each api connector that appears or changes since the last check. | Checks for changes |
| New or updated sms | Fires for each sms that appears or changes since the last check. | Checks for changes |
| New or updated clip | Fires for each clip that appears or changes since the last check. | Checks for changes |
| New or updated workspace | Fires for each workspace that appears or changes since the last check. | Checks for changes |
| New or updated information barrier | Fires for each information barrier that appears or changes since the last check. | Checks for changes |
| New or updated event | Fires for each event that appears or changes since the last check. | Checks for changes |
| New or updated user | Fires for each user that appears or changes since the last check. | Checks for changes |
| New or updated inbound blocked list | Fires for each inbound blocked list that appears or changes since the last check. | Checks for changes |
| New or updated prospect management | Fires for each prospect management that appears or changes since the last check. | Checks for changes |
| New or updated video | Fires for each video created or changed since the last check. | Checks for changes by modified_time |
| New or updated app | Fires for each app that appears or changes since the last check. | Checks for changes |
| New or updated audio library | Fires for each audio library that appears or changes since the last check. | Checks for changes |
| New or updated playlist | Fires for each playlist that appears or changes since the last check. | Checks for changes |
| New or updated collaborator | Fires for each collaborator that appears or changes since the last check. | Checks for changes |
| New or updated zoom rooms content | Fires for each zoom rooms content that appears or changes since the last check. | Checks for changes |
| New or updated firmware update rule | Fires for each firmware update rule that appears or changes since the last check. | Checks for changes |
| New or updated flow | Fires for each flow that appears or changes since the last check. | Checks for changes |
| New or updated hub | Fires for each hub that appears or changes since the last check. | Checks for changes |
| New or updated phone role | Fires for each phone role that appears or changes since the last check. | Checks for changes |
| New or updated region | Fires for each region that appears or changes since the last check. | Checks for changes |
| New or updated room template | Fires for each room template that appears or changes since the last check. | Checks for changes |
| New or updated sip phone | Fires for each sip phone that appears or changes since the last check. | Checks for changes |
| New or updated sms consent | Fires for each sms consent that appears or changes since the last check. | Checks for changes |
| New or updated phone device | Fires for each phone device that appears or changes since the last check. | Checks for changes |
| New or updated exhibitor | Fires for each exhibitor that appears or changes since the last check. | Checks for changes |
| New or updated video on demand | Fires for each video on demand that appears or changes since the last check. | Checks for changes |
| New or updated video on demand registration | Fires for each video on demand registration that appears or changes since the last check. | Checks for changes |
| New or updated document | Fires for each document that appears or changes since the last check. | Checks for changes |
| New or updated acl | Fires for each acl that appears or changes since the last check. | Checks for changes |
| New or updated calendar list | Fires for each calendar list that appears or changes since the last check. | Checks for changes |
| New or updated setting | Fires for each setting that appears or changes since the last check. | Checks for changes |
| New or updated account | Fires for each account created or changed since the last check. | Checks for changes by last_modified_time |
| New or updated voicemail | Fires for each voicemail that appears or changes since the last check. | Checks for changes |
| New or updated contact group | Fires for each contact group that appears or changes since the last check. | Checks for changes |
| New or updated h323 device | Fires for each h323 device that appears or changes since the last check. | Checks for changes |
| New or updated note | Fires for each note created or changed since the last check. | Checks for changes by last_modified_time |
| New or updated chat channels (account level) | Fires for each chat channels (account level) that appears or changes since the last check. | Checks for changes |
| New or updated call queue | Fires for each call queue that appears or changes since the last check. | Checks for changes |
| New or updated chat channel | Fires for each chat channel that appears or changes since the last check. | Checks for changes |
| New or updated chat message | Fires for each chat message that appears or changes since the last check. | Checks for changes |
| New or updated conversation | Fires for each conversation created or changed since the last check. | Checks for changes by last_modified_time |
| New or updated session | Fires for each session that appears or changes since the last check. | Checks for changes |
| New or updated task | Fires for each task that appears or changes since the last check. | Checks for changes |
| New or updated queue | Fires for each queue created or changed since the last check. | Checks for changes by last_modified_time |
| New or updated speaker | Fires for each speaker that appears or changes since the last check. | Checks for changes |
| New or updated team | Fires for each team that appears or changes since the last check. | Checks for changes |
| New or updated ticket | Fires for each ticket that appears or changes since the last check. | Checks for changes |
| New or updated webinar | Fires for each webinar that appears or changes since the last check. | Checks for changes |
| New or updated group | Fires for each group that appears or changes since the last check. | Checks for changes |
| New or updated im group | Fires for each im group that appears or changes since the last check. | Checks for changes |
| New or updated visitor management | Fires for each visitor management that appears or changes since the last check. | Checks for changes |
| New or updated outbound calling | Fires for each outbound calling that appears or changes since the last check. | Checks for changes |
| New or updated provision template | Fires for each provision template that appears or changes since the last check. | Checks for changes |
| New or updated deal | Fires for each deal that appears or changes since the last check. | Checks for changes |
| New or updated archiving | Fires for each archiving that appears or changes since the last check. | Checks for changes |
| New or updated asset library | Fires for each asset library that appears or changes since the last check. | Checks for changes |
| New or updated auto receptionist | Fires for each auto receptionist that appears or changes since the last check. | Checks for changes |
| New or updated scribe | Fires for each scribe that appears or changes since the last check. | Checks for changes |
| New or updated summarizer | Fires for each summarizer that appears or changes since the last check. | Checks for changes |
| New or updated translator | Fires for each translator that appears or changes since the last check. | Checks for changes |
| New or updated block list rule | Fires for each block list rule created or changed since the last check. | Checks for changes by last_modified_time |
| New or updated blocked list | Fires for each blocked list that appears or changes since the last check. | Checks for changes |
| New or updated operating hour | Fires for each operating hour that appears or changes since the last check. | Checks for changes |
| New or updated campaign | Fires for each campaign that appears or changes since the last check. | Checks for changes |
| New or updated classification label | Fires for each classification label that appears or changes since the last check. | Checks for changes |
| New or updated common area | Fires for each common area that appears or changes since the last check. | Checks for changes |
| New or updated address book | Fires for each address book that appears or changes since the last check. | Checks for changes |
| New or updated device | Fires for each device that appears or changes since the last check. | Checks for changes |
| New or updated disposition | Fires for each disposition created or changed since the last check. | Checks for changes by last_modified_time |
| New or updated division | Fires for each division that appears or changes since the last check. | Checks for changes |
| New or updated emergency address | Fires for each emergency address that appears or changes since the last check. | Checks for changes |
| New or updated recording | Fires for each recording that appears or changes since the last check. | Checks for changes |
| New or updated external contact | Fires for each external contact that appears or changes since the last check. | Checks for changes |
| New or updated group call pickup | Fires for each group call pickup that appears or changes since the last check. | Checks for changes |
| New or updated inbox | Fires for each inbox created or changed since the last check. | Checks for changes by last_modified_time |
| New or updated legal hold | Fires for each legal hold that appears or changes since the last check. | Checks for changes |
| New or updated emergency service location | Fires for each emergency service location that appears or changes since the last check. | Checks for changes |
| New or updated template | Fires for each template that appears or changes since the last check. | Checks for changes |
| New or updated monitoring group | Fires for each monitoring group that appears or changes since the last check. | Checks for changes |
| New or updated phone number | Fires for each phone number that appears or changes since the last check. | Checks for changes |
| New or updated site | Fires for each site that appears or changes since the last check. | Checks for changes |
| New or updated setting template | Fires for each setting template that appears or changes since the last check. | Checks for changes |
| New or updated shared line group | Fires for each shared line group that appears or changes since the last check. | Checks for changes |
| New or updated shared space | Fires for each shared space that appears or changes since the last check. | Checks for changes |
| New or updated skill | Fires for each skill created or changed since the last check. | Checks for changes by last_modified_time |
| New or updated chat channel mention group | Fires for each chat channel mention group that appears or changes since the last check. | Checks for changes |
| New or updated zoom room | Fires for each zoom room that appears or changes since the last check. | Checks for changes |
| New or updated meeting | Fires for each meeting that appears or changes since the last check. | Checks for changes |
| New or updated channel | Fires for each channel that appears or changes since the last check. | Checks for changes |
| New or updated zoom rooms location | Fires for each zoom rooms location that appears or changes since the last check. | Checks for changes |
| New or updated zoom rooms tag | Fires for each zoom rooms tag that appears or changes since the last check. | Checks for changes |
| New or updated availability | Fires for each availability that appears or changes since the last check. | Checks for changes |
| New or updated draft | Fires for each draft that appears or changes since the last check. | Checks for changes |
| New or updated settings filter | Fires for each settings filter that appears or changes since the last check. | Checks for changes |
| New or updated thread | Fires for each thread that appears or changes since the last check. | Checks for changes |
| New or updated message | Fires for each message that appears or changes since the last check. | Checks for changes |
| New or updated label | Fires for each label that appears or changes since the last check. | Checks for changes |
| New or updated scheduled event | Fires for each scheduled event that appears or changes since the last check. | Checks for changes |
| New or updated schedule | Fires for each schedule that appears or changes since the last check. | Checks for changes |
| New or updated cloud recording | Fires for each cloud recording that appears or changes since the last check. | Checks for changes |
| New or updated invitation & registration | Fires for each invitation & registration that appears or changes since the last check. | Checks for changes |
| New or updated role | Fires for each role that appears or changes since the last check. | Checks for changes |
| New comment | Fires for each comment created since the last check. | Checks for changes by create_time |
| New fax | Fires for each fax created since the last check. | Checks for changes by create_time |
| New knowledge management | Fires for each knowledge management created since the last check. | Checks for changes by created_at |
| New engagement | Fires for each engagement that appears since the last check. | Checks for changes |
| New clinicalnote | Fires for each clinicalnote that appears since the last check. | Checks for changes |
| New data request | Fires for each data request created since the last check. | Checks for changes by created_at |
| New api connector | Fires for each api connector that appears since the last check. | Checks for changes |
| New sms | Fires for each sms that appears since the last check. | Checks for changes |
| New clip | Fires for each clip that appears since the last check. | Checks for changes |
| New workspace | Fires for each workspace that appears since the last check. | Checks for changes |
| New information barrier | Fires for each information barrier that appears since the last check. | Checks for changes |
| New event | Fires for each event that appears since the last check. | Checks for changes |
| New user | Fires for each user that appears since the last check. | Checks for changes |
| New inbound blocked list | Fires for each inbound blocked list that appears since the last check. | Checks for changes |
| New prospect management | Fires for each prospect management that appears since the last check. | Checks for changes |
| New video | Fires for each video created since the last check. | Checks for changes by created_time |
| New app | Fires for each app that appears since the last check. | Checks for changes |
| New audio library | Fires for each audio library that appears since the last check. | Checks for changes |
| New playlist | Fires for each playlist that appears since the last check. | Checks for changes |
| New collaborator | Fires for each collaborator that appears since the last check. | Checks for changes |
| New zoom rooms content | Fires for each zoom rooms content that appears since the last check. | Checks for changes |
| New firmware update rule | Fires for each firmware update rule that appears since the last check. | Checks for changes |
| New flow | Fires for each flow that appears since the last check. | Checks for changes |
| New hub | Fires for each hub that appears since the last check. | Checks for changes |
| New phone role | Fires for each phone role that appears since the last check. | Checks for changes |
| New region | Fires for each region that appears since the last check. | Checks for changes |
| New room template | Fires for each room template that appears since the last check. | Checks for changes |
| New sip phone | Fires for each sip phone that appears since the last check. | Checks for changes |
| New sms consent | Fires for each sms consent created since the last check. | Checks for changes by create_time |
| New phone device | Fires for each phone device that appears since the last check. | Checks for changes |
| New exhibitor | Fires for each exhibitor that appears since the last check. | Checks for changes |
| New video on demand | Fires for each video on demand that appears since the last check. | Checks for changes |
| New video on demand registration | Fires for each video on demand registration that appears since the last check. | Checks for changes |
| New document | Fires for each document created since the last check. | Checks for changes by created_date |
| New acl | Fires for each acl that appears since the last check. | Checks for changes |
| New project | Fires for each project created since the last check. | Checks for changes by created_date |
| New calendar list | Fires for each calendar list that appears since the last check. | Checks for changes |
| New setting | Fires for each setting that appears since the last check. | Checks for changes |
| New account | Fires for each account created since the last check. | Checks for changes by created_time |
| New voicemail | Fires for each voicemail that appears since the last check. | Checks for changes |
| New contact group | Fires for each contact group that appears since the last check. | Checks for changes |
| New h323 device | Fires for each h323 device that appears since the last check. | Checks for changes |
| New note | Fires for each note that appears since the last check. | Checks for changes |
| New chat channels (account level) | Fires for each chat channels (account level) that appears since the last check. | Checks for changes |
| New call queue | Fires for each call queue that appears since the last check. | Checks for changes |
| New chat channel | Fires for each chat channel that appears since the last check. | Checks for changes |
| New chat message | Fires for each chat message that appears since the last check. | Checks for changes |
| New conversation | Fires for each conversation created since the last check. | Checks for changes by created_time |
| New custom crm | Fires for each custom crm created since the last check. | Checks for changes by create_time |
| New session | Fires for each session that appears since the last check. | Checks for changes |
| New task | Fires for each task created since the last check. | Checks for changes by create_time |
| New speaker | Fires for each speaker that appears since the last check. | Checks for changes |
| New team | Fires for each team that appears since the last check. | Checks for changes |
| New ticket | Fires for each ticket that appears since the last check. | Checks for changes |
| New webinar | Fires for each webinar that appears since the last check. | Checks for changes |
| New group | Fires for each group that appears since the last check. | Checks for changes |
| New im group | Fires for each im group that appears since the last check. | Checks for changes |
| New visitor management | Fires for each visitor management that appears since the last check. | Checks for changes |
| New outbound calling | Fires for each outbound calling that appears since the last check. | Checks for changes |
| New provision template | Fires for each provision template that appears since the last check. | Checks for changes |
| New deal | Fires for each deal created since the last check. | Checks for changes by create_time |
| New archiving | Fires for each archiving that appears since the last check. | Checks for changes |
| New asset library | Fires for each asset library that appears since the last check. | Checks for changes |
| New auto receptionist | Fires for each auto receptionist that appears since the last check. | Checks for changes |
| New scribe | Fires for each scribe that appears since the last check. | Checks for changes |
| New summarizer | Fires for each summarizer that appears since the last check. | Checks for changes |
| New translator | Fires for each translator that appears since the last check. | Checks for changes |
| New block list rule | Fires for each block list rule created since the last check. | Checks for changes by created_time |
| New blocked list | Fires for each blocked list that appears since the last check. | Checks for changes |
| New operating hour | Fires for each operating hour that appears since the last check. | Checks for changes |
| New campaign | Fires for each campaign that appears since the last check. | Checks for changes |
| New classification label | Fires for each classification label created since the last check. | Checks for changes by create_time |
| New common area | Fires for each common area that appears since the last check. | Checks for changes |
| New address book | Fires for each address book that appears since the last check. | Checks for changes |
| New device | Fires for each device that appears since the last check. | Checks for changes |
| New disposition | Fires for each disposition that appears since the last check. | Checks for changes |
| New division | Fires for each division that appears since the last check. | Checks for changes |
| New emergency address | Fires for each emergency address that appears since the last check. | Checks for changes |
| New recording | Fires for each recording that appears since the last check. | Checks for changes |
| New external contact | Fires for each external contact that appears since the last check. | Checks for changes |
| New group call pickup | Fires for each group call pickup that appears since the last check. | Checks for changes |
| New inbox | Fires for each inbox that appears since the last check. | Checks for changes |
| New legal hold | Fires for each legal hold that appears since the last check. | Checks for changes |
| New emergency service location | Fires for each emergency service location that appears since the last check. | Checks for changes |
| New template | Fires for each template that appears since the last check. | Checks for changes |
| New monitoring group | Fires for each monitoring group that appears since the last check. | Checks for changes |
| New phone number | Fires for each phone number that appears since the last check. | Checks for changes |
| New site | Fires for each site that appears since the last check. | Checks for changes |
| New chat reminder | Fires for each chat reminder created since the last check. | Checks for changes by create_time |
| New setting template | Fires for each setting template that appears since the last check. | Checks for changes |
| New shared line group | Fires for each shared line group that appears since the last check. | Checks for changes |
| New shared space | Fires for each shared space that appears since the last check. | Checks for changes |
| New chat channel mention group | Fires for each chat channel mention group that appears since the last check. | Checks for changes |
| New zoom room | Fires for each zoom room that appears since the last check. | Checks for changes |
| New meeting | Fires for each meeting created since the last check. | Checks for changes by created_at |
| New variable | Fires for each variable created since the last check. | Checks for changes by created_at |
| New channel | Fires for each channel that appears since the last check. | Checks for changes |
| New zoom rooms location | Fires for each zoom rooms location that appears since the last check. | Checks for changes |
| New zoom rooms tag | Fires for each zoom rooms tag that appears since the last check. | Checks for changes |
| New availability | Fires for each availability that appears since the last check. | Checks for changes |
| New draft | Fires for each draft that appears since the last check. | Checks for changes |
| New settings filter | Fires for each settings filter that appears since the last check. | Checks for changes |
| New thread | Fires for each thread that appears since the last check. | Checks for changes |
| New message | Fires for each message that appears since the last check. | Checks for changes |
| New label | Fires for each label that appears since the last check. | Checks for changes |
| New scheduled event | Fires for each scheduled event that appears since the last check. | Checks for changes |
| New schedule | Fires for each schedule that appears since the last check. | Checks for changes |
| New cloud recording | Fires for each cloud recording that appears since the last check. | Checks for changes |
| New invitation & registration | Fires for each invitation & registration created since the last check. | Checks for changes by create_time |
| New role | Fires for each role that appears since the last check. | Checks for changes |
Use it in a flow
- Open a flow, open the node library and search for Zoom.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- Use Test this step to see what it returns, then save.
Operations
1,860 operations in 220 groups. Each one is a step you can add to a flow.
Account19
Add phone numbers for an account's customized outbound caller IDaddOutboundCallerNumbers | POST | Adds the account-level customized outbound caller ID phone numbers. |
Delete phone numbers for an account's customized outbounddeleteOutboundCallerNumbers | DELETE | Deletes the account-level customized outbound caller ID phone numbers. |
Delete virtual background filesdelVB | DELETE | Deletes an account's existing virtual background files. |
Get account settingsaccountSettings | GET | Returns an account's settings. |
Get account's managed domainsaccountManagedDomain | GET | Retrieve a list of an account's managed domains. |
Get account's trusted domainsaccountTrustedDomain | GET | Retrieve an account's trusted domains. |
Get an account's webinar registration settingsaccountSettingsRegistration | GET | Get an account's webinar registration settings. |
Get Cisco/Polycom Room Account SettinggetCiscoPolycomRoomAccountSetting | GET | Retrieves details of the managed Cisco or Polycom rooms account profile settings. |
Get indicators settingsaccountIndicatorsSettings | GET | Get the account's indicators settings. |
Get locked settingsgetAccountLockSettings | GET | Retrieves an account's locked settings. |
List an account's customized outbound caller ID phone numberslistCustomizeOutboundCallerNumbers | GET | Retrieves phone numbers that can be used as the account-level customized outbound caller ID. |
List an account's Zoom Phone settingslistZoomPhoneAccountSettings | GET | Returns an account's Zoom Phone settings. |
List storage locationsListStorageLocations | GET | List all available storage locations for this account. |
Update account settingsaccountSettingsUpdate | PATCH | Update an account's settings. |
Update an account's webinar registration settingsaccountSettingsRegistrationUpdate | PATCH | Update an account's webinar registration settings. |
Update Cisco/Polycom Room Account SettingUpdateCiscoPolycomRoomAccountSetting | PATCH | Updates details of the managed Cisco/Polycom rooms account profile settings. |
Update locked settingsupdateAccountLockSettings | PATCH | Updates an account's locked settings. |
Update the account ownerupdateAccountOwner | PUT | Changes an account's owner. |
Upload virtual background filesuploadVB | POST | Uploads virtual background files for all users on the account to use. |
Account Management4
Add contacts to an existing end customer or your own account.addAccountContact | POST | Add contacts to an existing end customer or your own account. |
Create an end customer accountcreateAccount | POST | Creates an end customer account. |
Get the account details for a Zoom Partner/Subreseller/EndgetAccountDetails | GET | Returns the account details for a Zoom Partner, Subreseller, and End Customer. |
Get the list of all accounts associated with a ZoomgetAllAccounts | GET | Returns the list of all accounts associated with a Zoom Partner and Sub-Reseller, by the account type - endCustomer, subReseller, and relatedPartner. |
Acl5
Create a new ACL ruleInsertacl | POST | Creates an access control list rule. |
Delete an existing ACL ruleDeleteacl | DELETE | Deletes an access control list (ACL) rule. |
Get the specified ACL ruleGetacl | GET | Returns an access control list (ACL) rule. |
List ACL rules of specified calendarListacl | GET | Returns the rules in the access control list for the calendar. |
Update the specified ACL rulePatchacl | PATCH | Updates an access control list rule. |
Address Book24
Batch create address book contactsbatchCreateContact | POST | Batch create new contacts in an address book (https://support.zoom.us/hc/en-us/articles/4471544949389). |
Batch delete address book contactsbatchDeletecontact | DELETE | Batch delete contacts from an address book. |
Batch update address book contactsbatchUpdateContact | PATCH | Batch update contacts in an address book (https://support.zoom.us/hc/en-us/articles/4471544949389). |
Create an address bookcreateAddressBook | POST | Create an address book. |
Create an address book contactcreateContact | POST | Create a new contact in an address book. |
Create an address book custom fieldCreateacustomfield | POST | Create an address book custom field. |
Create an address book unitcreateUnit | POST | Create an address book unit. |
Delete an address bookdeleteAddressBook | DELETE | Delete an address book. |
Delete an address book contactcontactDelete | DELETE | Delete a contact from an address book. |
Delete an address book custom fieldDeleteancustomfield | DELETE | Delete an address book custom field. |
Delete an address book unitdeleteUnit | DELETE | Delete an address book unit. |
Get an address bookgetAddressBook | GET | Returns information about an address book. |
Get an address book contactgetContact | GET | Returns information about an address book's contact. |
Get an address book unitgetUnit | GET | Returns information about an address book unit. |
Get an address book's custom fieldGetaaddressbookcustomfield | GET | Get information about an address book's custom field. |
List address book contactslistContacts | GET | When the emails or phone numbers query parameter is included, the address book returns a maximum of 10,000 contacts. |
List address book unitslistUnits | GET | Return all address book units. |
List address bookslistAddressBooks | GET | Return a list of all address books. |
List an address book contact's custom fieldsListContactCustomFields | GET | List all custom fields on a contact. |
List an address book's custom fieldsListaddressbookcustomfields | GET | Return all address book custom fields. |
Update an address bookupdateAddressBook | PATCH | Update an address book's information. |
Update an address book contactupdateContact | PATCH | Update an address book's contact. |
Update an address book custom fieldUpdateacustomfield | PATCH | Update an address book custom field. |
Update an address book unitupdateUnit | PATCH | Update an address book unit. |
Agent Statuse5
Create a system statuscreateSystemStatus | POST | Create custom statuses for the agent status and queue opt out and not ready status categories. |
Delete a system statusdeleteSystemStatus | DELETE | Delete a custom status for the agent status and queue opt out and not ready status categories. |
Get a system statusgetAStatus | GET | Get information about a system status. |
List system statuseslistSystemStatus | GET | Get a list of system statuses. |
Update a system statusupdateSystemStatus | PATCH | Update a custom status for the agent status and queue opt out and not ready status categories. |
Alert5
Add an alert settingAddAnAlertSetting | POST | Adds an alert setting. |
Delete an alert settingDeleteAnAlertSetting | DELETE | Deletes an alert setting. |
Get alert setting detailsGetAlertSettingDetails | GET | Returns detailed information about a specific alert setting. |
List alert settings with paging queryListAlertSettingsWithPagingQuery | GET | Gets alert settings for an account with paging query. |
Update an alert settingUpdateAnAlertSetting | PATCH | Updates information of an Alert setting. |
Analytic1
Report analyticsreport_analytics | GET | Generates the scheduler analytics report. |
Api Connector7
Create an API ConnectorCreateAPIConnector | POST | Creates an Enhanced API Connector. |
Delete an API ConnectorDeleteAPIConnector | DELETE | Deletes an enhanced API connector. |
Get an API ConnectorGetAPIConnector | GET | Returns the details of an enhanced API connector. |
Get an API Connector's private keyGetanAPIConnector_sprivatekey | GET | Retrieves the private key of an Enhanced API Connector. |
List API ConnectorsGetListAPIConnectors | GET | Returns the Enhanced API Connectors for Cisco or Polycom Rooms. |
Update an API ConnectorUpdateAPIConnector | PATCH | Updates the settings of an Enhanced API Connector. |
Update an API Connector's private keyUpdateAPIConnectorPrivateKey | PATCH | Regenerates the enhanced API connector's private key. |
App25
Add app allow requests for usersAddAppAllowRequestsForUsers | POST | Use this API to add app allow requests for all users, groups of users, or specific users. |
Create an event subscriptioncreateEventSubscription | POST | Programmatically create event subscriptions for an authorized application. |
Create appsCreateApps | POST | Create Server to Server OAuth, Meeting SDK or General apps in the Zoom Marketplace. |
Delete an event subscriptiondeleteEventSubscription | DELETE | Delete an event subscription. |
Deletes an appdeleteApp | DELETE | Permanently delete an app on behalf of a user. |
Enable or disable user app subscriptionEnable_Disableuserappsubscription | PATCH | Enable or disable a user's app subscription. |
Generate an app deeplinkgenerateAppDeeplink | POST | Create an app deeplink. |
Generate Zoom App DeeplinkGenerateZoomAppDeeplink | POST | Create a Zoom App Deeplink. |
Get a user's app requestsgetUserAppRequests | GET | Use this API to get all of a user's app requests. |
Get a user's entitlementsgetUserEntitlementRequests | GET | Get a user's entitlements. |
Get an app's user requestsgetAppUserRequests | GET | Use this API to get an app's user requests and the status of their approval. |
Get API call logsGetapicalllogs | GET | Get log of app's API calls. |
Get app user entitlementsgetAppUserEntitlementRequests | GET | Get the app user's entitlements information. |
Get information about an appgetAppInfo | GET | Use this API to get app information. |
Get user or account event subscriptiongetUserEventSubscriptions | GET | Returns event subscriptions for users or accounts. |
Get user's custom field valuesgetCustomFieldValues | GET | Get custom field values for user. |
Get webhook logsgetWebhookLogsMarketplace | GET | Get users' webhook call logs and query records from the past 7 days. |
List appsListApps | GET | List all active and past app requests, or list all approved public and private apps. |
Rotate client secretRotateClientSecret | POST | Create or update a marketplace application's client secret rotating schedule. |
Send app notificationsSendappnotifications | POST | Send app notifications to the Zoom Activity Center. |
Subscribe to an event subscriptionsubscribeEventSubscription | PATCH | Subscribe to an event subscription. |
Unsubscribe to an app event subscriptionunSubscribeEventSubscription | DELETE | Use this API endpoint to unsubscribe an event subscription. |
Update an event subscriptionupdateEventSubscription | PATCH | Update an event subscription. |
Update app pre approval settingUpdateapppreapprovalsetting | POST | This API supports modifying the pre approval configuration of the app, including turning on the setting to the account, to specified users, to specified user groups, and turning off the... |
Update app's request statusupdateAppRequestStatus | PATCH | Use this API to update an app's request status or update app status. |
Archived1
Get AI Companion conversation archivesGetAICconversationarchives | GET | Retrieve the AI Companion conversation archives. |
Archiving11
Delete a meeting's archived filesdeleteArchivedFiles | DELETE | Delete all of a meeting's archived files. |
Download archive attachmentsBatchGetArchiveAttachmentDownloadUrl | GET | Batch retrieve download URLs for attachments in archived files. |
Download Whiteboards activity fileDownloadwhiteboardsactivityfile | GET | Use this API to download the Whiteboard archival file. |
Get a meeting's archive token for local archivingmeetingLocalArchivingArchiveToken | GET | Get a meeting's archive token to allow local archiving. |
Get a meeting's archived filesgetArchivedFiles | GET | Return a specific meeting instance's archived files. |
Get archived file statisticsgetArchivedFileStatistics | GET | Get statistics about an account's archived meeting or webinar files. |
List archived fileslistArchivedFiles | GET | Get an account's archived meeting or webinar files. |
List doc archive dataListdocarchive | GET | List archived documents for a given account within a specified time range. |
List whiteboard sessions activitiesListwhiteboardsessionsarchivedfiles | GET | Lists a session's activity information. |
List whiteboards sessionsCreatewhiteboardsarchivefiles | GET | Creates a list of archived sessions under current account. |
Update an archived file's auto-delete statusupdateArchivedFile | PATCH | Update an archived file's auto-delete status. |
Asset Library13
Batch update asset itemsBatchUpdateAssetItems | PATCH | Batch updates asset items across multiple assets in a single request. |
Create an assetcreateAnAsset | POST | Create an asset to store in the Contact Center Asset Library. |
Create an asset categorycreateAnAssetCategory | POST | Create an asset category. |
Delete an assetdeleteAnAsset | DELETE | Delete or achive an existing asset. |
Delete an asset categorydeleteAnAssetCategory | DELETE | Delete an existing asset category. |
Delete asset itemsDeleteassetitems | DELETE | Delete specific asset items. |
Duplicate an assetduplicateAnAsset | POST | Creates new assets based on an existing asset. |
Get an assetgetAnAsset | GET | Get information about an asset. |
Get an asset categorygetAnAssetCategory | GET | Get an asset category. |
List asset categorieslistAssetCategories | GET | List asset categories. |
List assetslistAssets | GET | List Contact Center assets. |
Update an assetupdateAnAsset | PATCH | Update an asset. |
Update an asset categoryupdateAnAssetCategory | PATCH | Update an asset category. |
Assignee3
Add assignees to a taskaddTasksAssignees | POST | Add one or more assignees to a specified task. |
Get assignees of a taskGetAssigneesOfATask | GET | Retrieves the list of assignees of a specified task. |
Remove Assignee from taskremoveTaskAssignee | DELETE | Removes a specific assignee from a task. |
Attendee Action4
List event attendee actionsListEventAttendeeActions | GET | Retrieves the attendee actions performed by the host for an event. |
List session attendee actionsListSessionAttendeeActions | GET | Retrieves the attendee actions performed by the host for an event session. |
Update event attendee actionsUpdateEventAttendeeActions | PATCH | Retrieves attendee onsite action for an event. |
Update session attendee actionsUpdateSessionAttendeeActions | PATCH | Performs attendee onsite action for an event session. |
Audio Library6
Add an audio item for text-to-speech conversionAddAnAudio | POST | Adds an audio item for text-to-speech conversion. |
Add audio itemsAddAudioItem | POST | Adds the audio items. |
Delete an audio itemDeleteAudioItem | DELETE | Deletes an audio item. |
Get an audio itemGetAudioItem | GET | Returns an audio item. |
List audio itemsListAudioItems | GET | Returns personal audios. |
Update an audio itemUpdateAudioItem | PATCH | Updates an audio item. |
Auto Receptionist19
Add a policy subsettingAddPolicy | POST | Adds a policy subsetting for a specific auto receptionist according to the policyType. |
Add an auto receptionistaddAutoReceptionist | POST | Adds an auto receptionist to a Zoom Phone. |
Add auto receptionist settingaddAutoReceptionistSetting | POST | Adds the auto receptionist setting according to the setting type. |
Assign phone numbersassignPhoneNumbersAutoReceptionist | POST | Assigns available phone numbers to an auto receptionist. |
Delete a non-primary auto receptionistdeleteAutoReceptionist | DELETE | Deletes a non-primary auto receptionist. |
Delete a policy subsettingDeletePolicy | DELETE | Removes the policy subsetting for a specific auto receptionist according to the policyType. |
Delete auto receptionist settingdeleteAutoReceptionistSetting | DELETE | Delete the auto receptionist setting according to the setting type. |
Get an auto receptionistgetAutoReceptionistDetail | GET | Returns information on a specific auto receptionist. |
Get an auto receptionist policygetAutoReceptionistsPolicy | GET | Returns the policy setting of a specific auto receptionist. |
Get auto receptionist call handling settinggetAutoReceptionistCallHandlingSettings | GET | Returns the call handling setting of an auto receptionist for the specified hour type. |
Get auto receptionist settingsgetAutoReceptionistSettings | GET | Returns auto receptionist settings. |
List auto receptionistslistAutoReceptionists | GET | Returns a list of auto receptionists. |
Unassign a phone numberunassignAPhoneNumAutoReceptionist | DELETE | Unassigns a specific phone number that was previously assigned to an auto receptionist. |
Unassign all phone numbersunassignAllPhoneNumsAutoReceptionist | DELETE | Unassigns all phone numbers that were previously assigned to an auto receptionist. |
Update a policy subsettingupdatePolicy | PATCH | Updates the policy subsetting of a specific auto receptionist according to the policyType. |
Update an auto receptionistupdateAutoReceptionist | PATCH | Changes information such as the display name and the extension number assigned to the main auto receptionist. |
Update an auto receptionist policyupdateAutoReceptionistPolicy | PATCH | Updates the policy setting of a specific auto receptionist. |
Update auto receptionist call handling settingupdateAutoReceptionistCallHandlingSettings | PATCH | Update the call handling setting of an auto receptionist for the specified hour type. |
Update auto receptionist settingupdateAutoReceptionistSetting | PATCH | Updates the auto receptionist setting according to the setting type. |
Availability5
Delete availabilitydelete_availability | DELETE | Removes a user's availability. |
Get availabilityget_availability | GET | Returns the availability schedule of the given UUID. |
Insert availabilityinsert_availability | POST | Inserts a user availability schedule. |
List availabilitylist_availability | GET | Returns the availability schedules of the given user. |
Patch availabilitypatch_availability | PATCH | Adjusts the availability schedule content of the given UUID. |
Billing3
Get detailed information about a specific invoice for agetInvoiceDetail | GET | Returns detailed information about a specific invoice for a distributor or a reseller. |
Gets all billing documents for a distributor or a resellergetAllBillingDocs | GET | Returns all billing documents for a distributor or a reseller. |
Gets the PDF document for the billing document IDdownloadBillingDoc | GET | Returns the PDF document for the billing document ID. |
Billing Account2
Get billing account detailsGetABillingAccount | GET | A Zoom account owner or a user with admin privilege can use this API to get information about a billing account. |
List billing accountslistBillingAccount | GET | Retrieves a list of available billing accounts for a Zoom account owner or a user with admin privileges. |
Block List Rule8
Create block list rules for IP addressescreateBlockListRulesIpAddresses | POST | Create block list rules for IP addresses. |
Create block list rules for phone numberscreateBlockListRulesPhoneNumbers | POST | Create block list rules for phone numbers. |
Delete IP addresses' block list rulesdeleteBlockListRuleIpAddresses | DELETE | Delete block list rules of IP addresses. |
Delete phone numbers' block list rulesdeleteBlockListRulePhoneNumbers | DELETE | Delete block list rules of phone numbers. |
Get a block list rule of IP addressesgetBlockListRuleIpAddress | GET | Get a block list rule of IP addresses. |
Get a block list rule of phone numbersgetBlockListRulePhoneNumber | GET | Get a block list rule of phone numbers. |
List block list rules for IP addresseslistBlockListRulesIpAddresses | GET | List block list rules for IP addresses. |
List block list rules of phone numberslistBlockListRulesPhoneNumbers | GET | List block list rules of phone numbers. |
Blocked List5
Create a blocked listaddAnumberToBlockedList | POST | Creates a block list and add a number to the list. |
Delete a blocked listdeleteABlockedList | DELETE | Deletes a blocked list, which removes the associated number from the blocked list. |
Get blocked list detailsgetABlockedList | GET | Returns the information about a specific blocked list. |
List blocked listslistBlockedList | GET | Returns all the blocked lists in an acccount. |
Update a blocked listupdateBlockedList | PATCH | Updates the information in the blocked list. |
Byos Storage6
Add storage locationbyosStoragePost | POST | Add the Bring Your Own Storage (BYOS) location. |
Change storage location detailbyosStorageDetailPatch | PATCH | Change one of the Bring Your Own Storage (BYOS) storage location details. |
Delete storage location detailbyosStorageDetailDelete | DELETE | Delete one of the the Bring Your Own Storage (BYOS) storage locations. |
List storage locationbyosStorageGet | GET | List the Bring Your Own Storage (BYOS) location. |
Storage location detailbyosStorageDetailGet | GET | Get details about one of the Bring Your Own Storage (BYOS) locations. |
Update Bring Your Own Storage settingsbyosStorageSwitchPatch | PATCH | Change Cloud Recording's Bring Your Own Storage setting. |
Calendar4
Create a new secondary calendarInsertcalendar | POST | Creates a secondary calendar. |
Delete a calendar owned by a userDeletecalendar | DELETE | Deletes a calendar |
Get the specified calendarGetcalendar | GET | Returns metadata for a calendar. |
Update the specified calendarPatchcalendar | PATCH | Updates metadata for a calendar. |
Calendar List5
Delete an existing calendar from the user's own calendarListDeletecalendarList | DELETE | Removes a calendar from the user's calendar list. |
Get a specified calendar from the user's own calendarListGetcalendarList | GET | Returns a calendar from the user's calendar list. |
Insert an existing calendar to the user's own calendarListInsertcalendarList | POST | Inserts an existing calendar into the user's calendar list. |
List the calendars in the user's own calendarListListcalendarList | GET | Returns the calendars in the user's calendar list. |
Update an existing calendar in the user's own calendarListPatchcalendarList | PATCH | Updates an existing calendar on the user's calendar list. |
Call Control3
Command control of a useruserControl | POST | Issue a command to trigger an action for a Contact Center user. |
Control an engagement's recordingengagementRecordingControl | PUT | Controls the recording state for an engagement. |
List user's devicesListuserdevices | GET | List a Contact Center user's device information. |
Call Handling1
Delete a call handling settingdeleteCallHandling | DELETE | Deletes a Zoom Phone's call handling settings. |
Call History & Reporting4
Get Call HistoryGetCallHistory | GET | Retrieve call history with pagination and various filtering options. |
Get call history by IDGetCallDetailsbyCallID | GET | Retrieve call history for a call history ID. |
Get Report Call HistoryGetReportCallHistory | GET | Returns the synchronous, page-based call history report for the resolved reporting scope and date window. |
Get Seller Productivity ReportGetSellerProductivityReport | GET | Returns seller productivity metrics for the resolved reporting scope and date window. |
Call List Management5
Create Call ListCreateCallList | POST | Create a new call list |
Delete Call ListDeleteCallList | DELETE | Delete a call list and all its associated prospects. |
Get Call List by IDGetCallListbyID | GET | Retrieve details of a specific call list by its ID |
List Call ListsListCallLists | GET | Retrieve all call lists in the account. |
Update Call ListUpdateCallList | PATCH | Update an existing call list. |
Call Log8
Add a client code to a call historyaddClientCodeToCallHistory | PATCH | Adds a client code to a call log. |
Delete a user's call historydeleteUserCallHistory | DELETE | Deletes a user's call history. |
Get account's call historyaccountCallHistory | GET | Returns an account's new edition of call logs. |
Get call elementgetCallElement | GET | Returns the call element for a given call element ID. |
Get call historygetCallPath | GET | Returns information about a call log. |
Get User AI Call Summary DetailgetUserAICallSummary | GET | Returns AI call summary details. |
Get user's call historyphoneUserCallHistory | GET | Returns a user's Zoom phone call history. |
Sync user's call historysyncUserCallHistory | GET | Syncs a user's Zoom phone call history. |
Call Queue32
Add a policy subsetting to a call queueaddCQPolicySubSetting | POST | Adds the policy subsetting for a specific call queue according to the policyType. |
Add call queue settingaddCallQueueSetting | POST | Adds a call queue setting according to the setting type. |
Add members to a call queueaddMembersToCallQueue | POST | Adds phone users or common areas as members to a specific call queue. |
Add members to a custom groupAddmemberstoacustomgroup | POST | Adds call queue members to a custom group. |
Assign numbers to a call queueassignPhoneToCallQueue | POST | Assigns numbers to a call queue. |
Create a call queuecreateCallQueue | POST | Creates a call queue. |
Create a custom group in a call queueCreateacustomgroupinacallqueue | POST | |
Delete a call queuedeleteACallQueue | DELETE | Call queues allow you to route incoming calls to a group of users. |
Delete a CQ policy settingremoveCQPolicySubSetting | DELETE | Use this API to remove the policy sub-setting for a specific call queue according to the policyType. |
Delete a custom groupDeleteacustomgroup | DELETE | Delete a custom group. |
Delete call queue settingdeleteCallQueueSetting | DELETE | Delete the call queue setting by the setting type. |
Get call queue call handling settinggetCallQueueCallHandlingSetting | GET | Returns the call handling setting of a call queue for the specified hour type. |
Get call queue custom group detailGetacustomgroup | GET | |
Get call queue detailsgetACallQueue | GET | Routes incoming calls to a group of users and returns information on a specific call queue. |
Get call queue policygetCallQueuePolicy | GET | Returns the policy setting of a specific [call queue]. |
Get call queue recordingsgetCallQueueRecordings | GET | Use this API to view call recordings from the call queue. |
Get call queue settingsgetCallQueueSettings | GET | Returns call queue settings. |
List call queue analyticscallqueueanalytics | GET | Returns the call queue analytics overview. |
List call queue memberslistCallQueueMembers | GET | Returns a list of call queue members. |
List call queueslistCallQueues | GET | Call queues allow you to route incoming calls to a group of users. |
List custom groups of a call queueListcustomgroupsofacallqueue | GET | Returns a list of custom groups for a call queue. |
Remove a member from a custom groupRemoveamemberfromacustomgroup | DELETE | |
Unassign a memberunassignMemberFromCallQueue | DELETE | Removes a member who was previously added to a call queue. |
Unassign a phone numberunAssignPhoneNumCallQueue | DELETE | Unbinds a phone number from a call queue. |
Unassign all membersunassignAllMembers | DELETE | Removes all members from a call queue who were previously assigned to that call queue. |
Unassign all phone numbersunassignAPhoneNumCallQueue | DELETE | Unbinds all phone numbers that are assigned to a call queue. |
Update a call queue's policy subsettingupdateCQPolicySubSetting | PATCH | Updates the policy subsetting for a specific call queue according to the policyType. |
Update a custom groupUpdateacustomgroup | PATCH | Update a custom group. |
Update call queue call handling settingupdateCallQueueCallHandlingSetting | PATCH | Updates the call handling setting of a call queue for the specified hour type. |
Update call queue detailsupdateCallQueue | PATCH | Updates information of a specific call queue. |
Update call queue policyupdateCallQueuePolicy | PATCH | Updates a call queue's policy settings. |
Update call queue settingupdateCallQueueSetting | PATCH | Update the call queue setting according to the setting type. |
Campaign28
Batch create a campaign DNC list's phonesbatchCreateCampaignDncListPhones | POST | Batch add phone numbers to a Do Not Call (DNC) list. |
Batch delete a campaign DNC list's phonesbatchDeleteCampaignDncListPhone | DELETE | Batch delete phone numbers from a Do Not Call (DNC) list. |
Batch update campaign contact listsBatchupdatecampaigncontactlists | PATCH | Batch update campaign contact lists. |
Create a campaign contact listcreateCampaignContactList | POST | Create a campaign contact list. |
Create a campaign contact list's contactcreateCampaignContactListContact | POST | Add a new contact to a campaign contact list. |
Create a campaign contact list's custom fieldcreateACampaignContactCustomField | POST | Create a custom field for a campaign contact list. |
Create an outbound campaigncreateOutboundCampaign | POST | Create an outbound Contact Center campaign. |
Delete a campaign contact list's custom fielddeleteACampaignCustomField | DELETE | Delete a custom field in a campaign contact list. |
Delete an outbound campaigndeleteOutboundCampaign | DELETE | Delete a Contact Center's outbound campaign. |
Get a campaign contact listgetCampaignContactList | GET | Get a campaign contact list. |
Get a campaign contact list's contactgetCampaignContactListContact | GET | Get a contact on a campaign contact list. |
Get a campaign contact list's custom fieldgetACampaignContactCustomField | GET | Retrieve information about a campaign contact list custom field. |
Get an outbound campaigngetOutboundCampaign | GET | Get a Contact Center outbound campaign. |
Insert a batch of contacts into a campaign contact listInsertabatchofcontactstoacampaigncontactlist | POST | Batch insert contacts into a campaign contact list. |
List a campaign contact list's contactslistCampaignContactListContacts | GET | List contacts on a campaign contact list. |
List a campaign contact's custom fieldslistCampaignContactCustomFields | GET | Retrieve all custom fields associated with a contact. |
List campaign contact listslistCampaignContactLists | GET | List campaign contact lists. |
List campaign contact lists' custom fieldslistCampaignCustomFields | GET | Retrieve all custom fields defined for campaign contact lists. |
List campaign DNC phone numberslistCampaignDncListPhones | GET | List phone numbers on a campaign DNC (Do Not Call) list. |
List outbound campaignslistOutboundCampaigns | GET | List Contact Center outbound campaigns. |
Remove a campaign contact listdeleteCampaignContactList | DELETE | Delete a campaign contact list |
Remove campaign contact list's contactdeleteCampaigncontactListContact | DELETE | Remove a contact by ID from a campaign contact list. |
Update a batch of contacts on a campaign contact listUpdateabatchofcontactsonacampaigncontactlist | PATCH | Batch update contacts on a campaign contact list. |
Update a campaign contact listupdateCampaignContactList | PATCH | Update a campaign contact list |
Update a campaign contact list's custom fieldupdateACampaignCustomField | PATCH | Update details of a campaign contact list's custom field. |
Update an outbound campaignupdateOutboundCampaign | PATCH | Update an outbound Contact Center campaign. |
Update an outbound campaign statusUpdateanoutboundcampaignstatus | PATCH | Update an outbound campaign status. |
Update contact on a campaign contact listupdateCampaignContactListContact | PATCH | Update a contact on a campaign contact list. |
Carrier Reseller4
Activate phone numbersactiveCRPhoneNumbers | PATCH | Use this API to change phone number status to 'active' in a carrier reseller's master account. |
Create phone numberscreateCRPhoneNumbers | POST | Use this API to add phone numbers to a carrier reseller (master) account. |
Delete a phone numberdeleteCRPhoneNumber | DELETE | Use this API to delete or unassign a phone number from a carrier reseller account. |
List phone numberslistCRPhoneNumbers | GET | Use this API to list phone numbers in a carrier reseller (master) account that can be pushed to its subaccounts. |
Channel6
Channel actionschannelActions | PATCH | Perform state transition actions on a video channel . |
Create a channelcreateChannelVideoManagement | POST | Creates a channel for managing videos. |
Delete channelDeleteChannel | DELETE | Deletes a video channel. |
Get channel detailsgetChannelDetail | GET | Returns the details of the video channel. |
List channelslistVideoChannels | GET | Retrieves the list of channels. |
Update channelUpdateVideoChannelVideoManagement | PATCH | Updates a video channel. |
Chat Channel16
Batch remove members from a channelbatchRemoveChannelMembers | DELETE | Removes multiple members from a chat channel in a batch. |
Create a channelcreateChannel | POST | Creates a channel for a user. |
Delete a channeldeleteUserLevelChannel | DELETE | Deletes a specific channel. |
Get a channelgetUserLevelChannel | GET | Returns information about a specific channel. |
Invite channel membersInviteUserLevelChannelMembers | POST | Invites members that are in a user's contact list to a channel. |
Invite channel members (Groups)inviteChannelMembersGroups | POST | Adds members and groups to a channel. |
Join a channeljoinChannel | POST | Joins a channel that is open for anyone in the same organization to join. |
Leave a channelleaveChannel | DELETE | Leaves a specific channel. |
List channel activity logslistAllChannelActivityLogs | GET | Returns a list of a channel's activity logs. |
List channel memberslistUserLevelChannelMembers | GET | Lists all members of a channel. |
List channel members (Groups)listChannelMembersGroups | GET | Returns a list of channel member groups. |
List user's channelsgetChannels | GET | Generates a list of user's chat channels. |
Perform operations on channelsPerformOperationsOnChannels | PATCH | Performs different operations on channels. |
Remove a memberremoveAUserLevelChannelMember | DELETE | Removes a member from a chat channel. |
Remove a member (group)removeAMemberGroup | DELETE | Removes a group from a chat channel. |
Update a channelupdateUserLevelChannel | PATCH | Update the name, type, and settings of a specific channel you own or administer. |
Chat Channel Mention Group7
Add channel members to a mention groupaddAChannelMembersToMentionGroup | POST | Adds the channel members to a mention group. |
Create a channel mention groupcreateChannelMentionGroup | POST | Creates a channel mention group. |
Delete a channel mention groupdeleteAChannelMentionGroup | DELETE | Removes a mention group in a channel. |
List channel mention groupsgetChannelMentionGroup | GET | Returns a list of all the mention groups in a channel. |
List the members of a mention grouplistTheMembersOfMentionGroup | GET | Returns a list of the members in the mention group. |
Remove channel mention group membersremoveChannelMentionGroupMembers | DELETE | Removes a mention group in channel. |
Update a channel mention group informationupdateChannelMentionGroup | PATCH | Updates a mention group's information. |
Chat Channels (Account Level)17
Assign a new channel ownerreassignChannelOwner | PATCH | Change the owner of a chat channel to another member within that channel. |
Batch delete channelsbatchDeleteChannelsAccountLevel | DELETE | Delete channels in batches. |
Batch demote channel administratorsbatchDemoteChannelAdministrators | DELETE | Demotes administrators in a channel in batch. |
Batch remove members from a user's channelbatchRemoveUserChannelMembers | DELETE | Removes multiple members from a user's chat channel in a batch. |
Delete a channeldeleteChannel | DELETE | Deletes a specific channel. |
Get a channelgetChannel | GET | Returns information about a specific channel. |
Get retention policy of a channelgetChannelRetention | GET | Returns the retention policy of a channel. |
Invite channel membersinviteChannelMembers | POST | Invites members that are in a user's contact list to a channel. |
List account's public channelsgetAccountChannels | GET | Lists public chat channels that the account's users create. |
List channel activity logslistChannelActivityLogs | GET | Returns a list of a channel's activity logs. |
List channel administratorslistChannelAdministrators | GET | Lists all administrators of a channel. |
List channel memberslistChannelMembers | GET | Returns a list of all members of a channel. |
Promote channel members to administratorspromoteChannelMembersAsAdmin | POST | Promotes members to an administrator role in a channel. |
Remove a memberremoveAChannelMember | DELETE | Removes a member from a chat channel. |
Search user's or account's channelssearchChannels | POST | Searches user's or account's chat channels. |
Update a channelupdateChannel | PATCH | Updates the name, type, and settings of a specific channel that the user owns or administers. |
Update retention policy of a channelupdateChannelRetention | PATCH | Updates the retention policy of a channel. |
Chat Emoji3
Add a custom emojiaddACustomEmoji | POST | Add a custom emoji. |
Delete a custom emojiDeleteCustomEmoji | DELETE | Delete a custom emoji by fileId . |
List custom emojislistCustomEmojis | GET | Queries the custom emojis list. |
Chat File4
Delete a chat filedeleteChatFile | DELETE | Deletes a chat file. |
Get file infogetFileInfo | GET | Returns information about the chat file. |
Send a chat filesendChatFile | POST | Sends a file on Zoom to either an individual user in your contact list or a channel of which you are a member. |
Upload a chat fileuploadAChatFile | POST | Uploads a file to chat. |
Chat Message15
Add or remove a bookmarkaddOrRemoveABookmark | PATCH | Adds a bookmark to a message or removes the bookmark from a message. |
Delete a messagedeleteChatMessage | DELETE | Deletes a chat message previously sent to a contact or a channel. |
Delete a scheduled messagedeleteScheduleMessage | DELETE | Deletes a scheduled message. |
Get a forwarded messagegetForwardedMessage | GET | Returns a chat message previously sent to a contact or a channel. |
Get a messagegetChatMessage | GET | Returns a chat message previously sent to a contact or a channel. |
List bookmarksfetchBookmarks | GET | Returns the bookmarks for a given channel, 1:1 conversation, or across all of the sessions |
List pinned history messages of channellistChannelPinnedMessages | GET | Returns a list of pinned history messages of channel. |
List scheduled messageslistScheduledMessages | GET | Returns a list of scheduled messages. |
List user's chat messagesgetChatMessages | GET | Returns a list of chat messages and shared files between a user and an individual contact, or a chat channel. |
Mark message read or unreadmarkMessage | PATCH | Marks a chat message as read or unread. |
Perform operations on the message of channelPerformMessageOfChannel | PATCH | Performs different operations, such as pin or unpin, on the message of channel. |
React to a chat messagereactMessage | PATCH | Adds or removes an emoji to a chat message. |
Retrieve a threadretrieveThread | GET | Retrieves all messages under a thread. |
Send a chat messagesendaChatMessage | POST | Sends chat messages to a user in your contact list or to a channel of which you are a member. |
Update a messageeditMessage | PUT | Edits a chat message that you previously sent to either a contact or a channel in Zoom. |
Chat Migration9
Get migrated Zoom channel IDsgetMigrationChannelsMapping | GET | Returns Zoom channel IDs by their corresponding migrated channel IDs. |
Get migrated Zoom user IDsgetMigrationUsersMapping | GET | Returns Zoom user IDs by their corresponding migrated user IDs. |
Migrate 1:1 conversation or channel operationsMigrate1_1ConversationOrChannelOperations | POST | Performs operations on migrated 1:1 conversations or channels. |
Migrate a channel tabMigrateAChannelTab | POST | Migrate a web link tab to a Zoom Team Chat channel. |
Migrate a chat channelMigrateAChatChannel | POST | Migrates a chat channel. |
Migrate a shared spaceMigrateASharedSpace | POST | Migrates a shared space. |
Migrate channel membersMigrateChannelMembers | POST | Adds a maximum of 20 members to a migrated chat channel. |
Migrate chat message reactionsMigrateChatMessageReactions | POST | Adds emoji reactions to a migrated chat message. |
Migrate chat messagesMigrateChatMessages | POST | Adds a maximum of 20 messages to migrated 1:1 conversations or channels. |
Chat Reminder3
Create a reminder messagecreateReminderForMessage | POST | Creates a reminder for a person or a chat channel. |
Delete a reminder for a messagedeleteReminderForMessage | DELETE | Deletes a reminder. |
List reminderslistReminders | GET | Returns a list reminders for a person or a chat channel. |
Chat Session2
List a user's chat sessionsgetChatSessions | GET | Retrieves a user's chat sessions. |
Star or unstar a channel or contact userstarUnstarChannelContact | PATCH | Stars or unstars a contact or channel user. |
Chatbot Message4
Delete a Chatbot messagedeleteAChatbotMessage | DELETE | Deletes a message from your Chatbot app. |
Edit a Chatbot messageeditChatbotMessage | PUT | Use this API to edit a message sent by your Chatbot app. |
Link UnfurlsunfurlingLink | POST | Unfurls a link with your Marketplace Chat app. |
Send Chatbot messagessendchatbot | POST | Sends messages from your Marketplace Chatbot app. |
Cisco/Polycom Room5
Create a Managed RoomCreateaManagedRoom | POST | Creates a Managed Cisco/Poly Room. |
Delete a managed roomDeleteamanagedroom | DELETE | Deletes a managed Cisco/Poly Room. |
Get a Managed RoomGetaManagedRoom | GET | Returns the details of a managed room. |
List Managed RoomsListManagedRooms | GET | Returns the Managed Cisco/Polycom rooms. |
Update a Managed RoomUpdateaManagedRoom | PATCH | Updates the settings of a Cisco or Polycom Room. |
Classification Label7
Apply classification to whiteboardApplyclassificationtowhiteboard | PUT | Applies or updates a classification label on a whiteboard. |
Create a classification labelcreateClassificationLabel | POST | Creates a new classification label for the account. |
Delete classification labeldeleteClassificationLabel | DELETE | Deletes an existing classification label. |
Get classification labelgetClassificationLabel | GET | Retrieves detailed information about a specific classification label. |
List classification labelslistClassificationLabels | GET | Retrieves all classification labels for the account. |
Remove classification from whiteboardremoveWhiteboardClassification | DELETE | Removes the classification label from a whiteboard. |
Update a classification labelupdateClassificationLabel | PATCH | Updates an existing classification label. |
Clinicalnote3
Get a Clinical NoteGetaClinicalNote | GET | Gets a single clinical note identified by noteId. |
List clinical notesGetClinicalNote | GET | Retrieves a list of clinical notes. |
Update a Clinical NoteUpdateClinicalNote | PATCH | Updates a clinical note associated with the noteId. |
Clip3
Batch star clipsBatchstarclips | POST | Stars or unstars multiple clips in one request. |
Get collaborators of a clipGetClipCollaborators | GET | Returns the list of collaborators for a clip that the current user owns or returns the list of collaborators for any clip associated with the account. |
List all clipsGetUserClips | GET | Returns a list of clips of the current user or a list of all clips under the account. |
Cloud Peering Provider Exchange5
Add peering phone numbersaddPeeringPhoneNumbers | POST | Enables provider exchange partners to add phone numbers to a Zoom account. |
List peering phone numberslistPeeringPhoneNumbers | GET | Returns the details associated with a specific phone number, or all the phone numbers the partner previously provisioned for the Zoom customer account. |
List peering phone numbers for providerListpeeringphonenumbersforprovider | GET | Returns phone numbers the carrier pushes to different customers. |
Remove peering phone numbersdeletePeeringPhoneNumbers | DELETE | Removes the phone number from the Zoom customer account. |
Update peering phone numbersupdatePeeringPhoneNumbers | PATCH | Allows partners to update the status or details associated with the phone numbers. |
Cloud Recording23
Create a recording registrantmeetingRecordingRegistrantCreate | POST | Register a user to gain access to On-demand cloud recordings of a previous meeting. |
Delete a meeting or webinar transcriptDeleteMeetingTranscript | DELETE | Delete a transcript for a meeting or webinar. |
Delete a recording file for a meeting or webinarrecordingDeleteOne | DELETE | Delete a specific recording file from a meeting or webinar. |
Delete meeting or webinar recordingsrecordingDelete | DELETE | Delete all of a meeting's or webinar's recording files. |
Delete session's recording filerecordingDeleteOneVideoSdk | DELETE | Delete a specific recording file from a session. |
Delete session's recordingsrecordingDeleteVideoSdk | DELETE | Delete all recording files of a session. |
Get a meeting or webinar recording's analytics detailsanalytics_details | GET | Retrieve a meeting or webinar recording's analytics details. |
Get a meeting or webinar recording's analytics summaryanalytics_summary | GET | Retrieve meeting recording's analytics summary. |
Get a meeting transcriptGetMeetingTranscript | GET | Return a meeting's transcript information. |
Get meeting recording settingsrecordingSettingUpdate | GET | Retrieve settings applied to a meeting's cloud recording. |
Get meeting recordingsrecordingGet | GET | Returns all of a meeting's recordings. |
Get registration questionsrecordingRegistrantsQuestionsGet | GET | Retrieve a list of questions that are displayed for users to complete when registering to view the recording of a specific meeting. |
List all recordingsrecordingsList | GET | Lists all cloud recordings for a user. |
List recording registrantsmeetingRecordingRegistrants | GET | Get a list of registrants of a past meeting's on-demand cloud recordings. |
List recordings of an accountrecordingsListVideoSdk | GET | List Video SDK Cloud Recordings available on an account. |
List session's recordingsrecordingGetVideoSdk | GET | Get all the recordings from a session instance. |
Recover a single recordingrecordingStatusUpdateOne | PUT | Recover a single recording file from the meeting. |
Recover a single recordingrecordingStatusUpdateOneVideoSdk | PUT | Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. |
Recover meeting recordingsrecordingStatusUpdateMeetings | PUT | Recover all deleted cloud recordings of a specific meeting. |
Recover session's recordingsrecordingStatusUpdateVideoSdk | PUT | Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. |
Update a registrant's statusmeetingRecordingRegistrantStatus | PUT | Update a registrant's status. |
Update meeting recording settingsrecordingSettingsUpdate | PATCH | Update settings applied to a meeting's cloud recording. |
Update registration questionsrecordingRegistrantQuestionUpdate | PATCH | Update registration questions for users to answer while registering to view a recording. |
Co Editor2
Add or remove event co-editorscoeditoractions | PATCH | Adds or removes event co-editor actions. |
List coeditorsgetCoEditors | GET | Retrieves the list of co-editors and their edit permissions for an event. |
Collaborator13
Add collaborators for a fileAddCollaborators | POST | Share a file with newly added Zoom users or Zoom Team Chat channels. |
Add collaborators to a taskaddTasksCollaborators | POST | Add one or more collaborators to a specified task. |
Get collaborators of a taskGetcollaboratorsofatask | GET | Retrieves all collaborators of a specified task. |
Get collaborators of a whiteboardGetAWhiteboardCollaborator | GET | Returns a list of a whiteboard collaborators. |
List collaborators of a fileListCollaborators | GET | List collaborators of a file. |
Modify a collaborator’s role on a fileModifyCollaboratorRole | PATCH | Modify a collaborator’s role on a file. |
Remove a collaborator from a fileRemoveACollaborator | DELETE | Remove a collaborator from a file. |
Remove collaborator from taskremoveTaskCollaborator | DELETE | Removes a specific collaborator from a task. |
Remove the collaborator from a clipDeleteCollaborator | DELETE | Removes a collaborator from a clip. |
Remove the collaborator from a whiteboardDeleteAWhiteboardCollaborator | DELETE | Removes a collaborator from a whiteboard. |
Share a clip with new usersCreateCollaborator | POST | Create collaborators for a clip. |
Share a whiteboard to new users or team chat channels.AddAWhiteboardCollaborator | POST | Add collaborators to a whiteboard. |
Update whiteboard collaboratorsUpdateAWhiteboardCollaborator | PATCH | Use this API to update whiteboard collaborators. |
Color1
Get the color definitions for calendars and eventsGetcolor | GET | Returns the color definitions for calendars and events. |
Comment5
Add a comment to a taskaddComment | POST | Adds a comment to a specific task. |
Delete a commentDeleteacomment | DELETE | Removes a comment from a clip. |
Delete a task's commentDeleteTaskComment | DELETE | Deletes a specific comment from a task by its ID. |
Get a task's commentsGetAV1TasksComment | GET | Retrieves all comments associated with a specific task. |
List clip commentsListclipcomments | GET | Returns the list of comments for a clip. |
Common Area19
Add a common areaaddCommonArea | POST | Adds an instance of a common area. |
Add common area settingAddCommonAreaSetting | POST | Adds the common area setting according to the setting type. |
Apply template to common areasApplyTemplatetoCommonAreas | POST | Applies a template to common areas. |
Assign calling plans to a common areaassignCallingPlansToCommonArea | POST | Assigns calling plans to a common area. |
Assign phone numbers to a common areaassignPhoneNumbersToCommonArea | POST | Assigns phone numbers to a common area. |
Delete a common areadeleteCommonArea | DELETE | Removes the common area. |
Delete common area settingdeleteCommonAreaSetting | DELETE | Removes the common area subsetting from desk phones. |
Generate activation codes for common areasGenerateactivationcodesforcommonareas | POST | Generates activation codes for common areas. |
Get common area call handling settinggetCommonAreaCallHandlingSetting | GET | Returns the call handling setting of a common area for the specified hour type. |
Get common area detailsgetACommonArea | GET | Returns detailed information on the common area. |
Get common area settingsgetCommonAreaSettings | GET | Returns common area settings. |
List activation codeslistActivationCodes | GET | Returns a list of activation code information of the common areas under an account. |
List common areaslistCommonAreas | GET | Lists common areas under an account. |
Unassign a calling plan from the common areaunassignCallingPlansFromCommonArea | DELETE | Use this API to unassign a calling plan from the common area. |
Unassign phone numbers from common areaunassignPhoneNumbersFromCommonArea | DELETE | Unassigns a phone number from a common area. |
Update common areaupdateCommonArea | PATCH | Updates the common area information. |
Update common area call handling settingupdateCommonAreaCallHandlingSetting | PATCH | Update the call handling setting of a common area for the specified hour type. |
Update common area pin codeUpdateCommonAreaPinCode | PATCH | Updates the common area pin code. |
Update common area settingUpdateCommonAreaSetting | PATCH | Updates the common area setting according to the setting type. |
Contact3
Get user's contact detailsgetUserContact | GET | Returns information on a specific contact of the Zoom user. |
List user's contactsgetUserContacts | GET | Lists all the contacts of a Zoom user. |
Search company contactssearchCompanyContacts | GET | Searches for users that are in the company contacts of a Zoom account. |
Contact Group8
Add contact group memberscontactGroupMemberAdd | POST | Use this API to add members to a contact group. |
Create a contact groupcontactGroupCreate | POST | Use this API to create a contact group. |
Delete a contact groupcontactGroupDelete | DELETE | Use this API to delete a contact group. |
Get a contact groupcontactGroup | GET | Get a contact group under an account. |
List contact group memberscontactGroupMembers | GET | List members in contact groups under an account. |
List contact groupscontactGroups | GET | List contact groups under an account. |
Remove members in a contact groupcontactGroupMemberRemove | DELETE | Removes members in a contact group. |
Update a contact groupcontactGroupUpdate | PATCH | Update a contact group under your account. |
Content3
Delete Whiteboard ContentDeleteWhiteboardContent | DELETE | Delete whiteboard content. |
Get Whiteboard ContentGetWhiteboardContent | GET | Get whiteboard content. |
Save Whiteboard ContentSaveWhiteboardContent | POST | Save whiteboard content. |
Conversation17
Add conversation by file id or download url.AddConversationByFileIdOrDownloadUrl | POST | Add conversation by file ID or third party download URL. |
Add conversation by meeting record url or meeting UUID.addConversationByRecord | POST | Add new conversations by meeting record URL or meeting UUID. |
Add new comments to the conversationaddConversationComments | POST | Add new comments to a specific conversation. |
Delete conversation by conversation IDdeleteConversationById | DELETE | Delete conversation by conversation ID. |
Delete conversation's commentdeleteConversationCommentById | DELETE | Delete comment from a specific conversation. |
Edit conversation commenteditConversationCommentById | PATCH | Edit a comment for a specific conversation. |
Get a user's playlistgetUserPlaylists | GET | Get all playlists for a user. |
Get conversation commentsgetConversationCommentsById | GET | Get comments for a specific conversation. |
Get conversation content analysisgetConversationContentAnalysisById | GET | Get the content analysis for a specific conversation. |
Get conversation informationgetConversationDetail | GET | Get information for a specific conversation. |
Get conversation interactionsgetConversationInteraction | GET | Get interactions for a specific conversation. |
Get conversation scorecardsgetConversationScorecardsById | GET | Get scorecards for a specific conversation. |
Initiate and complete a multipart upload.InitiateAndCompleteAMultipartUpload | POST | Initiate or complete a multipart upload. |
List conversationslistAllConversations | GET | List all conversations. |
Update conversation host idUpdateConversationhostid2NewHostidByConversationId | PATCH | Update the conversation host id to a new host id by conversation id. |
Upload IQ fileUploadZraFile | POST | Upload a file to Zoom Revenue Acclerator. |
Upload iq multipart file.UploadZraMultipartFile | POST | Use this API to upload a multipart file. |
Custom CRM12
Bulk import CRM accountsbulkImportAccounts | POST | Bulk import CRM account objects asynchronously. |
Bulk import CRM contactsbulkImportContacts | POST | Bulk import CRM contact objects asynchronously. |
Bulk import CRM dealsbulkImportDeals | POST | Bulk import CRM deal objects asynchronously. |
Bulk import CRM leadsbulkImportLeads | POST | Bulk import CRM lead objects asynchronously. |
Get current CRM API registrationgetCrmRegistration | GET | Retrieves the current CRM API registration information. |
Get imported CRM accountsgetCrmAccounts | GET | Retrieve CRM account objects by their CRM IDs. |
Get imported CRM contactsgetCrmContacts | GET | Retrieve CRM contact objects by their CRM IDs. |
Get imported CRM dealsgetCrmDeals | GET | Retrieve CRM deal objects by their CRM IDs. |
Get imported CRM leadsgetCrmLeads | GET | Retrieve CRM lead objects by their CRM IDs. |
Poll async task resultgetAsyncTask | GET | Retrieve the execution result of asynchronous task. |
Register CRM API connectionregisterCrm | POST | Register new CRM API integration |
Unregister CRM API connectionunregisterCrm | DELETE | Unregister the current CRM API integration. |
Dashboard45
Get AI adoptionGetAIAdoption | GET | Get the AI adoption summary. |
Get AI KPIsGetAIROIKPIs | GET | Get AI key performance indicators. |
Get AI usage detailsGetAIDetails | GET | Get AI usage and engagement details. |
Get AI usage trendGetAItrends | GET | Get the AI usage and engagement trend. |
Get AIC ROI KPIsgetDashboardKpis | GET | Get AIC ROI KPI data. |
Get AIC ROI meeting summary usagedashboardMeetingSummaryUsage | GET | Get AIC ROI meeting summary usage data. |
Get call details from call loggetCallLogMetricsDetails | GET | Returns call log details of a specific call. |
Get call QoSgetCallQoS | GET | Gets the call quality of service (QoS) data for a call made or received by a Zoom phone user in the account. |
Get chat metricsdashboardChat | GET | Get metrics for how users are utilizing Zoom Chat to send messages. |
Get CRC port usagedashboardCRC | GET | A Cloud Room Connector allows H.323/SIP endpoints to connect to a Zoom meeting. |
Get issues of Zoom RoomsdashboardIssueDetailZoomRoom | GET | Use this API to return information about the Zoom Rooms in an account with issues, such as disconnected hardware or bandwidth issues. |
Get meeting detailsdashboardMeetingDetail | GET | Get details on live or past meetings. |
Get meeting participant QoSdashboardMeetingParticipantQOS | GET | Return the quality of service (QoS) report for participants from live or past meetings. |
Get meeting quality scoresdashboardQuality | GET | Use this API to return meeting quality score information. |
Get meeting sharing/recording detailsdashboardMeetingParticipantShare | GET | Retrieve the sharing and recording details of participants from live or past meetings. |
Get post meeting feedbackparticipantFeedback | GET | When a meeting ends, each attendee will be prompted to share their meeting experience by clicking either thumbs up or thumbs down. |
Get post webinar feedbackparticipantWebinarFeedback | GET | When a Webinar ends, each attendee will be prompted to share their Webinar experience by clicking either thumbs up or thumbs down. |
Get top 25 issues of Zoom RoomsdashboardZoomRoomIssue | GET | Get top 25 issues of Zoom Rooms. |
Get top 25 Zoom Rooms with issuesdashboardIssueZoomRoom | GET | Get information on top 25 Zoom Rooms with issues in a month. |
Get webinar detailsdashboardWebinarDetail | GET | Retrieve details from live or past webinars. |
Get webinar participant QoSdashboardWebinarParticipantQOS | GET | Returns the quality of service (QoS) for participants during live or past webinars. |
Get webinar participantsdashboardWebinarParticipants | GET | Get information about participants from live or past webinars. |
Get webinar sharing/recording detailsdashboardWebinarParticipantShare | GET | Retrieve the sharing and recording details of participants from live or past webinars. |
Get zoom meetings client feedbackdashboardClientFeedbackDetail | GET | Retrieve detailed information on a Zoom meetings client feedback. |
Get Zoom Rooms detailsdashboardZoomRoom | GET | 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. |
List call logslistCallLogsMetrics | GET | Returns monthly call logs metrics. |
List client meeting satisfactionlistMeetingSatisfaction | GET | If the End of Meeting Feedback Survey 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... |
List default emergency address userslistUserDefaultEmergencyAddress | GET | Returns the users who provide a default personal emergency address rather than a default site address or default account address. |
List detectable personal location userslistUserDetectablePersonalLocation | GET | Returns the users who created one or more detectable personal locations with associated network data. |
List meeting participantsdashboardMeetingParticipants | GET | Return a list of participants from live or past meetings. |
List meeting participants QoSdashboardMeetingParticipantsQOS | GET | Show a list of meeting participants from live or past meetings, and their quality of service received during the meeting. |
List meeting participants QoS SummarydashboardMeetingParticipantsQOSSummary | GET | Returns a list of meeting participants from past meetings and the summary of their quality of service received during the meeting. |
List meetingsdashboardMeetings | GET | Lists the total live or past meetings that occurred during a specified period of time. |
List nomadic emergency services userslistUserNomadicEmergencyServices | GET | Returns users who have been enabled for nomadic emergency services. |
List past call metricslistPastCallMetrics | GET | Returns all the call logs metrics of the account from the selected time period. |
List real time location for IP phoneslistPhoneRealtimelocation | GET | Returns currently detected location of IP phones. |
List real time location for userslistUserRealtimeLocation | GET | Returns the user's currently detected location. |
List the client versionsgetClientVersions | GET | Use this API to list all the client versions and its count. |
List tracked locationslistTrackedLocations | GET | Lists the tracked locations. |
List users permission for location sharinglistUserLocationSharingPermission | GET | Returns users that have enabled location services and allowed location sharing with Zoom applications on client devices. |
List webinar participant QoSdashboardWebinarParticipantsQOS | GET | Show a list of webinar participants from live or past webinars and the quality of service they received during the webinar. |
List webinar participants QoS SummarydashboardWebinarParticipantsQOSSummary | GET | Use this API to return a list of webinar participants from live or past webinars and the quality of service they received during the webinar. |
List webinarsdashboardWebinars | GET | Lists all the live or past webinars from a specified period of time. |
List Zoom meetings client feedbackdashboardClientFeedback | GET | Use this API to return Zoom meetings client feedback survey results. |
List Zoom RoomsdashboardZoomRooms | GET | List information on all Zoom Rooms in an account. |
Data Request5
Cancel data deletion requestCancelDataRequest | DELETE | Cancel a pending data request with ID requestId. |
Create data (export/deletion) requestCreateDataAccessRequest | POST | Submit a request to: Export data for a specified time period. |
Get download link for data access request fileDownloadfilesfromDataRequest | GET | Returns download link for given fileId. |
List data request historyGetDataRequestsHistory | GET | Lists all data requests for account. |
List downloadable files for export data requestGetDownloadableFilesforDataRequest | GET | Fetches downloadable file information from an individual data request |
DataTable Content2
Delete a columnDeleteacolumn | DELETE | Delete a column from a table. |
Delete rowsDeleterows | DELETE | Batch delete rows. |
Deal4
Delete activity from the dealDeleteActivityFromDeal | DELETE | Delete specific activity from a deal. |
Get deal activitiesgeAllActivitiesFromDeal | GET | Get activities for a specific deal. |
Get deal informationgetDealDetail | GET | Get information for a specific deal. |
List dealslistAllDeals | GET | List all deals. |
Deal Registration5
Creates a new deal registration for a partnercreateDealReg | POST | Creates a new Deal Registration for a partner. |
Get details of a deal registration by registration numbergetDealRegDetails | GET | Retrieve details for a deal registration by the deal registration number. |
Gets all valid Deal Registrations for a partnergetAllDealRegs | GET | Retrieves all valid deal registrations for a partner. |
Retrieves all valid Zoom Campaigns which a deal registrationgetCampaigns | GET | Retrieves all valid Zoom Campaigns which a deal registration can be associated with. |
Updates an existing deal registrationUpdatesanexistingdealregistration | PATCH | Updates an existing deal registration that has been returned (Deal status = returned). |
Device13
Add a new deviceaddDevice | POST | Add a new device to Zoom account. |
Assign a device to a groupassginGroup | PATCH | Assign a device to a new group. |
Assign a device to a user or commonareaAssigndevicetoauser_commonarea | POST | Assign a device to a user or common area, or move a device to another user or common area, or remove a device. |
Change deviceupdateDevice | PATCH | Change device name. |
Change device associationchangeDeviceAssociation | PATCH | Change a device's association from one Zoom Room to another. |
Delete devicedeleteDeviceMeetings | DELETE | Delete a device from a Zoom account. |
Delete ZPA device by vendor and mac addressDeleteZpaDeviceByVendorAndMacAddress | DELETE | Remove a ZPA device from the device manager, by vendor and mac address. |
Get device detailgetDevice | GET | Retrieve a device's details. |
Get ZDM group infoGetzdmgroupinfo | GET | Get Zoom Device Manager (ZDM) group information for an account. |
Get Zoom Phone Appliance settings by user IDGetZpaDeviceListProfileSettingOfaUser | GET | Get a user's Zoom Phone Appliance (ZPA) device profile settings. |
Get ZPA version infoGetZpaVersioninfo | GET | Get ZPA firmware and app version information that can be upgraded for devices. |
List deviceslistDevices | GET | This API lets you list devices. |
Upgrade ZPA firmware or appUpgradeZpas_app | POST | Upgrade ZPA firmware or app by Zoom Device Manager (ZDM) group ID. |
Device Line Key2
Batch update device line key positionbatchUpdateDeviceLineKeySetting | PATCH | Use this API to batch update the Zoom Phone device line key position information. |
Get device line keys informationlistDeviceLineKeySetting | GET | Use this API to get information on the Zoom Phone device line keys settings and position. |
Dial By Name Directory6
Add users to a directoryAddUsersToDirectory | POST | Use this API to add users to a directory. |
Add users to a directory of a siteAddUsersToDirectoryBySite | POST | Use this API to add users to a directory of the specified site. |
Delete users from a directoryDeleteUsersFromDirectory | DELETE | Use this API to delete users from the directory. |
Delete users from a directory of a siteDeleteUsersFromDirectoryBySite | DELETE | Use this API to delete users from a directory of the specified site. |
List users in a directory by siteListUsersFromDirectoryBySite | GET | Use this API to get users that are in or not in a directory of the specified site. |
List users in directoryListUsersFromDirectory | GET | Use this API to get users that are in or not in a directory. |
Disposition10
Create a dispositioncreateDisposition | POST | Create a new disposition. |
Create a disposition setcreateSet | POST | Create a new disposition set. |
Delete a dispositiondeleteDisposition | DELETE | Delete an existing disposition. |
Delete a disposition setdeleteSet | DELETE | Delete a disposition set. |
Get a dispositiongetDisposition | GET | Retrieve information about a disposition. |
Get a disposition setgetSet | GET | Retrieve information about a disposition set. |
List disposition setslistSets | GET | Return a list of available disposition sets. |
List dispositionslistDispositions | GET | Return a list of available dispositions. |
Update a dispositionupdateDisposition | PATCH | Update an existing disposition. |
Update a disposition setupdateSet | PATCH | Update an existing disposition set. |
Division7
Assign a divisionassigndivisionMember | POST | Assign a division to members. |
Create a divisionCreateadivision | POST | Create a division. |
Delete a divisionDeletedivision | DELETE | Delete an entire division. |
Get a divisionGetdivision | GET | Get a division under an account. |
List division memberslistDivisionMembers | GET | List the users of a division under your account. |
List divisionslistDivisions | GET | List divisions under an account. |
Update a divisionUpdateadivision | PATCH | Update a group under your account. |
Doc Content4
Delete a specific blockDeleteBlock | DELETE | Deletes a block and all its content from the document. |
Insert blocks into a documentInsertblocksintoadocument | POST | Insert new blocks at a specific position in a document. |
Replace a range of blocksReplacearangeofblocks | POST | Replace a contiguous range of sibling blocks with new blocks in a single atomic operation. |
Update a specific blockUpdateBlock | PATCH | Updates the content of an existing block using XML-formatted content. |
Document5
Create a new whiteboardnewWhiteboardCreate | POST | Creates a new whiteboard for a user. |
Delete a whiteboardDeleteAWhiteboard | DELETE | Deletes a whiteboard. |
Get a whiteboardGetAWhiteboard | GET | Returns a whiteboard's information. |
List all whiteboardsListWhiteboards | GET | Use this API to list whiteboards of current user ( Required Scopes : whiteboard:read) or list all whiteboards under the account ( Required Scopes : whiteboard:read:admin). |
Update whiteboard basic informationUpdateAWhiteboardMetadata | PUT | Use this API to rename a whiteboard, update whiteboard status (locked or unlocked). |
Download1
Download a clipdownloadClip | GET | Retrieves the download URL for a specific clip and redirects the client to that URL. |
Draft6
Create a new draft emailcreate_draft_email | POST | Creates a new draft email message. |
Delete an existing draft emaildelete_draft_email | DELETE | Immediately and permanently deletes the specified draft. |
Get the specified draft emailget_draft_email | GET | Retrieves the specified draft. |
List emails from draft folderlist_draft_emails | GET | Lists the draft messages in the mailbox. |
Send out a draft emailsend_draft_email | POST | Sends the specified draft. |
Update the specified draft emailupdate_draft_email | PUT | Replaces a draft email's content. |
Email2
List event email typeslistEmailTypes | GET | Get the list of email types defined for an event. |
List event emails sent statuslistEmailSentStatuses | GET | Get the list of email sent status for an event email type. |
Emergency Address5
Add an emergency addressaddEmergencyAddress | POST | Adds an emergency address. |
Delete an emergency addressdeleteEmergencyAddress | DELETE | Removes an emergency address. |
Get emergency address detailsgetEmergencyAddress | GET | Gets the emergency address information. |
List emergency addresseslistEmergencyAddresses | GET | Lists the emergency addresses. |
Update an emergency addressupdateEmergencyAddress | PATCH | Updates an emergency address information. |
Emergency Service Location6
Add an emergency service locationaddLocation | POST | Adds an emergency service location. |
Batch add emergency service locationsbatchAddLocations | POST | Adds emergency service locations in batch. |
Delete an emergency locationdeleteLocation | DELETE | Removes an emergency location. |
Get emergency service location detailsgetLocation | GET | Returns an emergency service location's information. |
List emergency service locationslistLocations | GET | Returns emergency service locations. |
Update emergency service locationupdateLocation | PATCH | Updates an emergency location's information. |
Engagement12
Get a historical engagementgetEngagement | GET | Retrieve details about a historical/completed engagement. |
Get an engagement's attachmentsListAttachments | GET | Retrieve a list of attachments for a specified engagement. |
Get an engagement's eventsgetEngagementEvents | GET | Retrieve information about an engagement's events. |
Get an engagement's surveygetEngagementSurvey | GET | Get an engagement's survey |
Get available transfer flowsGetAvailableTransferFlows | GET | Retrieve a list of flows that are available for transfer. |
Get available transfer queuesGetAvailableTransferQueues | GET | Return a list of queues that are available for transfer. |
Get available transfer usersGetAvailableTransferUsers | GET | Retrieve a list of available transfer users. |
List historical engagementslistEngagements | GET | Retrieve a list of historical/completed engagements. |
List open engagementslist_open_engagements | GET | Return a list of open engagements. |
Poll an engagement recording's statusEngagementRecordingStatus | GET | Polls a video or voice engagement's recordings' status. |
Start an engagementStartworkitemengagement | POST | Start an engagement. |
Update an engagementupdateEngagement | PATCH | Allows performing an action on an engagement |
Evaluation3
List automated evaluationsListAutomatedEvaluations | GET | List automated evaluations. |
List evaluationsListevaluations | GET | List manually completed evaluations. |
View evaluation detailEvaluationDetail | GET | View a specific interaction's evaluation detail. |
Event15
Create an eventcreateEvent | POST | Creates an event. |
Delete an eventdeleteEvent | DELETE | Delete a draft event. |
Delete an existing event from the specified calendarDeleteevent | DELETE | Deletes an event. |
Event actionsEventActions | POST | Updates the event actions that the host performs for an event. |
Get an eventgetEventInfo | GET | Returns information on a specified event. |
Get the specified event on the specified calendarGetevent | GET | Returns a Zcalendar event. |
Import event to the specified calendarImportevent | POST | Imports an event. |
Insert a new event to the specified calendarInsertevent | POST | Creates an event. |
List all instances of the specified recurring eventInstanceevent | GET | Returns instances of the specified recurring event. |
List eventsgetEvents | GET | Retrieves all events associated with the user. |
List events on the specified calendarListevent | GET | Returns events on the specified calendar. |
Move the specified event from a calendar to another specifiedMoveevent | POST | Moves an event to another calendar, such as changing an event's organizer. |
Quick add an event to the specified calendarQuickaddevent | POST | Creates an event based on a simple text string. |
Update an eventupdateEvent | PATCH | Updates an event. |
Update the specified event on the specified calendarPatchevent | PATCH | Updates an event. |
Event Access5
Create event access linkcreateEventAccessLink | POST | Creates an access link for an event. |
Delete event access linkdeleteEventAccessLink | DELETE | Deletes an event access link. |
Get event access linkGetEventAccessLink | GET | Retrieves event access link information. |
List event access linksgetEventAccessLinks | GET | Retrieves a list of all the event's access links associated with the event. |
Update event accessupdateEventAccess | PATCH | Updates the event access for an event ID. |
Exhibitor6
Create an exhibitorcreateExhibitor | POST | Creates an exhibitor for a multi-session and conference-type event. |
Delete an exhibitordeleteExhibitor | DELETE | Deletes an exhibitor. |
Get an exhibitorgetExhibitorInfo | GET | Returns the exhibitor information of a specified event. |
List exhibitorsgetExhibitors | GET | Lists all exhibitors associated with an event. |
List sponsor tiersListSponsorTiers | GET | Lists all sponsor tiers associated with an event. |
Update exhibitor for an eventupdateExhibitor | PATCH | Updates the exhibitor for an event ID. |
Export6
Create a file exportCreateafileexport | POST | Creates a export for specified file. |
Create whiteboard exportCreatewhiteboardsexport | POST | Generates the export for the provided whiteboards. |
Download whiteboard exportDownloadwhiteboardexport | GET | Use this API to download the whiteboard export. |
Get file contentGetfilecontent | GET | Retrieves the file name and full file content in Markdown format. |
Get file export statusGetfileexportstatus | GET | Use this API to query the status of a file export. |
Get whiteboard export generation statusGetwhiteboardexportdatagenerationstatus | GET | Use this API to query the status of the whiteboard export generation. |
External Contact5
Add an external contactaddExternalContact | POST | Adds an external contact. |
Delete an external contactdeleteAExternalContact | DELETE | Removes an external contact. |
Get external contact detailsgetAExternalContact | GET | Returns an external contact's information. |
List external contactslistExternalContacts | GET | Lists the external contacts. |
Update external contactupdateExternalContact | PATCH | Updates an external contact's information. |
Fax8
Delete fax logDeleteFaxLog | DELETE | Deletes a specific fax log. |
Download fax fileDownloadfaxfile | GET | Downloads the fax file. |
Get account's fax logsGetAccount_sFaxLogs | GET | Returns the account's fax logs. |
Get extension's fax logsGetuser_sfaxlogs | GET | Returns the extension's fax logs. |
Get fax log detailsGetFaxLogDetails | GET | Returns the fax log's details. |
Send faxSendEFax | POST | Sends a fax to receivers. |
Update fax log read statusUpdateFaxLogReadStatus | PATCH | Updates the read status of a specific fax log. |
Upload fax fileUploadFaxFiles | POST | Uploads fax file |
File8
Download Imported Whiteboard FileDownloadembeddedwhiteboardfile | GET | Download files imported into the whiteboard, including images, PDFs, DOCX, and other supported formats. |
Initiate and complete the multipart file uploadinitiateAndCompleteAEventMultipartUpload | POST | Uploads files to Zoom Events using a multipart API Use this API when the file is large, typically when the size reaches 2 GB. |
Upload a fileuploadAFile | POST | Upload a file. |
Upload a file in tasksUploadfilefortasksimport | POST | Uploads a file to tasks. |
Upload events fileuploadEventFile | POST | Uploads files to Zoom Webinars Plus & Events. |
Upload events multipart filesuploadMultipartEventFile | POST | Uploads a multipart file. |
Upload file for video managementuploadFileToVideoMgmt | POST | Uploads a file to Zoom Video Management and returns a file id that can be used in subsequent resource requests. |
Upload file for whiteboard importUploadfileforwhiteboardimport | POST | Uploads a file to whiteboard. |
File Management7
Create a new fileCreateDoc | POST | Creates a new file for a user. |
Delete a fileDeleteFile | DELETE | Delete a file. |
Get metadata of a fileQueryFileMetadata | GET | Get metadata of a file. |
Get user My docs infoGetUserMyDocsID | GET | Get the specified user's My docs info. |
List all children of a fileListAllChildren | GET | List all children of a file. |
Modify metadata of a fileModifyMetadata | PATCH | Modify metadata of a file. |
Transfer ownership of a fileTransferOwnershipOfAFile | PUT | Transfer a file’s ownership to another user. |
File Upload1
Create file upload for docs import or attachmentsUploadfilefordocsimportorattachments | POST | Create a file upload for document import or attachments. |
Filter Group1
List filter groupsListfiltergroups | GET | Get all filter groups |
Firmware Update Rule6
Add a firmware update ruleAddFirmwareRule | POST | Use this API to add a firmware update rule. |
Delete firmware update ruleDeleteFirmwareUpdateRule | DELETE | Use this API to delete the firmware update rule. |
Get firmware update rule informationGetFirmwareRuleDetail | GET | Use this API to get the firmware update rule information. |
List firmware update rulesListFirmwareRules | GET | Use this API to get firmware update rules. |
List updatable firmwaresListFirmwares | GET | Use this API to get updatable firmwares. |
Update firmware update ruleUpdateFirmwareRule | PATCH | Use this API to update a specific firmware update rule. |
Flow11
Add flow entry pointsAddFlowEntryPoints | POST | Add entry points to a flow. |
Delete a flowDeleteFlow | DELETE | Delete a flow. |
Edit a flowEditFlow | PATCH | Edit a flow's attributes. |
Export a flowExportFlow | GET | Export a flow's content as JSON. |
Get a flowgetAFlow | GET | Get information about a flow. |
Import a flowImportFlow | POST | Import and create a flow, using content from another flow's exported JSON. |
List entry pointsListentryPoints | GET | Retrieve a list of entry points. |
List flow's entry pointsListFlowEntryPoints | GET | Retrieve a list of the entry points bound to the current flow. |
List flowslistFlows | GET | Return a list of flows. |
Publish a flowPublishFlow | PUT | Publish a flow version. |
Remove flow entry pointsRemoveFlowEntryPoints | DELETE | Remove entry points from a flow. |
Follow Up Task3
Get a follow-up taskengagementFollowUpTaskGet | GET | Returns a single follow-up task by engagement and task ID. |
List engagement follow-up tasksengagementFollowUpTasksBatchList | GET | Returns a list of follow-up tasks under an engagement. |
Update a follow-up taskengagementFollowUpTaskPatch | PATCH | Updates a single follow-up task. |
Forecast2
Get a forecast for a scheduling groupGetforecastofschedulinggroup | GET | List forecasted values for a scheduling group within a forecast. |
List forecastsListforecasts | GET | List forecasts. |
Freebusy1
Query freebusy information for a set of calendarsQueryfreebusy | POST | Returns free or busy information for a set of calendars. |
General Access2
Get the general access setting of a fileGetFileGeneralAccess | GET | Get the general access settings of a file. |
Modify the general access setting of a fileModifyFileGeneralAccess | PATCH | Modify the general access setting for a file. |
Group29
Add group adminsgroupAdminsCreate | POST | Use this API to add administrators to a group under your account. |
Add group membersgroupMembersCreate | POST | Use this API to add users to a group in your account. |
Create a groupgroupCreate | POST | Use this API to create a group. |
Create a groupgroupScim2Create | POST | Create a new group. |
Delete a groupgroupDelete | DELETE | Delete an entire group. |
Delete a groupgroupSCIM2Delete | DELETE | Delete a group. |
Delete a group admingroupAdminsDelete | DELETE | Use this API to remove a group administrator in a Zoom account. |
Delete a group membergroupMembersDelete | DELETE | Use this API to remove a user from a group in an account. |
Delete Virtual Background filesdelGroupVB | DELETE | Use this API to delete a group's Virtual Background files. |
Get a groupgroup | GET | Get a group under an account. |
Get a groupgroupSCIM2Get | GET | Get the specific group's information. |
Get a group's settingsgetGroupSettings | GET | Get settings for a group. |
Get a group's webinar registration settingsgroupSettingsRegistration | GET | Get webinar registration settings for a group. |
Get group phone settingsgetGroupPhoneSettings | GET | Returns group phone settings. |
Get group policy detailsGetGroupPolicyDetails | GET | Returns the group policy details. |
Get locked settingsgetGroupLockSettings | GET | Retrieve a group's locked settings. |
List group adminsgroupAdmins | GET | Use this API to return a list of group administrators under your account. |
List group channelsgroupChannels | GET | Returns a list of channels for a group under your account. |
List group membersgroupMembers | GET | List the members of a group under your account. |
List groupsgroupSCIM2List | GET | List all groups. |
List groupsgroups | GET | List groups under an account. |
Update a groupgroupSCIM2Update | PATCH | Update group information and manage its members, including adding, removing, and replacing members. |
Update a groupgroupUpdate | PATCH | Update a group under your account. |
Update a group memberupdateAGroupMember | PATCH | Use this API to perform either of the following tasks: Remove a group member from one group and move them to a different group. |
Update a group's settingsupdateGroupSettings | PATCH | Update settings for a group. |
Update a group's webinar registration settingsgroupSettingsRegistrationUpdate | PATCH | Update webinar registration settings for a group.<p style="background-color: FEEFB3; color: 9F6000"> Note:</b> The force pmi jbh password field under meeting... |
Update group policyupdateGroupPolicy | PATCH | Updates the group policy. |
Update locked settingsgroupLockedSettings | PATCH | Update a group's locked settings. |
Upload Virtual Background filesuploadGroupVB | POST | Use this API to upload Virtual Background files for all users in a group to use. |
Group Call Pickup8
Add a group call pickup objectaddGCP | POST | Use this API to add a Group Call Pickup instance to the account that has the Zoom Phone license assigned. |
Add members to a call pickup groupaddGCPMembers | POST | Use this API to add members to the specified Group Call Pickup object. |
Delete group call pickup objectsdeleteGCP | DELETE | Use this API to remove a Group Call Pickup object. |
Get call pickup group by IDGetGCP | GET | Use this API to retrieve information on a specific Group Call Pickup object in an account. |
List call pickup group memberslistGCPMembers | GET | Use this API to retrieve members of a call pickup group in an account. |
List group call pickup objectslistGCP | GET | Use this API to retrieve a list of Group Call Pickup objects in an account. |
Remove members from call pickup groupremoveGCPMembers | DELETE | Use this API to remove member from the Group Call Pickup object. |
Update the group call pickup informationupdateGCP | PATCH | Use this API to update a specific Group Call Pickup object information. |
H323 Device4
Create a H.323/SIP devicedeviceCreate | POST | |
Delete a H.323/SIP devicedeviceDelete | DELETE | |
List H.323/SIP devicesdeviceList | GET | |
Update a H.323/SIP devicedeviceUpdate | PATCH | Edit information for a H.323/SIP device from your Zoom account. |
History1
List history of events for mailboxlist_mailbox_history | GET | Lists the history of the changes to the given mailbox. |
Hub5
Creates a new hub hostcreateHubHost | POST | Add a host to the hub. |
List hub HostsgethubhostList | GET | Retrieves a list of hub hosts. |
List hub videosListHubVideos | GET | Lists the video/recording resources of a hub. |
List hubsgetHubList | GET | Retrieves a list of event hubs. |
Remove hub hostdeleteHubHost | DELETE | Delete a host from the hub. |
IM Chat1
Send IM messagessendimmessages | POST | Sends the chat message to a user. |
IM Group8
Add IM directory group membersimGroupMembersCreate | POST | Add members to an IM directory group under an account. |
Create an IM directory groupimGroupCreate | POST | Create an IM directory group under your account. |
Delete an IM directory groupimGroupDelete | DELETE | Deletes an IM directory group under your account. |
Delete IM directory group memberimGroupMembersDelete | DELETE | Delete a member from an IM directory group under an account. |
List IM directory group membersimGroupMembers | GET | Lists the members of an IM directory group. |
List IM directory groupsimGroups | GET | Lists IM directory groups. |
Retrieve an IM directory groupimGroup | GET | Retrieves an IM directory group under your account. |
Update an IM directory groupimGroupUpdate | PATCH | Updates an IM directory group under your account. |
Import12
Create a new file by importCreateanewfilebyimport | POST | Creates a new file from a file upload. |
Create a new file from contentcreateNewFileWithMarkdown | POST | Creates a new doc from Markdown content. |
Create a new whiteboard by importCreateWhiteboardImport | POST | Creates a new whiteboard for a user by converting Miro, Mural, or Visio files. |
Delete historical agent statusdeleteHistoricalAgentStatus | DELETE | Delete historical agent status events for a user within a specified time range (start time inclusive, end time exclusive). |
Get file import statusGetdocsfileimportstatus | GET | Use this API to query the status of a new file by import. |
Get historical queue metrics import metadataViewhistoricalqueuemetricimoprtmeta | GET | Retrieve a list of historical queue metrics import metadata. |
Get import job statusgetTasksImportJob | GET | Retrieve an import job's current status and results. |
Get whiteboard import statusGetWhiteboardimportstatus | GET | Use this API to query the status of new whiteboard by import. |
Submit a task import jobsubmitTasksImportJob | POST | Submit an asynchronous import job to import tasks from an external platform into Zoom Tasks. |
Upload forecast staffingUploadStaffing | POST | Import interval-level staffing into Zoom Workforce Management (WFM) by uploading a CSV file and creating an imported staffing forecast. |
Upload historical agent statusuploadHistoricalAgentStatus | POST | Import external historical agent status change events into WFM for adherence reporting. |
Upload historical queue metricsUploadhistoricalqueuemetrics | POST | Import historical queue metrics to Workforce Management (WFM). |
In Meeting App2
Add a meeting appmeetingAppAdd | POST | Add an auto-open app in a meeting. |
Delete a meeting appmeetingAppDelete | DELETE | Delete a meeting auto-open app. |
In Meeting Feature5
Delete a live meeting messagedeleteMeetingChatMessageById | DELETE | Delete a message in a live meeting, based on ID. |
Get a meeting's join token for local recordingmeetingLocalRecordingJoinToken | GET | Get a meeting's join token to allow for local recording. |
Get meeting's tokenmeetingToken | GET | Get a meeting's closed caption token (caption URL). |
In-meeting controlsinMeetingRecordingControl | PATCH | In-meeting controls include starting, stopping, pausing, and resuming a recording; inviting participants; updating the waiting room with a custom message; and starting, stopping, or... |
Update a live meeting messageupdateMeetingChatMessageById | PATCH | Update a message in a live meeting, based on ID. |
Inbound Blocked List10
Add an account's inbound block ruleAddAccountLevelInboundBlockRules | POST | Adds an account level block rule for inbound calls and messaging from a phone number. |
Add an extension's inbound block ruleAddExtensiontLevelInboundBlockRules | POST | Adds the given extension's block rule for inbound calls and messaging. |
Delete an account's inbound block ruleDeleteAccountLevelInboundBlockRules | DELETE | Deletes the account level blocked rule for inbound calls and messaging. |
Delete an account's inbound blocked statisticsDeleteAccountLevelInboundBlockedStatistics | DELETE | Deletes the statistic of extensions blocked rule for inbound calls and messaging. |
Delete an extension's inbound block ruleDeleteExtensiontLevelInboundBlockRules | DELETE | Deletes the given extension's blocked rule for inbound calls and messaging. |
List an account's inbound block rulesListAccountLevelInboundBlockRules | GET | Returns a list of account level inbound block rule for inbound calls and messaging. |
List an account's inbound blocked statisticsListAccountLevelInboundBlockedStatistics | GET | Returns the list of the statistics of the extensions blocked rule for inbound calls and messaging. |
List an extension's inbound block rulesListExtensionLevelInboundBlockRules | GET | Returns a list of the given extension's block rule for inbound calls and messaging. |
Mark a phone number as blocked for all extensionsMarkPhoneNumberAsBlockedForAllExtensions | PATCH | Promotes and applies the phone number blocked from the extension level blocked rule to the account level blocked rule. |
Update an account's inbound block ruleUpdateAccountLevelInboundBlockRule | PATCH | Updates the account level block rule for inbound calls and messaging. |
Inbox18
Assign inbox access queuesassignInboxQueues | POST | Assign queues access to an inbox. |
Assign inbox access usersassignInboxUsers | POST | Assign users to a Contact Center inbox. |
Create an inboxinboxCreate | POST | Create a new inbox. |
Delete an inbox messageinboxMessageDelete | DELETE | Delete a single message in an inbox. |
Delete an inbox's messagesinboxMessagesDelete | DELETE | Delete messages in an inbox. |
Delete inbox messagesinboxesMessagesDelete | DELETE | Delete messages. |
Delete inboxesinboxesDelete | DELETE | Delete one or more inboxes. |
Get an inboxgetInbox | GET | Retrieve an inbox. |
Get an inbox email notification listGetinboxemailnotificationlist | GET | Retrieve a list of inbox email notifications. |
Get inbox access queueslistInboxQueues | GET | Retrieve a list of queues that have access to an inbox. |
List an account's inbox messageslistInboxesMessages | GET | Return all messages in an inbox. |
List an inbox's messageslistInboxMessages | GET | Return a list of all messages in an inbox. |
List inbox userslistInboxUsers | GET | Retrieve a list of users assigned to an inbox. |
List inboxeslistInbox | GET | Return a list of inboxes. |
Remove inbox access queuesunassignInboxQueues | DELETE | Remove queues' access to an inbox. |
Unassign inbox access usersunassignInboxUsers | DELETE | Remove users' access to an inbox. |
Update an inboxinboxUpdate | PATCH | Update an inbox. |
Update an inbox's email notification settingUpdateaninboxemailnotification | PATCH | Update an inbox's email notification setting for a given user. |
Information Barrier5
Create an Information Barrier policyInformationBarriersCreate | POST | Create a new Information Barrier policy. |
Get an Information Barrier policy by IDInformationBarriersGet | GET | Return an Information Barriers policy by its ID. |
List information Barrier policiesInformationBarriersList | GET | Return a list of all Information Barriers policies and their information. |
Remove an Information Barrier policyInformationBarriersDelete | DELETE | Remove an Information Barrier policy. |
Update an Information Barriers policyInformationBarriersUpdate | PATCH | Update an Information Barriers policy. |
Insight1
Get attendee engagement datagetAttendeeEngagement | GET | Retrieves engagement data for a specific attendee in a Zoom Events hub. |
Interaction3
Add an interactionAddinteraction | POST | Add an interaction by a third party download URL. |
List interactionsListInteractions | GET | List interactions. |
View interaction detailInteractionDetail | GET | View the details of a specific interaction. |
Invitation1
Send new contact invitationsendNewContactInvitation | POST | Sends a new contact invitation. |
Invitation & Registration10
Add a meeting registrantmeetingRegistrantCreate | POST | Create and submit a user's registration to a meeting. |
Create a meeting's invite linksmeetingInviteLinksCreate | POST | Create a batch of invitation links for a meeting. |
Delete a meeting registrantmeetingregistrantdelete | DELETE | Delete a meeting registrant. |
Get a meeting registrantmeetingRegistrantGet | GET | Retrieve details on a specific user who has registered for the meeting. |
Get meeting invitationmeetingInvitation | GET | Retrieve the meeting invitation note for a specific meeting. |
List meeting registrantsmeetingRegistrants | GET | List users that have registered for a meeting. |
List registration questionsmeetingRegistrantsQuestionsGet | GET | List registration questions that will be displayed to users while registering for a meeting. |
Perform batch registrationaddBatchRegistrants | POST | Register up to 30 registrants at once for a meeting that requires registration. |
Update registrant's statusmeetingRegistrantStatus | PUT | Update a meeting registrant's status by either approving, cancelling or denying a registrant from joining the meeting. |
Update registration questionsmeetingRegistrantQuestionUpdate | PATCH | Update registration questions that will be displayed to users while registering for a meeting. |
IVR2
Get auto receptionist IVRgetAutoReceptionistIVR | GET | Returns an interactive voice response (IVR) system of the specified auto receptionist. |
Update auto receptionist IVRupdateAutoReceptionistIVR | PATCH | Updates the interactive voice response (IVR) system of the specified auto receptionist. |
Knowledge Management7
Create articleCreateArticle | POST | Creates a knowledge base article. |
Create sync requestCreateSyncRequest | POST | Creates a sync request for the specified knowledge base |
Delete articleDeleteArticle | DELETE | Deletes a knowledge base article. |
Get articleGetArticle | GET | Returns a knowledge base article. |
Get articlesGetArticles | GET | Returns multiple knowledge base articles. |
Get syncGetSync | GET | Returns the details of a knowledge base sync. |
Update articleUpdateArticle | PUT | Updates a knowledge base article. |
Label6
Create a new label in mailboxcreate_label_in_mailbox | POST | Creates a new label. |
Delete an existing label from mailboxdelete_label_from_mailbox | DELETE | Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to. |
Get the specified label in mailboxget_label_in_mailbox | GET | Retrieves the specified label. |
List labels in the mailboxlist_labels_in_mailbox | GET | Lists all labels in the mailbox. |
Patch the specified label in mailboxpatch_label_in_mailbox | PATCH | Patch the specified label. |
Update the specified label in mailboxupdate_label_in_mailbox | PUT | Updates the specified label. |
Legal Hold6
Add a legal hold matteraddLegalHoldMatter | POST | Adds a new legal hold matter. |
Delete legal hold mattersdeleteLegalHoldMatters | DELETE | Deletes a legal hold matter. |
Download legal hold files for given matterdownloadLegalHoldFiles | GET | Downloads a zip file. |
List legal hold files by given matterlistLegalHoldFiles | GET | Returns a list files for given legal hold matter. |
List legal hold matterslistLegalHoldMatters | GET | Returns a list of legal hold matters. |
Update legal hold matterupdateLegalHoldMatter | PATCH | Updates the name for a given legal hold matter. |
Line Key3
Batch update line key position and settings informationBatchUpdateLineKeySetting | PATCH | Use this API to batch update the Zoom Phone line key settings information. |
Delete a line key setting.DeleteLineKey | DELETE | Use this API to delete the Zoom Phone line key settings information. |
Get line key position and settings informationlistLineKeySetting | GET | Use this API to get the Zoom Phone line key settings information. |
Live Streaming4
Get a meeting's join token for live streamingmeetingLiveStreamingJoinToken | GET | Get a meeting's join token to allow live streaming. |
Get livestream detailsgetLiveStreamDetails | GET | Zoom allows users to livestream a meeting to a custom platform. |
Update a livestreammeetingLiveStreamUpdate | PATCH | Update a meeting's livestream information. |
Update livestream statusmeetingLiveStreamStatusUpdate | PATCH | Zoom allows users to livestream a meeting to a custom platform. |
Log5
List email message historygetEmailMessageHistory | GET | Retrieve the list of messages exchanged during a specific email engagement. |
List message historygetMessageHistory | GET | Retrieve the list of messages exchanged during a specific messaging engagement. |
List SMS logslistSMS | GET | Returns a list of SMS engagement logs. |
List voice call logslistVoiceCall | GET | Return a list of voice call engagement logs. |
List work item message historygetWorkItemMessageHistory | GET | Retrieve the list of messages exchanged during a specific work item engagement. |
Mailbox1
Get the mailbox profileget_mailbox_profile | GET | Get the mailbox profile. |
Manifest3
Export an app manifest from an existing appgetAppManifest | GET | Exports an app's manifest file. |
Update an app by manifestupdateAppByManifest | PUT | Updates an app from an app manifest |
Validate an app manifestvalidatingManifest | POST | Validates an app manifest. |
Meeting13
Create a meetingmeetingCreate | POST | Creates a meeting for a user. |
Delete a meetingmeetingDelete | DELETE | Delete a meeting. |
Get a meetingmeeting | GET | Retrieve the given meeting's details. |
Get a meeting SIP URI with passcodegetSipDialingWithPasscode | POST | Get a meeting's SIP URI. |
Get past meeting detailspastMeetingDetails | GET | Get information about a past meeting. |
Get past meeting participantspastMeetingParticipants | GET | Retrieve participant information for a past meeting. |
List meetingsmeetings | GET | List a meeting host user's scheduled meetings. |
List past meeting instancespastMeetings | GET | Return a list of past meeting instances. |
List past meetings' Q&AlistPastMeetingQA | GET | List Q&A of a specific meeting. |
List upcoming meetingslistUpcomingMeeting | GET | List a Zoom user's upcoming meetings. |
Update a meetingmeetingUpdate | PATCH | Updates meeting details. |
Update meeting statusmeetingStatus | PUT | Update the status of a meeting. |
Update participant Real-Time Media Streams (RTMS) app statusmeetingRTMSStatusUpdate | PATCH | Update the Real-Time Media Streams (RTMS) status for a specific participant in an ongoing meeting. |
Message10
Batch delete the specified emailsbatch_delete_emails | POST | Deletes multiple messages specified in request body. |
Batch modify the specified emailsbatch_modify_emails | POST | Modifies the labels on the specified messages. |
Create a new emailcreate_email | POST | Directly inserts a message into this mailbox. |
Delete an existing emaildelete_email | DELETE | Immediately and permanently deletes the specified message. |
Get the specified emailget_email | GET | Retrieves the specified message. |
List emails from the mailboxlist_emails | GET | Lists the messages in the user's mailbox. |
Move the specified email out of TRASH folderuntrash_email | POST | Moves a message out of TRASH folder. |
Move the specified email to TRASH foldertrash_email | POST | Moves the specified message to the TRASH folder. |
Send out an emailsend_email | POST | Sends the specified message to the recipients as specified in the email. |
Update the specified emailupdate_email | POST | Modifies the labels on the specified message. |
Messages Attachment1
Get the specified attachment for an emailget_email_attachment | GET | Retrieves the specified message attachment. |
Messaging1
Send a messageSendaMessage | POST | Send a message via the specified messaging channel. |
Monitoring Group9
Add members to a monitoring groupaddMembers | POST | Use this API to add members to a Monitoring Group. |
Create a monitoring groupcreateMonitoringGroup | POST | Creates a monitoring group. |
Delete a monitoring groupdeleteMonitoringGroup | DELETE | Use this API to delete a Monitoring Group. |
Get a list of monitoring groups on an accountlistMonitoringGroup | GET | Returns an account's monitoring group list. |
Get members of a monitoring grouplistMembers | GET | Use this API to return members list of a Monitoring Group. |
Get monitoring group by IDgetMonitoringGroupById | GET | Returns a monitoring group for the specified ID. |
Remove a member from a monitoring groupremoveMember | DELETE | Use this API to remove a member from a Monitoring Group. |
Remove all monitors or monitored members from a monitoring groupremoveMembers | DELETE | Use this API to remove all monitor or monitored members from a Monitoring Group. |
Update a monitoring groupupdateMonitoringGroup | PATCH | Use this API to update a Monitoring Group. |
My Notes Management2
Get My Notes content and transcriptDocBridgeInternalOpenAPIService_InternalOpenAPIGetMyNotes | GET | Retrieve a note from My Notes, including its metadata and note content. |
List my notesListMyNotesByMeetingId | GET | Retrieves the user's notes associated with a specific meeting. |
Note4
Get a notegetNote | GET | Retrieve a note. |
List engagement notesengagementNotes | GET | Return a list of notes under an engagement. |
List notesnotes | GET | Return a list of notes. |
Update a notenoteUpdate | PATCH | Update a note. |
Operating Hour14
Create a closure setclosuresSetCreate | POST | Create a new closure set. |
Create business hoursbusinessHourCreate | POST | Create new business hours. |
Delete a closure setclosureSetDelete | DELETE | Delete closure sets. |
Delete business hoursbusinessHourDelete | DELETE | Delete business hours. |
Get a closure setgetAClosureSet | GET | Get information about a closure set. |
Get business hoursgetABusinessHour | GET | Get information about business hours. |
List business hourslistBusinessHours | GET | Get a list of business hours. |
List closureslistClosures | GET | Get a list of closures. |
List the business hours' flowslistBusinessHourFlows | GET | Show a list of flows using business hours. |
List the business hours' queueslistBusinessHourQueues | GET | Show a list of queues using business hours. |
List the closures' flowslistClosureSetFlows | GET | Show a list of flows using closures. |
List the closures' queueslistClosureSetQueues | GET | Show a list of queues using closures. |
Update a closure setclosureSetUpdate | PATCH | Update information about a closure set. |
Update business hoursbusinessHourUpdate | PATCH | Update business hours. |
Order4
Create a subscription order for a Zoom partnercreateOrder | POST | Create a subscription order for a Zoom partner's end customers. |
Get order details by order reference IDgetOrderDetails | GET | Gets order details by order reference ID. |
Gets all orders for a Zoom partner.getAllOrders | GET | Returns all orders for a Zoom partner based on specified filters. |
Preview delta order metrics and subscriptions in an ordercreateOrderPreview | POST | Previews the delta order metrics and subscriptions in an order. |
Organizational Group5
Create an organizational groupcreateOrganizationalGroup | POST | Create an organizational group. |
Delete organizational groupdeleteOrganizationalGroup | DELETE | Delete an organizational group. |
Get a single organizational groupgetOrganizationalGroup | GET | Get a single organizational group. |
Get multiple organizational groupsgetMultipleOrganizationalGroups | GET | Get multiple organizational groups. |
Update an organizational groupupdateOrganizationalGroup | PATCH | Update an organizational group. |
Outbound Calling24
Add account level outbound calling exception ruleAddAccountOutboundCallingExceptionRule | POST | Adds the account level outbound calling policy exception rule for country region. |
Add common area level outbound calling exception ruleAddCommonAreaOutboundCallingExceptionRule | POST | Adds the common area level outbound calling policy exception rule for the country region. |
Add site level outbound calling exception ruleAddSiteOutboundCallingExceptionRule | POST | Adds the site level outbound calling policy exception rule for the country region. |
Add user level outbound calling exception ruleAddUserOutboundCallingExceptionRule | POST | Adds an user level outbound calling policy exception rule for the country region. |
Delete account level outbound calling exception ruledeleteAccountOutboundCallingExceptionRule | DELETE | Deletes the account level outbound calling exception rule. |
Delete common area level outbound calling exception ruledeleteCommonAreaOutboundCallingExceptionRule | DELETE | Deletes the common area level outbound calling exception rule. |
Delete site level outbound calling exception ruledeleteSiteOutboundCallingExceptionRule | DELETE | Deletes the site level outbound calling exception rule. |
Delete user level outbound calling exception ruledeleteUserOutboundCallingExceptionRule | DELETE | Deletes the user level outbound calling exception rule. |
Get account level outbound calling countries and regionsGetAccountOutboundCallingCountriesAndRegions | GET | Returns the account level outbound calling countries and regions. |
Get common area level outbound calling countries and regionsGetCommonAreaOutboundCallingCountriesAndRegions | GET | Returns the common area level outbound calling countries and regions. |
Get site level outbound calling countries and regionsGetSiteOutboundCallingCountriesAndRegions | GET | Returns the site level outbound calling countries and regions. |
Get user level outbound calling countries and regionsGetUserOutboundCallingCountriesAndRegions | GET | Returns the user level outbound calling countries and regions. |
List account level outbound calling exception ruleslistAccountOutboundCallingExceptionRule | GET | Lists the account level outbound calling policy exception rules. |
List common area level outbound calling exception ruleslistCommonAreaOutboundCallingExceptionRule | GET | Lists the common area level outbound calling policy exception rules. |
List site level outbound calling exception ruleslistSiteOutboundCallingExceptionRule | GET | Returns a list of site level outbound calling policy exception rules. |
List user level outbound calling exception ruleslistUserOutboundCallingExceptionRule | GET | Returns a list of the user level outbound calling policy exception rules. |
Update account level outbound calling countries or regionsUpdateAccountOutboundCallingCountriesOrRegions | PATCH | Updates the account level outbound calling policy country or region. |
Update account level outbound calling exception ruleUpdateAccountOutboundCallingExceptionRule | PATCH | Updates the account level outbound calling policy for the country region exception rule. |
Update common area level outbound calling countries or regionsUpdateCommonAreaOutboundCallingCountriesOrRegions | PATCH | Updates the common area level outbound calling policy country or region. |
Update common area level outbound calling exception ruleUpdateCommonAreaOutboundCallingExceptionRule | PATCH | Updates the common area level outbound calling policy for the country region exception rule. |
Update site level outbound calling countries or regionsUpdateSiteOutboundCallingCountriesOrRegions | PATCH | Updates the site level outbound calling policy country or region. |
Update site level outbound calling exception ruleUpdateSiteOutboundCallingExceptionRule | PATCH | Updates the site level outbound calling policy for the country region exception rule. |
Update user level outbound calling countries or regionsUpdateUserOutboundCallingCountriesOrRegions | PATCH | Updates the user level outbound calling policy country or region. |
Update user level outbound calling exception ruleUpdateUserOutboundCallingExceptionRule | PATCH | Updates the user level outbound calling policy for the country region exception rule. |
PAC1
List a user's PAC accountsuserPACs | GET | Retrieve a list of a user's personal audio conference (PAC) accounts. |
Participant1
Get participant identifier codeget_participant_identifier_code | GET | Authenticate CRC meetings. |
Permission4
Create channel permissionscreateChannelPermissions | POST | Creates permissions for the given channel ID. |
Delete channel permissionsDeleteChannelPermissions | DELETE | Delete channel permissions. |
List channel permissionslistChannelPermissions | GET | Retrieves the list of permissions for a channel. |
Update channel permissionsupdateChannelPermissions | PATCH | Updates channel permissions. |
Phone Device11
Add a deviceaddPhoneDevice | POST | Adds an unassigned desk phone or an assigned (to a user or a common area) desk phone. |
Assign an entity to a deviceaddExtensionsToADevice | POST | By default, all Zoom Phone users can make and receive calls using the Zoom desktop and mobile applications. |
Delete a devicedeleteADevice | DELETE | Remove a desk phone device or ATA (Analog Telephone Adapter) from the Zoom Phone System Management. |
Get device detailsgetADevice | GET | Returns detailed information about a specific desk phone device. |
List deviceslistPhoneDevices | GET | Lists all the desk phone devices that are configured with Zoom Phone on an account. |
List SmartphonesListSmartphones | GET | Returns a list of all the smartphones configured with Zoom Phone on an account. |
Reboot a desk phonerebootPhoneDevice | POST | Use this API to reboot an online zero-touch or assisted-provisioning device. |
Sync deskphonessyncPhoneDevice | POST | Use this API to resync all online zero-touch or assisted-provisioning devices in an account or a site. |
Unassign an entity from the devicedeleteExtensionFromADevice | DELETE | Use this API to unassign a specific assignee from the device. |
Update a deviceupdateADevice | PATCH | Updates the information of a desk phone device. |
Update provision template of a deviceupdateProvisionTemplateToDevice | PUT | Use this API to assign a provision template to a device or remove a provision template from the device by leaving templateId empty. |
Phone Number9
Add BYOC phone numbersAddBYOCPhoneNumber | POST | Adds BYOC (Bring Your Own Carrier) phone numbers to Zoom Phone. |
Allocate/Unallocate phone numbersAllocateNumber | PATCH | Allocates or unallocates phone numbers for those with CPL routing. |
Assign a phone number to a userassignPhoneNumber | POST | Assigns a phone number to a user who has already enabled Zoom Phone. |
Delete phone numbersDeleteNumbers | DELETE | Deletes phone numbers. |
Get a phone numbergetPhoneNumber | GET | Returns information about an account's phone number. |
List phone numberslistPhoneNumbers | GET | Returns a list of phone numbers in an account. |
Unassign a phone numberUnassignPhoneNumber | DELETE | Unassigns Zoom Phone user's phone number. |
Update a phone numberupdatePhoneNumberDetail | PATCH | Updates a phone number's information. |
Update a site's unassigned phone numbersupdateSiteForUnassignedPhoneNumbers | PATCH | Updates a site's unassigned phone numbers. |
Phone Plan2
List calling planslistCallingPlans | GET | Returns all of an account's Zoom Phone calling plans. |
List phone number plan informationListphonenumberplaninformation | GET | Retrieves an account's phone number plan information, phone number usage, and availability. |
Phone Role11
Add members to rolesAddRoleMembersPhone | POST | Use this API to add members to roles. |
Add phone role targetsAddPhoneRoleTargets | POST | Adds targets to phone roles. |
Delete a phone roleDeletePhoneRole | DELETE | Use this API to delete a phone role. |
Delete members in a roleDelRoleMembers | DELETE | Use this API to delete member(s) in a role. |
Delete phone role targetsDeletePhoneRoleTargets | DELETE | Deletes the targets of a phone role. |
Duplicate a phone roleDuplicatePhoneRole | POST | Use this API to duplicate a phone role. |
Get role informationgetRoleInformationPhone | GET | Use this API to get information on a phone role. |
List members in a roleListRoleMembers | GET | Use this API to get members (not) in a role. |
List phone role targetsListPhoneRoleTargets | GET | Targets of a phone role. |
List phone rolesListPhoneRoles | GET | Returns the phone roles. |
Update a phone roleUpdatePhoneRole | PATCH | Use this API to update a role. |
Platform3
Download a file associated with a quote or deal registration.downloadFile | GET | Download a file associated with a quote or deal registration. |
Gets details of all files associated with a quote or dealallFileDetails | GET | |
Upload an attachment pdf file in context of a deal registrationuploadFile | POST |
Playlist7
Add channel playlistsAddChannelPlaylists | POST | Adds playlists to the channel. |
Create a playlistcreatePlaylist | POST | Creates a playlist for managing videos. |
Delete channel playlistsDeleteChannelPlaylists | DELETE | Removes playlists from the channel. |
Delete playlistDeletePlaylist | DELETE | Deletes a playlist. |
List channel playlistsListChannelPlaylists | GET | Retrieves the list of playlists for the channel. |
List playlistsListPlaylists | GET | Retrieves the list of playlists for the user. |
Update playlistUpdatePlaylist | PATCH | Update playlist. |
Poll7
Create a meeting pollmeetingPollCreate | POST | Polls allow the meeting host to survey attendees. |
Delete a meeting pollmeetingPollDelete | DELETE | Polls allow the meeting host to survey attendees. |
Get a meeting pollmeetingPollGet | GET | Retrieves information about a specific meeting poll. |
List meeting pollsmeetingPolls | GET | Polls allow the meeting host to survey attendees. |
List past meeting's poll resultslistPastMeetingPolls | GET | Polls allow the meeting host to survey attendees. |
Perform batch poll creationcreateBatchPolls | POST | Polls allow the meeting host to survey attendees. |
Update a meeting pollmeetingPollUpdate | PUT | Polls allow the meeting host to survey attendees. |
Private Directory4
Add members to a private directoryaddMembersToAPrivateDirectory | POST | Adds members to a private directory. |
List private directory memberslistPrivateDirectoryMembers | GET | Returns the member list of a private directory. |
Remove a member from a private directoryremoveAMemberFromAPrivateDirectory | DELETE | Removes a member from a private directory. |
Update a private directory memberupdateAPrivateDirectoryMember | PATCH | Updates a member of a private directory. |
Product Catalog4
Gets the details for a Zoom product or offer.getOfferDetail | GET | Returns the details for a Zoom product or offer. |
Gets the pricebook in a downloadable filedownloadPricebook | GET | Returns the pricebook in a CSV or Excel format including list price and discounted price based on the partner type. |
Gets Zoom Product Catalog for a Zoom PartnergetOffers | POST | Returns the Zoom product catalog for a Zoom Partner. |
Validate offer compatibility and dependenciesvalidateOffers | POST | Validates offers against dependency rules, quantity constraints, and eligibility criteria. |
Project13
Create a new projectCreateproject | POST | This API endpoint allows you to create a new project for a user, optionally adding collaborators and initializing it with existing whiteboards. |
Create a subprojectcreateSubProject | POST | Creates a new subproject under the specified parent project. |
Delete a projectDeleteproject | DELETE | This API endpoint allows you to delete a specified project. |
Get a projectGetaproject | GET | Retrieves detailed information about a specific project. |
Get collaborators of a projectGetcollaboratorsofaproject | GET | Returns a list of a project collaborators. |
List all projectsListallprojects | GET | Retrieves a list of projects. |
List subprojectslistSubProjects | GET | Retrieves a list of all subprojects under a parent project. |
Move whiteboards to a projectMovewhiteboardstoproject | POST | This API endpoint allows you to move one or more whiteboards to a specified project. |
Remove the collaborator from a projectRemovethecollaboratorfromaproject | DELETE | This API endpoint allows you to remove a specific collaborator from a designated project. |
Remove whiteboards from a projectRemovewhiteboardsfromaproject | DELETE | This API endpoint allows you to remove one or more whiteboards from a specified project. |
Share a project to new usersShareaprojecttonewusers | POST | Add new collaborators to a specified project. |
Update project basic informationUpdateproject | PATCH | This API endpoint allows you to update the basic information of a specific project. |
Update project collaboratorsUpdateprojectcollaborators | PATCH | Updates the role of a collaborator in a project, which allows you to modify the permissions of an existing collaborator in a specific project. |
Prospect Management7
Create ProspectCreateProspect | POST | Create and add a prospect to a call list |
Create Prospects batchCreateProspects | POST | Batch call to add prospects to a call list. |
Delete ProspectDeleteProspect | DELETE | Delete a single prospect from a call list by its ID. |
Get Prospect by IDGetProspectbyID | GET | Retrieve details of a specific prospect. |
List All Prospects in Call ListListAllProspectsInCallList | GET | Retrieve all prospects in a specific call list. |
Update ProspectUpdateProspect | PATCH | Update an existing prospect. |
Update Prospects batchUpdateProspects | PATCH | Batch update existing prospects. |
Provision Template5
Add a provision templateaddProvisionTemplate | POST | Use this API to create a provision template in a Zoom account. |
Delete a provision templatedeleteProvisionTemplate | DELETE | Use this API to delete a provision template in a Zoom account. |
Get a provision templateGetProvisionTemplate | GET | Use this API to get a specific provision template. |
List provision templateslistAccountProvisionTemplate | GET | Use this API to list all provision templates in a Zoom account. |
Update a provision templateupdateProvisionTemplate | PATCH | Use this API to update a provision template in a Zoom account. |
Queue40
Assign a queue menu based interruptassignQueueMenuBasedInterrupt | POST | Create a menu of options to offer to consumers during the queue waiting experience. |
Assign queue agentsassignQueueAgents | POST | Assign users to a Contact Center queue as agent persona. |
Assign queue disposition setsassignQueueDispositionSets | POST | Add disposition sets to a queue. |
Assign queue dispositionsassignQueueDispositions | POST | Add dispositions to a queue. |
Assign queue supervisorsassignQueueSupervisors | POST | Assign users to a Contact Center queue as supervisor persona. |
Assign queue teamsassignQueueTeams | POST | Add teams to a queue. |
Batch create queues with a templateBatchcreatequeueswithatemplate | POST | Create bulk of contact center queues with templateId. |
Batch delete queue templatesdeleteQueueTemplates | DELETE | Delete multiple Contact Center queue templates. |
Batch delete queuesBatchdeletequeues | DELETE | Delete Contact Center queues in bulk. |
Create a queuequeueCreate | POST | Create a queue that determines which agents handle incoming engagements - voice, video, chat, messaging, email, and other channels. |
Create a queue templatecreateQueueTemplate | POST | Create a Contact Center queue template. |
Delete a queuequeueDelete | DELETE | Delete a specified queue. |
Delete a queue templatedeleteQueueTemplate | DELETE | Delete a Contact Center queue template. |
Delete a queue's interrupt menu configurationdeleteQueueInterruptMenu | DELETE | Deletes the interrupt menu configuration for a specific queue. |
Delete an attendee from a scheduled callback eventDeleteascheduledcallbackforanattendee | DELETE | Remove an attendee from an event slot on a scheduled callback. |
Delete queue recordingsdeleteQueueRecordings | DELETE | Delete all recordings in a queue. |
Get a queuegetAQueue | GET | Get information about a queue. |
Get a queue templategetQueueTemplate | GET | Retrieve a Contact Center queue template. |
Get a queue's interrupt settingsgetQueueInterruptSettings | GET | Retrieve the interrupt settings for a specific queue, including audio interrupts and notify interrupts. |
Get a queue's operating hoursgetAQueueOperatingHours | GET | Get information about a queue's operating hours. |
List a queue's scheduled callbacks availabilityListqueuescheduledcallbacksavailability | GET | List scheduled callbacks booking slots for a scheduler set up under a queue. |
List queue agentsgetQueueAgents | GET | Retrieve the list of Contact Center users assigned to a queue, including their agent persona assignments for that queue. |
List queue disposition setsgetQueueDispositionSets | GET | Return a list of queue's disposition sets(https://support.zoom.us/hc/en-us/articles/4470153057549-Managing-dispositions). |
List queue dispositionsgetQueueDispositions | GET | Return a list of queue's dispositions. |
List queue recordingslistQueueRecordings | GET | Return a list of all recordings in a queue. |
List queue supervisorsgetQueueSupervisors | GET | Retrieve the list of a queue's assigned Contact Center users with supervisor persona assignment to the Contact Center queue. |
List queue templatesListqueuetemplates | GET | Retrieve a list of queue templates. |
List queueslistQueues | GET | Get information about all available queues. |
Schedule a callback on a queueScheduleacallbackonaqueue | POST | Schedule a callback on a queue. |
Unassign a queue agentdeleteQueueAgent | DELETE | Remove an agent from a Contact Center queue. |
Unassign a queue dispositiondeleteQueueDisposition | DELETE | Delete a disposition from a queue. |
Unassign a queue disposition setdeleteQueueDispositionSet | DELETE | Delete a disposition set from a queue. |
Unassign a queue supervisordeleteQueueSupervisor | DELETE | Remove a supervisor from a Contact Center queue. |
Unassign a queue teamdeleteQueueTeam | DELETE | Remove a team from a queue. |
Unassign queue teamsbatchDeleteQueueTeams | DELETE | Remove teams from a queue. |
Update a queuequeueUpdate | PATCH | Update a queue's settings. |
Update a queue agent's opt-in/opt-out statusupdateQueueAgent | PATCH | Updates the opt-in or opt-out status of an agent assigned to a Contact Center queue. |
Update a queue templateupdateQueueTemplate | PATCH | Update a Contact Center queue template. |
Update a queue's interrupt settingsupdateQueueInterrupts | PATCH | Update the interrupt settings for a voice queue. |
Update a queue's operating hoursQueueOperatingHoursUpdate | PATCH | Update a queue's operating hours. |
Queue Waiting Experience2
Assign a queue waiting experience interrupt menu strategyassignQueueWaitingExperienceInterruptMenu | PUT | Create or replace the menu of options offered to consumers during the queue waiting experience. |
Delete a queue waiting experience interrupt menu strategydeleteQueueWaitingExperienceInterruptMenuStrategy | DELETE | Remove the interrupt menu configuration from the queue waiting experience. |
Quote6
Create a subscription quote for a Zoom PartnercreateQuote | POST | Create a subscription quote for a Zoom partner's end customers. |
Get quote details by quote reference IDgetQuoteDetails | GET | Get quote details by quote reference ID. |
Gets all quotes for a Zoom partnergetAllQuotes | GET | Returns all quotes for a Zoom partner based on specified filters. |
Preview delta quote metrics and subscriptions in a quotecreateQuotePreview | POST | Previews the delta quote metrics and subscriptions in a quote. |
Submits a subscription quote for provisioningprovisionQuote | PATCH | Submits a subscription quote for provisioning. |
Update a subscription quote for a Zoom PartnerupdateQuote | PATCH | Update a subscription quote for a Zoom partner's end customers. |
Recording12
Delete a call recordingdeleteCallRecording | DELETE | Deletes a call recording. |
Delete a recordingdeleteRecording | DELETE | Delete a selected recording. |
Delete engagement recordingsdeleteEngagementRecordings | DELETE | Delete all recordings in a given engagement. |
Download a phone recordingphoneDownloadRecordingFile | GET | Downloads the phone recording. |
Download a phone recording transcriptphoneDownloadRecordingTranscript | GET | Downloads the phone recording transcript. |
Get a recording by call element IDgetPhoneRecordingByCallElementId | GET | Returns an account's call recording by the call element's callElementId. |
Get call recordingsgetPhoneRecordings | GET | Returns an account's call recordings. |
Get user's recordingsphoneUserRecordings | GET | Gets a user's Zoom Phone recordings. |
List engagement recordingslistEngagementRecordings | GET | Return a list of all of an engagement's recordings. |
List recordingslistRecordings | GET | Return a list of available recordings. |
Update auto delete fieldUpdateAutoDeleteField | PATCH | Updates the auto delete field for recording. |
Update Recording StatusUpdateRecordingStatus | PUT | Updates the status of a single recording in account. |
Region7
Assign users to a regionAssignUsersToARegion | POST | Assign users to a region. |
Create a regionCreateARegion | POST | Create a new region. |
Delete a regionDeleteARegion | DELETE | Delete a site and move its members to another region. |
Get a regionGetARegion | GET | Get information about a region. |
List a region's usersListRegion_sUsers | GET | Retrieve the list of a region's assigned Contact Center users. |
List regionsListRegions | GET | Get information about all available regions. |
Update a regionUpdateARegion | PATCH | Update information for a region. |
Registrant2
List registrantsgetRegistrants | GET | Retrieves event registrants. |
List session attendeesgetSessionAttendeeList | GET | Retrieves session attendees. |
Report45
Get a meeting activities reportreportMeetingactivitylogs | GET | Retrieve a list of a meeting activity logs. |
Get active or inactive host reportsreportUsers | GET | Retrieve a host report for a specified period of time within the last six months. |
Get billing invoice reportsgetBillingInvoicesReports | GET | Get department billing invoices reports for a specific billing period. |
Get billing reportsgetBillingReport | GET | Get department billing reports of a Zoom account. |
Get call charges usage reportGetCallChargesUsageReport | GET | Retrieves the Phone Call Charges Report. |
Get chat message reportsreportChatMessages | GET | Returns Zoom Chat message reports for a specified period of time. |
Get chat sessions reportsreportChatSessions | GET | Returns Zoom Chat session reports for a specified period of time. |
Get chat transcripts reportChatTranscriptsReport | GET | Retrieves the chat transcripts report for an event. |
Get cloud recording usage reportreportCloudRecording | GET | Retrieve cloud recording usage report for a specified period. |
Get custom reportgetCustomEventReport | GET | Retrieves data for the custom report for the given report ID. |
Get daily usage reportreportDaily | GET | Retrieve daily report to access the account-wide usage of Zoom services for each day in a given month. |
Get disclaimer reportGetdisclaimerreport | GET | Retrieve a list of disclaimer records. |
Get event attendance (Live or Lobby) reportEventAttendanceReport | GET | Retrieves the event attendance (live or lobby) report for the event. |
Get event registrations reportEventRegistrationsReport | GET | Retrieves event ticket registrations. |
Get event survey reportEventSurveyReportApi | GET | Retrieve event and session survey information. |
Get fax charges usage reportGetfaxchargesusagereport | GET | Retrieves the Phone Fax Charges Report. |
Get history meeting and webinar listGethistorymeetingandwebinarlist | GET | Retrieve a list of history meetings and webinars. |
Get meeting detail reportsreportMeetingDetails | GET | Get a detailed report for a past meeting. |
Get meeting participant reportsreportMeetingParticipants | GET | Return a report of a past meeting with two or more participants, including the host. |
Get meeting poll reportsreportMeetingPolls | GET | Use this API to get a report of poll results for a past meeting. |
Get meeting Q&A reportreportMeetingQA | GET | Retrieve a report on questions asked and answered by participants from past meetings. |
Get meeting reportsreportMeetings | GET | Retrieve report on past meetings and webinars for a specified time period. |
Get meeting survey reportreportMeetingSurvey | GET | Retrieve a report on past meeting survey. |
Get operation logs reportgetPSOperationLogs | GET | Retrieves the phone system operation logs report. |
Get operation logs reportreportOperationLogs | GET | The Operations Logs report allows you to audit admin and user activity, such as adding a new user, changing account settings, and deleting recordings. |
Get remote support reportGetremotesupportreport | GET | Retrieve a list of remote support records. |
Get session attendance reportSessionAttendanceReport | GET | Retrieves a session attendance report. |
Get sign In / sign out activity reportreportSignInSignOutActivities | GET | Retrieve a list of sign in / sign out activity logs report of users under a Zoom account. |
Get SMS/MMS charges usage reportGetSMSChargesUsageReport | GET | Retrieves the SMS/MMS Charges Report . |
Get telephone reportsreportTelephone | GET | 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. |
Get upcoming events reportreportUpcomingEvents | GET | Use this API to list upcoming meeting and/or webinar events within a specified period of time. |
Get VOD channel registration reportVodChannelReigistration | GET | Retrieves VOD channel registrations and view duration information. |
Get webinar detail reportsreportWebinarDetails | GET | Retrieve a report containing past webinar details. |
Get webinar participant reportsreportWebinarParticipants | GET | Get a detailed report on each webinar attendee. |
Get webinar poll reportsreportWebinarPolls | GET | Retrieve a report on past webinar polls. |
Get webinar Q&A reportreportWebinarQA | GET | Retrieve a report on questions asked by participants and answered by panelists, co-hosts and hosts from past webinars. |
Get webinar survey reportreportWebinarSurvey | GET | Retrieve a report on past webinar survey. |
Get ZVA engagementsGetZVAEngagements | GET | Generates a list of ZVA engagements. |
Get ZVA query detailsGetZVAQueryDetails | GET | Returns a list of ZVA engagement query details. |
Get ZVA SurveysGetZVASurveys | GET | Returns a list of ZVA engagement surveys. |
Get ZVA transcriptsGetZVATranscripts | GET | Generates a list of ZVA transcripts. |
Get ZVA variable detailsGetZVAengagementvariabledetails | GET | Get a list of ZVA engagement variable details. |
List agents' adherence datalistAdherenceAgents | GET | Get agents' adherence data. |
List AI Management operation logsListAIManagementOperationLogs | GET | List AI Management operation logs. |
List all schedule agentslistScheduleAgents | GET | List all the schedule agents for the particular date and timezone |
Reports V1 (Legacy)7
List agent leg reportslistAgentLegMetric | GET | Generate a list of agent's leg reports. |
List agent's status history reportslistAgentStatusHistory | GET | Generate a list of an agent's status history reports. |
List agent's time sheet reportslistAgentTimeSheet | GET | Generate a list of an agent's time sheet reports. |
List historical agent reports by queuelistQueueAgentsMetrics | GET | Generate detailed historical reports of agents from a specific queue. |
List historical detail reportslistHistoricalDetailMetric | GET | Retrieve historical engagement details. |
List historical queue reportslistHistoricalQueueMetric | GET | Generate a list of historical queue reports. |
List historical queue's agents reportslistQueueAgentMetric | GET | Generate a list of a historical queue's agent reports. |
Reports V2 (CX Analytics)15
Get historical custom report tabular schemagetHistoricalCustomReportTabularSchema | GET | Generate the schema information for a tabular based on the custom report after enabling API in the CX Analytics. |
List historical agent performance dataset dataListhistoricalagentperformancedatasetdata | GET | Generate a list of agent performance dataset raw data. |
List historical agent timecard dataset dataListhistoricalagenttimecarddatasetdata | GET | Generate a list of agent timecard dataset raw data. |
List historical custom report tabular dataListhistoricalcustomreporttabulardata | GET | Generate a list of tabular data based on the custom report after enabling the API in the CX Analytics. |
List historical disposition dataset dataListhistoricaldispositiondatasetdata | GET | View the historical disposition data for finished engagements in the Contact Center to conduct disposal data analysis, such as displaying the disposition data through dashboards or reports. |
List historical engagement dataset dataListengagementdatasetdata | GET | Generate a list of engagement dataset raw data. |
List historical engagement log dataListhistoricalengagementlogs | GET | Retrieve a list of all historical engagement log data. |
List historical engagement timelineslistHistoricalEngagementTimelines | GET | Retrieve engagement timelines, including entities and segments, for engagements in a time range. |
List historical expert assist dataset dataListexpertassistdatasetdata | GET | Display expert assist dataset key metrics on the adoption of AI expert assist and its impact on key engagement measures. |
List historical flow performance dataset dataListhistoricalflowperformancedatasetdata | GET | Generate a list of flow performance dataset raw data. |
List historical outbound dialer performance dataset dataListhistoricaloutbounddialerperformancedatasetdata | GET | Generate a list of outbound dialer performance dataset raw data. |
List historical queue performance dataset dataListhistoricalqueueperformancedatasetdata | GET | Generate a list of queue performance dataset raw data. |
List historical routing log performance dataset dataListhistoricalroutinglogperformancedatasetdata | GET | Generate a list of routing log performance dataset raw data. |
List historical Zoom Phone to Contact Center call journey dataListhistoricalZoomphonetozcccalljourneydata | GET | View the complete customer journey of a call across both Contact Center and Zoom Phone. |
List operation logslistOperationLogs | GET | Retrieve the Zoom Contact Center management system operation logs. |
Role18
Assign a roleAddRoleMembers | POST | User roles can have a set of permissions that allows access only to the pages a user needs to view or edit. |
Assign a roleassignRoleUsers | POST | Use this API to assign users to a role. |
Create a rolecreateRole | POST | Each Zoom user automatically has a role which can either be owner, administrator, or member. |
Create a rolecreateRoleContactCenter | POST | Create a new role. |
Delete a roledeleteRole | DELETE | Each Zoom user automatically has a role which can either be owner, administrator, or a member. |
Delete a roledeleteRoleContactCenter | DELETE | Delete a role. |
Delete role privilegesDeleteroleprivileges | DELETE | Removes the specified privileges from a role when given a valid role ID and privilege list. |
Duplicate a roleDuplicatearole | POST | Duplicate the role specified by the original role name and assign it a new name. |
Get a rolegetRole | GET | Get information about a role. |
Get role informationgetRoleInformation | GET | Each Zoom user automatically has a role which can either be owner, administrator, or member. |
List members in a roleroleMembers | GET | User roles can have a set of permissions that allows access only to the pages a user needs to view or edit. |
List roleslistRoles | GET | Use this API to return a list of roles. |
List rolesroles | GET | List roles on your account |
List users of a rolegetRoleUsers | GET | Retrieve a list of users assigned to a Contact Center role. |
Unassign a roleroleMemberDelete | DELETE | User roles can have a set of permissions that allows access only to the pages a user needs to view or edit. |
Unassign a user from a roledeleteRoleUser | DELETE | Remove a specific user from a Contact Center role. |
Update a roleupdateRoleContactCenter | PATCH | Update a role. |
Update role informationupdateRole | PATCH | Each Zoom user automatically has a role which can either be owner, administrator, or a member. |
Room App1
Config Zoom Room Controller AppsConfigZoomRoomControllerApps | POST | Use this API to configure Zoom Room Controller installed Zoom Apps. |
Room Template5
Create a Room TemplateCreateaRoomTemplate | POST | Creates a Managed Cisco/Poly Room. |
Delete a room templateDeletearoomtemplate | DELETE | Deletes a Managed Cisco/Poly Room Template. |
Get a Room TemplateGetaRoomTemplate | GET | Returns the details of a Cisco/Polycom room template. |
List Room TemplatesListRoomTemplates | GET | Returns the Managed Cisco/Polycom rooms Templates. |
Update a Room TemplateUpdateaRoomTemplate | PATCH | Updates the settings of a Cisco/Polycom Room Template. |
Routing Form2
get routing responseGetroutingresponse | GET | Returns the response submitted for a routing form. |
list account routing responselist_account_routing_response | GET | Returns a list of routing responses across all routing forms under the account. |
Routing Profile10
Create a consumer routing profileCreateaconsumerroutingprofile | POST | Create a consumer routing profile. |
Create an agent routing profileCreateanagentroutingprofile | POST | Create an agent routing profile. |
Delete a consumer routing profileDeleteaconsumerroutingprofile | DELETE | Delete a consumer routing profile. |
Delete an agent routing profileDeleteanagentroutingprofile | DELETE | Delete an agent routing profile. |
Get a consumer routing profileGetaconsumerroutingprofile | GET | Retrieve the consumer routing profile. |
Get an agent routing profilegetAgentRoutingProfile | GET | Retrieve the agent routing profile. |
List agent routing profilesListagentroutingprofiles | GET | Returns a list of agent routing profiles. |
List consumer routing profilesListconsumerroutingprofiles | GET | Return a list of consumer routing profiles. |
Update a consumer routing profile's detailsUpdateaconsumerroutingprofile_sdetails | PATCH | Update a consumer routing profile details. |
Update an agent routing profile's detailsUpdateanagentroutingprofile_sdetails | PATCH | Update an agent routing profile details. |
Routing Rule5
Add directory backup routing ruleaddRoutingRule | POST | Creates a directory backup routing rule. |
Delete directory backup routing ruledeleteRoutingRule | DELETE | Deletes the directory backup routing rule. |
Get directory backup routing rulegetRoutingRule | GET | Returns the directory backup routing rule. |
List directory backup routing ruleslistRoutingRule | GET | Returns a list of directory backup routing rules. |
Update directory backup routing ruleupdateRoutingRule | PATCH | Updates the directory backup routing rule. |
RTMS1
Update engagement Real-Time Media Streams (RTMS) app statusengagementRTMSStatusUpdate | PUT | Update the RTMS status for a specific engagement. |
Schedule7
Delete schedulesdelete_schedules | DELETE | Deletes a schedule. |
Get schedulesget_schedule | GET | Returns a schedule. |
Insert schedulesinsert_schedule | POST | Creates a schedule. |
List all schedule agentslistSchedules | GET | List the schedule agents for the particular date and timezone. |
List schedule available timeslist_available_time | GET | Returns available time slots for a given schedule, including day-level and spot-level availability, custom fields, recurrence rules, and scheduling segments. |
List scheduleslist_schedules | GET | Returns a list of all schedules. |
Patch schedulespatch_schedule | PATCH | Patches a schedule. |
Scheduled Event6
Create a booking for a schedule slotcreate_booking | POST | Books a time slot on an existing schedule in Zoom Scheduler. |
Delete scheduled eventsdelete_scheduled_events | DELETE | Deletes a scheduled event. |
Get scheduled event attendeeget_scheduled_event_attendee | GET | Returns information about a specified attendee (person invited to an event). |
Get scheduled eventsget_scheduled_events | GET | Returns a scheduled event. |
List scheduled eventslist_scheduled_events | GET | Returns a list of all scheduled events. |
Patch scheduled eventspatch_scheduled_events | PATCH | Patches a scheduled event. |
ScheduleMeeting1
List scheduled meetingsListallscheduledmeetings | GET | List all scheduled meetings for a user. |
Scheduling Group1
List scheduling groupsListschedulinggroups | GET | Get all the scheduling group name and id |
Scheduling Link1
Single use linksingle_use_link | POST | Creates a single-use scheduling link. |
Scribe8
Cancel Batch JobcancelBatchJob | DELETE | Cancels a batch transcription job. |
Get Batch Job StatusgetBatchJobStatus | GET | Retrieves job-level summary for a batch transcription job. |
Get Batch Scribe Job FilegetBatchScribeJobFile | GET | Retrieves the processing result for a specific file within a batch Scribe transcription job. |
List Batch Job FileslistBatchJobFiles | GET | Retrieves per-file processing status for a batch transcription job. |
List Batch JobslistBatchJobs | GET | Retrieves a paginated list of batch transcription jobs for the authenticated tenant. |
Live Scribe WebSocketliveTranscribe | GET | Opens a WebSocket session for real-time transcription. |
Scribe (Synchronous)createFastAsr | POST | Uploads a single audio file and receive transcript inline. |
Submit Batch Scribe JobsubmitBatchAsr | POST | Submits a batch transcription job for asynchronous processing. |
Search1
Search filesSearch | POST | Search for files accessible to the current user by query and filters (file types, ancestor ids, created by, owner id). |
Session40
Add session reservationsAddSessionReservations | POST | Reserve a spot for a user in the given session. |
Create a sessionCreateasession | POST | Create a Video SDK session. |
Create a sessioncreateEventSession | POST | Creates a session. |
Create a stream ingestionCreateastreamingestion | POST | Create a stream ingestion. |
Create or update session interpretersupdateSessionInterpreters | PUT | Creates or updates the list of interpreters for the session. |
Create or update session pollsupdateSessionPolls | PUT | Create or update the list of polls for the session. |
Delete a sessiondeleteEventSession | DELETE | Deletes a session. |
Delete a sessionsessionDelete | DELETE | Delete a session. |
Delete a stream ingestionDeleteastreamingestion | DELETE | Delete a stream ingestion. |
Delete session reservationsDeleteSessionReservations | DELETE | This tool removes a user's reservation spot for a given session. |
Get a session SIP URI with passcodeGetASessionSIPURIWithPasscode | POST | Get a live video SDK session's SIP URI. |
Get a stream ingestionGetastreamingestion | GET | Get information about a stream ingestion. |
Get session detailsGetasession | GET | Get a information about live or past Cobrowse sessions.: Prerequisites: Cobrowse SDK. |
Get session detailssessionDetail | GET | Get information about scheduled, live, or past sessions. |
Get session live stream detailsgetLiveStreamDetailsVideoSdk | GET | Use this API to return a session's live stream configuration details, such as the stream's URL, key, and page URL. |
Get session livestream configurationgetSessionLivestreamConfiguration | GET | List the livestream configuration for the given session. |
Get session user QoSsessionUserQOS | GET | Retrieve the quality of service (QoS) for users from live or past sessions. |
Get sharing/recording detailssessionParticipantShare | GET | Retrieve the sharing and recording details of participants from live or past sessions. |
Get the session informationgetEventSessionInfo | GET | Returns the session information. |
Get ticket session join token by Event ID and Session IDgetSessionJoinToken | GET | Retrieves the join token to join an event session. |
List live sessionsListlivesessions | GET | List the total live sessions that occurred during a specified period of time. |
List past sessionsListpastsession | GET | List the total live or past sessions that occurred during a specified period of time. |
List session interpretersgetSessionInterpreterList | GET | Retrieves interpreters in a session. |
List session pollsgetSessionPolls | GET | List all the polls of a session. |
List session reservationsListSessionReservations | GET | Retrieves the list of reservations made by registrants for the session. |
List session streaming ingestionsListsessionstreamingingestions | GET | List all streaming ingestions of a live session. |
List session usersListsessionusers | GET | List the users from live or past sessions. |
List session userssessionUsers | GET | Use this API to return a list of users from live or past sessions. |
List session users QoSsessionUsersQOS | GET | Return a list of session users from live or past sessions along with the quality of service (QoS) they received during the session. |
List sessionsgetEventSessionList | GET | Retrieves the sessions in an event. |
List sessionssessions | GET | List the total live or past sessions that occurred during a specified period of time. |
List stream ingestionsListstreamingestions | GET | List all the stream ingestions on your Zoom account. |
Update a sessionupdateEventSession | PATCH | Updates an existing session in an event. |
Update a session live streamsessionLiveStreamUpdate | PATCH | Use this API to update a session's live stream information. |
Update a stream ingestionUpdateastreamingestion | PATCH | Update a stream ingestion. |
Update Realtime Media Streams (RTMS) app statusupdateSessionRtmsAppStatus | PATCH | Update the status of the Realtime Media Streams (RTMS) app in an ongoing session. |
Update session livestream configurationUpdateSessionLivestreamConfiguration | PATCH | Update the livestream configuration for the given session. |
Update session livestream statussessionLiveStreamStatusUpdate | PATCH | Update a session's livestream status. |
Update session statussessionStatus | PUT | Use this API to update a session's status. |
Use in-session events controlsinSessionEventsControl | PATCH | Control in-session events such as the recording controls to start a recording, stop a recording, pause a recording, and resume a recording, and invitation control to invite users. |
Setting14
Get account policy detailsGetAccountPolicyDetails | GET | Returns the account policy details. |
Get mailbox vacation response settingget_mail_vacation_response_setting | GET | Gets vacation respondes settings. |
Get phone account settingsphoneSetting | GET | Returns an account's settings. |
Get ported numbers detailsGetportednumbersdetails | GET | Returns the details on the ported numbers by specifying order id. |
Get the specified user calendar settings of the authenticatedGetsetting | GET | Returns a single setting. |
List all user calendar settings of the authenticated userListsettings | GET | Returns all user settings for the authenticated user. |
List BYOC SIP trunksListBYOCSIPtrunks | GET | Returns a list of an account's assigned BYOC (Bring Your Own Carrier) SIP (Session Initiation Protocol) trunks. |
List ported numbersListportednumbers | GET | Returns a list of ported numbers in a Zoom account. |
List SIP groupsListSIPgroups | GET | Returns a list of SIP (Session Initiation Protocol) groups. |
Patch the specified user calendar settings of the authenticatedPatchsetting | PATCH | Patches a single setting. |
Update account policyupdateAccountPolicy | PATCH | Updates the account's Zoom Phone policy. |
Update mailbox vacation response settingupdate_mailbox_vacation_response_setting | PUT | Updates vacation responder settings. |
Update phone account settingsupdatePhoneSettings | PATCH | Updates Zoom Phone account settings. |
Update whiteboard share settingUpdateAWhiteboardShareSetting | PATCH | Updates the whiteboard share setting. |
Setting Template4
Add a setting templateaddSettingTemplate | POST | Creates a Zoom Phone setting template for an account. |
Get setting template detailsgetSettingTemplate | GET | Returns information about an account's phone template. |
List setting templateslistSettingTemplates | GET | Gets a list of all the created phone template settings. |
Update a setting templateupdateSettingTemplate | PATCH | Updates or modifies a phone template's settings. |
Settings Delegate4
Get the specified delegate on the mailboxget_mailbox_delegate | GET | Retrieves the specified delegate. |
Grant a new delegate access on the mailboxgrant_mailbox_delegate | POST | Creates a delegate on the mailbox. |
List delegates on the mailboxlist_mailbox_delegates | GET | Lists the delegates on the mailbox. |
Revoke an existing delegate access from the mailboxrevoke_mailbox_delegate | DELETE | Removes the specified delegate. |
Settings Filter4
Create an email filtercreate_email_filter | POST | Creates a message filter. |
Delete the specified email filterdelete_email_filter | DELETE | Immediately and permanently deletes the specified filter. |
Get the specified email filterget_email_filter | GET | Retrieves the specified filter. |
List email filterslist_email_filters | GET | Lists the message filters of a mailbox. |
Share1
Create sharescreate_shares | POST | Creates an endpoint for our Customize Once and Share feature. |
Shared Line Appearance1
List shared line appearanceslistSharedLineAppearances | GET | Returns a list of shared line appearance instances. |
Shared Line Group22
Add a policy setting to a shared line groupaddSLGPolicySubSetting | POST | Adds the policy sub-setting for a specific shared line group according to the policyType. |
Add members to a shared line groupaddMembersToSharedLineGroup | POST | Adds members to a shared line group. |
Add shared line group settingaddSharedLineGroupSetting | POST | Adds the shared line group setting according to the setting type. |
Assign phone numbersassignPhoneNumbersSLG | POST | Assigns phone numbers to a shared line groups. |
Create a shared line groupcreateASharedLineGroup | POST | Creates a shared line group. |
Delete a shared line groupdeleteASharedLineGroup | DELETE | Deletes a shared line group. |
Delete an SLG policy settingremoveSLGPolicySubSetting | DELETE | Removes the policy sub-setting for a specific shared line group according to the policyType. |
Delete shared line group settingdeleteSharedLineGroupSetting | DELETE | Deletes the shared line group setting according to the setting type. |
Get a shared line groupgetASharedLineGroup | GET | Returns a list of all the shared line groups. |
Get a shared line group policygetSharedLineGroupPolicy | GET | Returns the policy setting of a specific shared line group. |
Get shared line group call handling settinggetSharedLineGroupCallHandlingSetting | GET | Returns the call handling setting of a shared line group for the specified hour type. |
Get shared line group settingsgetSharedLineGroupSettings | GET | Returns shared line group settings. |
List shared line groupslistSharedLineGroups | GET | Lists all the shared line groups. |
Unassign a member from a shared line groupdeleteAMemberSLG | DELETE | Unassigns a specific member from a shared line group. |
Unassign a phone numberdeleteAPhoneNumberSLG | DELETE | Unassigns a specific phone number that was assigned to the shared line group. |
Unassign all phone numbersdeletePhoneNumbersSLG | DELETE | Unassigns all the phone numbers that have been assigned to the shared line group. |
Unassign members from a shared line groupdeleteMembersOfSLG | DELETE | Unassigns all existing members from a shared line group. |
Update a shared line groupupdateASharedLineGroup | PATCH | Updates the information about a shared line group. |
Update a shared line group policyupdateSharedLineGroupPolicy | PATCH | Updates the policy setting of a specific shared line group. |
Update an SLG policy settingupdateSLGPolicySubSetting | PATCH | Updates the policy sub-setting for a specific shared line group according to the policyType. |
Update shared line group call handling settingupdateSharedLineGroupCallHandlingSetting | PATCH | Update the call handling setting of a shared line group for the specified hour type. |
Update shared line group settingupdateSharedLineGroupSetting | PATCH | Update the shared line group setting according to the setting type. |
Shared Space13
Add members to a shared spaceaddSpaceMembers | POST | Adds members to a shared space. |
Create a shared spacecreateSpace | POST | Creates a shared space. |
Delete a shared spacedeleteSpace | DELETE | Deletes a shared space. |
Demote shared space administrators to membersdemoteSpaceAdmins | DELETE | Demotes shared space administrators to members. |
Get a shared spacegetASharedSpace | GET | Returns information about a shared space. |
List shared space channelslistSharedSpaceChannels | GET | Returns a list of channels for a shared space. |
List shared space memberslistSharedSpaceMembers | GET | Returns a list of members in a shared space. |
List shared spaceslistSharedSpaces | GET | Returns a list shared spaces. |
Move shared space channelsupdateSharedSpaceChannels | PATCH | Moves one or more channels in or out of a shared space. |
Promote shared space members to administratorspromoteSpaceMembers | POST | Promotes shared space members to administrators. |
Remove members from a shared spacedeleteSpaceMembers | DELETE | Removes members from a shared space. |
Transfer shared space ownershiptransferSpaceOwner | PATCH | Transfers shared space ownership to a member or administrator. |
Update shared space settingsupdateSharedSpaceSettings | PATCH | Updates a shared space's settings. |
Single7
Create Clip ChapterscreateClipChapters | POST | Create or replace all chapters for a clip. |
Delete a clip(soft delete)DeleteClip | DELETE | Deletes a clip. |
Duplicate ClipsDuplicateClips | POST | Duplicate a clip. |
Get a clipGetClipById | GET | Returns a clip from the current user, or returns any clips associated with the account. |
Get Clip ChaptersGetClipChapters | GET | Get the complete chapter list and chapter generation status for a clip. |
Update a clip's basic infoUpdateClipById | PATCH | Updates clips basic info by clip's Id, now support update title/description/tags |
Update clips share settingUpdateclipssharesetting | PATCH | Update the clip's share settings. |
SIP Phone4
Delete SIP phonedeleteSIPPhonePhones | DELETE | Delete a Zoom account's SIP phone. |
Enable SIP phoneEnableSIPPhonePhones | POST | Enable a user to use a SIP phone. |
List SIP phonesListSIPPhonePhones | GET | List SIP phones on an account. |
Update SIP phoneUpdateSIPPhonePhones | PATCH | Update the information of a specific SIP phone on a Zoom account. |
Site12
Add a site settingaddSiteSetting | POST | Sites allow you to organize Zoom Phone users in your organization. |
Add customized outbound caller ID phone numbersaddSiteOutboundCallerNumbers | POST | Use this API to add the site-level customized outbound caller ID phone numbers. |
Create a phone sitecreatePhoneSite | POST | Creates a site that allows you to organize the Zoom Phone users in your organization. |
Delete a phone sitedeletePhoneSite | DELETE | Use this API to delete a specific site in a Zoom account. |
Delete a site settingdeleteSiteSetting | DELETE | Sites allow you to organize Zoom Phone users in your organization. |
Get a phone site settinggetSiteSettingForType | GET | Gets the site setting about a specific site according to the setting type. |
Get phone site detailsgetASite | GET | Returns information on a specific site. |
List customized outbound caller ID phone numberslistSiteCustomizeOutboundCallerNumbers | GET | Use this API to retrieve phone numbers that can be used as the site-level customized outbound caller ID. |
List phone siteslistPhoneSites | GET | Sites allow you to organize Zoom Phone users in your organization. |
Remove customized outbound caller ID phone numbersdeleteSiteOutboundCallerNumbers | DELETE | Use this API to remove the site-level customized outbound caller ID phone numbers. |
Update phone site detailsupdateSiteDetails | PATCH | Updates information about a specific site. |
Update the site settingupdateSiteSetting | PATCH | Allows you to organize Zoom Phone users in your organization. |
Skill11
Create a skillskillCreate | POST | Create a skill for skill-based routing. |
Create a skill categorySkillCategoryCreate | POST | Create a new skill category. |
Delete a skillskillDelete | DELETE | Delete a skill. |
Delete a skill categorySkillCategoryDelete | DELETE | Delete an existing skill category. |
Get a skillgetSkill | GET | Return a skill's information and its usage. |
Get a skill categorygetSkillCategory | GET | Return information about a specific skill category. |
List skill categorieslistSkillCategory | GET | List all available skill categories and their information. |
List skill userslistSkillUsers | GET | Retrieve a list of users assigned to a skill. |
List skillslistSkills | GET | Return a list of a skills or a skill category's assigned skills. |
Update a skillskillNameUpdate | PATCH | Use this API to update a skill's name. |
Update a skill categorySkillCategoryUpdate | PATCH | Update a skill category. |
SMS8
Get account's SMS sessionsaccountSmsSession | GET | Returns details about SMS sessions for an account. |
Get SMS by message IDsmsByMessageId | GET | Returns details about a specific message in an SMS session. |
Get SMS session detailssmsSessionDetails | GET | Returns details about an SMS session. |
Get user's SMS sessionsuserSmsSession | GET | Returns details about SMS sessions for a user. |
List user's SMS sessions in descending orderGetSmsSessions | GET | Retrieves the user's SMS sessions in descending order. |
Post SMS messagepostSmsMessage | POST | Sends SMS messages to Zoom Phone accounts. |
Send an SMScontactCenterSMS | POST | Send an SMS message. |
Sync SMS by session IDsmsSessionSync | GET | Syncs SMS messages in a session. |
SMS Campaign7
Assign a phone number to SMS campaignassignCampaignPhoneNumbers | POST | Assigns a phone number to the SMS campaign. |
Get an SMS campaignGetSMSCampaign | GET | Returns a specific SMS campaign. |
List opt statuses of phone numbers assigned to SMS campaigngetNumberCampaignOptStatus | GET | Returns the opt statuses of phone numbers that are assigned to SMS the campaign. |
List SMS campaignslistAccountSMSCampaigns | GET | Returns a list of all SMS campaigns in a Zoom account. |
List user's opt statuses of phone numbersgetUserNumberCampaignOptStatus | GET | Returns the opt statuses of a user’s phone numbers. |
Unassign phone number from SMS campaignunassignCampaignPhoneNumber | DELETE | Unassigns a phone number from an SMS campaign. |
Update opt statuses of phone numbers assigned to SMS campaignupdateNumberCampaignOptStatus | PATCH | Updates opt statuses of phone numbers that are assigned to the SMS campaign. |
SMS Consent9
Assign phone numbers to SMS consent policyAssignPhoneNumbersToConsent | POST | Assigns one or more phone numbers to an SMS consent policy. |
Create an SMS consent policyCreateSMSConsent | POST | Creates a new SMS consent management policy to define opt-in, opt-out, and help message configurations for SMS communications. |
Delete SMS consent policiesDeleteSMSConsents | DELETE | Deletes one or more SMS consent policies. |
Get an SMS consent policyGetSMSConsent | GET | Returns a specific SMS consent policy by ID. |
List opt statuses of phone numbers assigned to SMS consentgetNumberConsentOptStatus | GET | Returns the opt statuses of phone numbers that are assigned to SMS consent. |
List phone numbers assigned to SMS consent policyListConsentPhoneNumbers | GET | Returns a paginated list of phone numbers assigned to a specific SMS consent policy. |
List SMS consent policiesListSMSConsents | GET | Returns a paginated list of SMS consent policies for the account. |
Unassign phone numbers from SMS consent policyUnassignPhoneNumbersFromConsent | DELETE | Unassigns one or more phone numbers from an SMS consent policy. |
Update an SMS consent policyUpdateSMSConsent | PATCH | Updates an existing SMS consent policy. |
Speaker5
Create a speakercreateSpeaker | POST | Creates a speaker for an event. |
Delete a speakerdeleteSpeaker | DELETE | Deletes a speaker. |
Get a speakergetSpeaker | GET | Returns information on a specific speaker. |
List speakersgetSpeakers | GET | Retrieves a list of speakers for an event. |
Update a speakerupdateSpeaker | PATCH | Updates the speaker information. |
Subscription5
Get trial details for an end customer by their Zoom accountgetTrialDetails | GET | Returns the trial details for an end customer. |
Get trial subscriptions for a Zoom partnergetAllTrialSubscriptions | GET | Returns trial subscriptions for a distributor or reseller. |
Gets paid subscriptions for a Zoom partner.getAllSubscriptions | GET | Returns paid subscriptions for a distributor or a reseller. |
Gets subscription changes/versions for a given subscriptiongetSubscriptionVersions | GET | Returns the subscription changes or versions for a given subscription number. |
Gets subscription details for a given subscription numbergetSubscriptionDetails | GET | Returns the subscription details for a given subscription number. |
Summarizer7
Cancel Batch Summarizer JobcancelBatchSummarizerJob | DELETE | Cancel a batch summarization job. |
Get Batch Summarizer JobgetBatchSummarizerJob | GET | Retrieves job-level status, configuration, and progress summary for a batch summarization job. |
Get Batch Summarizer Job FilegetBatchSummarizerJobFile | GET | Retrieves the processing result for a specific file within a batch summarization job. |
List Batch Summarizer Job FileslistBatchSummarizerJobFiles | GET | Retrieves a paginated list of individual file results for a batch summarization job. |
List Batch Summarizer JobslistBatchSummarizerJobs | GET | Retrieves a paginated list of batch summarization jobs for the authenticated tenant. |
Submit Batch Summarizer JobsubmitBatchSummarizer | POST | Submits a batch summarization job for asynchronous processing. |
Summarize (Synchronous)summarize | POST | Submit transcript text and receive a summary inline. |
Summary3
Delete a meeting or webinar summaryDeletemeetingorwebinarsummary | DELETE | Delete the summary of a meeting or webinar. |
Get a meeting or webinar summaryGetameetingsummary | GET | Retrieve the summary of a meeting or webinar. |
List an account's meeting or webinar summariesListmeetingsummaries | GET | Retrieve a list of all meeting or webinar summaries available for an account. |
Survey3
Delete a meeting surveymeetingSurveyDelete | DELETE | Delete a meeting survey. |
Get a meeting surveymeetingSurveyGet | GET | Display information about a meeting survey. |
Update a meeting surveymeetingSurveyUpdate | PATCH | Update a meeting survey. |
Survey Management5
Get survey answersgetSurveyAnswers | GET | Queries the answers of survey from surveyId. |
Get survey infogetSurveyInfo | GET | Queries the latest version of survey information from surveyId. |
Get survey instancesgetSurveyInstancesInfo | GET | Query the instances which used the survey, based on surveyId. |
Get surveysgetAccountSurveys | GET | Queries all surveys in the current account. |
List channel survey instancesGetsurveyinstances | GET | Query the channel survey instances based on channelId. |
Task5
Create a new taskcreateTask | POST | Provide essential details to create a new task without file attachments. |
Delete a taskdeleteTask | DELETE | Permanently delete a task and all its associated data including descriptions, attachments, collaborators, and integrations. |
Get task detailsgetTaskDetail | GET | Retrieves detailed information about a specific task by it’s ID |
List tasksgetMyTasks | GET | Retrieves tasks assigned to, or created by, the current user with advanced filtering, sorting, and pagination options. |
Update task fieldsupdateTask | PATCH | Updates specific fields of an existing task. |
Team32
Assign team agentsassignTeamAgents | POST | Assign agents to a team. |
Assign Team ManagersAssignTeamManagers | POST | Add team managers. |
Assign Team MembersAssignTeamMembers | POST | Add one or more users to a team. |
Assign team supervisorsassignTeamSupervisors | POST | Assign supervisors to a team. |
Create a teamCreateTeamContactCenter | POST | Create a new team. |
Create TeamCreateTeamIq | POST | Please create team one by one, if your account enable hierarchical structure team. |
Delete a teamdeleteTeam | DELETE | Delete a specified team. |
Delete TeamDeleteTeam | DELETE | Please delete team one by one, if your account enable hierarchical structure team. |
Get a teamgetTeamDetail | GET | Get information about a team. |
Get Team DetailGetTeamDetail | GET | Get team detail, such as team name, team description, team member size and etc. |
Grant additional access to current teamAddSharedFromTeams | POST | Grants the current team access to view conversation recordings hosted and attended by members of the specified source teams. |
Grant additional access to target teamsAddSharedToTeams | POST | The current team grants additional access to the target teams. |
List a team's child teamsgetTeamChildTeams | GET | Get a list of a team's child teams. |
List Account TeamsListTeams | GET | List account teams. |
List teamListteam | GET | Lists teams for the specified user, or for the current user. |
List team agentslistTeamAgents | GET | Retrieve a list of a team's assigned agents. |
List Team ManagersListTeamManagers | GET | List Team Managers |
List Team MembersListTeamMembers | GET | List team members by page |
List team supervisorslistTeamSupervisors | GET | Lists the supervisors assigned to a specific team. |
List team's parent teamsgetTeamParentTeams | GET | Get a list of a team's parent teams. |
List teamslistTeams | GET | Retrieve a list of all teams with details, including supervisors and agents. |
List Unassigned Team UsersListUnassignedTeamUsers | GET | List unassigned team zra users by page |
Move a teammoveTeam | PATCH | Move a team's level. |
Move team to new parentMoveTeam | PATCH | Move current team under a new parent team. |
Remove additional access from current teamDeleteSharedFromTeams | DELETE | The target teams stop granting additional access to the current team. |
Remove additional access from target teamsDeleteSharedToTeams | DELETE | The current team stops granting additional access to the target teams. |
Unassign team agentsunassignTeamAgents | DELETE | Unassign agents from a team. |
Unassign Team ManagersUnassignTeamManagers | DELETE | Delete team managers. |
Unassign Team MembersUnassignTeamMembers | DELETE | Delete members of the team. |
Unassign team supervisorsunassignTeamSupervisors | DELETE | Unassign supervisors from a team. |
Update a teamUpdateateam | PATCH | Update a team's details. |
Update Team nameUpdateTeam | PATCH | Update the team name. |
Template2
Create a meeting template from an existing meetingmeetingTemplateCreate | POST | Create a meeting template from an existing meeting. |
List meeting templateslistMeetingTemplates | GET | List available meeting templates for a user. |
Thread6
Delete an existing email threaddelete_email_thread | DELETE | Immediately and permanently deletes the specified thread. |
Get the specified email threadget_email_thread | GET | Retrieves the specified thread. |
List email threads from the mailboxlist_email_threads | GET | Lists the threads in the mailbox. |
Move the specified thread out of TRASH folderuntrash_email_thread | POST | Moves the specified thread out of the trash folder. |
Move the specified thread to TRASH foldertrash_email_thread | POST | Moves the specified thread to the trash. |
Update the specified threadupdate_email_thread | POST | Modifies the labels applied to the thread. |
Ticket5
Create ticketscreateTickets | POST | Creates tickets for an event. |
Delete a ticketdeleteTicket | DELETE | Deletes a ticket. |
Get a ticketgetTicketDetails | GET | Retrieves information on a specific ticket. |
List ticketsgetTickets | GET | Retrieves the ticket information of an event. |
Update ticketUpdateticket | PATCH | Updates ticket questions for the given ticket ID and event ID. |
Ticket Type8
Create an event ticket typecreateTicketType | POST | Creates a ticket type for the event ID that is not allowed for single session and recurring event types. |
Delete a ticket typedeleteEventTicketType | DELETE | Deletes a ticket type of an event that is not allowed for a single session event type. |
List registration questions for an eventgetRegistrationQuestionsForEvent | GET | List registration questions and fields that are to be answered by users while registering for an event. |
List registration questions for ticket typegetRegistrationQuestionsForTicketType | GET | List registration questions and fields that are to be answered by users while registering for an event. |
List ticket typesgetEventTicketTypes | GET | Lists all ticket types associated with an event. |
Update registration questions for an eventupdateRegistrationQuestionsForEvent | PUT | Updates registration questions and fields that are to be answered by users while registering for an event. |
Update registration questions for ticket typeupdateRegistrationQuestionsForTicketType | PUT | Updates registration questions and fields that are to be answered by users while registering for an event. |
Update ticket type for an eventupdateTicketType | PATCH | Updates the ticket type for an event ID not allowed for a single session event type. |
Tracking Field5
Create a tracking fieldtrackingfieldCreate | POST | Use this API to create a new tracking field. |
Delete a tracking fieldtrackingfieldDelete | DELETE | Delete a tracking field. |
Get a tracking fieldtrackingfieldGet | GET | Use this API to return information about a tracking field. |
List tracking fieldstrackingfieldList | GET | List all the tracking fields on your Zoom account. |
Update a tracking fieldtrackingfieldUpdate | PATCH | Update a tracking field. |
Transfer2
Transfer clips ownerTransferclipsowner | POST | Transfers clip ownership to another user. |
Transfer task status checkTransfertaskstatuscheck | GET | Transfers the task status check. |
Translator7
Cancel Batch Translator JobcancelBatchTranslatorJob | DELETE | Cancels a batch translation job. |
Get Batch Translator JobgetBatchTranslatorJob | GET | Retrieves job-level status, configuration, and progress summary for a batch translation job. |
Get Batch Translator Job FilegetBatchTranslatorJobFile | GET | Retrieves the processing result for a specific file within a batch translation job. |
List Batch Translator Job FileslistBatchTranslatorJobFiles | GET | Retrieves a paginated list of individual file results for a batch translation job. |
List Batch Translator JobslistBatchTranslatorJobs | GET | Retrieves a paginated list of batch translation jobs for the authenticated tenant. |
Submit Batch Translator JobsubmitBatchTranslator | POST | Submits a batch translation job for asynchronous processing. |
Translate (Synchronous)translate | POST | Submit text and receive translations inline. |
TSP8
Add a user's TSP accountuserTSPCreate | POST | Add a user's TSP account. |
Delete a user's TSP accountuserTSPDelete | DELETE | Delete a user's TSP account. |
Get a user's TSP accountuserTSP | GET | Retrieve details of a specific TSP account enabled for a specific user. |
Get account's TSP informationtsp | GET | Get information on Telephony Service Provider (TSP) on an account level. |
List user's TSP accountsuserTSPs | GET | List all of a user's TSP accounts. |
Set global dial-in URL for a TSP usertspUrlUpdate | PATCH | Set the URL for a global dial-in page of a user whose Zoom account has TSP and special TSP with third-party audio conferencing options enabled. |
Update a TSP accountuserTSPUpdate | PATCH | Update a user's Telephony Service Provider (TSP) account. |
Update an account's TSP informationtspUpdate | PATCH | Update information of the Telephony Service Provider (TSP) set up on an account. |
Upload4
Initiate and complete the multipart file upload for a clipInitiateAndCompleteAClipMultipartUpload | POST | Initiates or completes a multipart upload. |
Temporary file upload API for ClipsTemporaryfileuploadAPIforClips | POST | Uploads temporary files for Clips. |
Upload clip fileUploadClipFile | POST | Uploads a video file to create a Zoom Clip. |
Upload clip multipart filesUploadIqMultipartClipFile | POST | Uploads a multipart file to create a Zoom Clip. |
User89
Add a user's profile settingaddUserProfileSetting | POST | Adds the user setting according to the setting type. |
Add a user's shared access settingaddUserSetting | POST | Adds the user setting according to the setting type, specifically for delegation, intercom and shared access for voicemail, and call recordings. |
Add assistantsuserAssistantCreate | POST | Assign assistants to a user. |
Add phone numbers for users' customized outbound caller IDaddUserOutboundCallerNumbers | POST | Adds users' customized outbound caller ID phone numbers. |
Add user call forward settingaddUserCallForwardSetting | POST | Adds Zoom Phone call forwarding numbers for a user under a specific hour type. |
Assign a user's skillsassignSkills | POST | Assign skills to a user. |
Assign calling plan to a userassignCallingPlan | POST | Assigns a calling plan to a Zoom Phone user. |
Batch add usersbatchAddUsers | POST | Adds phone users in batch. |
Batch create user profilesBatchCreateUsers | POST | Batch create Contact Center users. |
Batch delete user profilesbatchDeleteUsers | DELETE | Batch delete Contact Center users. |
Batch update user profilesBatchUpdateUsers | PATCH | Batch update Contact Center users. |
Batch update user statusBatchupdateuserstatus | PATCH | Batch update Contact Center users' statuses. |
Bulk update features for usersbulkUpdateFeature | POST | Update multiple features for a user. |
Check a user emailuserEmail | GET | Verify if a user's email is registered with Zoom. |
Check a user's PM roomuserVanityName | GET | A personal meeting room is a virtual meeting room that can be permanently assigned to a user. |
Create a useruserScim2Create | POST | Creates a new user. |
Create a user templatecreateAUserTemplate | POST | Create a user template. |
Create a user's profilecreateUser | POST | Create a Contact Center user. |
Create usersuserCreate | POST | Add a new user to your Zoom account. |
Deactivate a useruserADSCIM2Deactivate | PATCH | Activate or deactivate a user. |
Delete a scheduleruserSchedulerDelete | DELETE | Delete a scheduler. |
Delete a useruserDelete | DELETE | Disassociate (unlink) a user or permanently delete a user. |
Delete a useruserSCIM2Delete | DELETE | Delete a user. |
Delete a user assistantuserAssistantDelete | DELETE | Delete a specific assistant of a user. |
Delete a user templatedeleteAUserTemplate | DELETE | Delete a user template. |
Delete a user's profileuserDeleteContactCenter | DELETE | Delete a Contact Center user. |
Delete a user's profile pictureuserPictureDelete | DELETE | Delete a user's profile picture. |
Delete a user's profile profile settingdeleteUserProfileSetting | DELETE | Deletes a user setting based on the setting type. |
Delete a user's recordingsdeleteUserRecordings | DELETE | Delete all of a user's Contact Center recordings. |
Delete a user's shared access settingdeleteUserSetting | DELETE | Removes the user setting according to the setting type, specifically for delegation, intercom and shared access for voicemail and call recordings. |
Delete user assistantsuserAssistantsDelete | DELETE | Delete all of the current user's assistants. |
Delete user call forward settingdeleteUserCallForwardSetting | DELETE | Delete Zoom Phone call forwarding numbers for a user under a specific hour type. |
Delete user schedulersuserSchedulersDelete | DELETE | Delete all of a user's schedulers. |
Delete Virtual Background filesdelUserVB | DELETE | Use this API to delete a user's Virtual Background files. |
Get a useruser | GET | View a user's information on a Zoom account. |
Get a useruserSCIM2Get | GET | Returns information about a specific user. |
Get a user presence statusgetUserPresenceStatus | GET | Returns a user's current status. |
Get a user templateGetanusertemplate | GET | Get a user template. |
Get a user's profilegetUser | GET | Retrieve a Contact Center user. |
Get a user's profilephoneUser | GET | Returns a user's Zoom phone profile. |
Get a user's profile settingsphoneUserSettings | GET | Returns the Zoom Phone profile settings of a user. |
Get a user's tokenuserToken | GET | Gets a user's Zoom token or Zoom Access Key (ZAK). |
Get collaboration device detailgetCollaborationDevice | GET | Get collaboration device detail. |
Get meeting summary templatesGetmeetingsummarytemplates | GET | List meeting summary templates. |
Get meeting template detailgetUserMeetingTemplates | GET | Retrieve a user's meeting template. |
Get the user's ZAKuserZak | GET | Get the Zoom Access Key (ZAK) for the authenticated user associated with the access token in the API request. |
Get userget_user | GET | Returns information about the user. |
Get user call handling settinggetUserCallHandlingSetting | GET | Returns the call handling setting of a user for the specified hour type. |
Get user permissionsuserPermission | GET | Get permissions that have been granted to the user. |
Get user policy detailsGetUserPolicyDetails | GET | Returns the user policy details. |
Get user settingsuserSettings | GET | Retrieve a user's settings. |
Get user summaryuserSummary | GET | Gets a summary of users, including the number and types of users in the account. |
List a user's collaboration deviceslistCollaborationDevices | GET | List a user's collaboration devices. |
List a user's queueslistUserQueues | GET | List the Contact Center queues that a user is assigned to. |
List a user's recordingslistUserRecordings | GET | List a user's Contact Center recordings. |
List a user's skillsListAUserSkills | GET | Get a list of skills assigned to a given user. |
List phone userslistPhoneUsers | GET | Returns a list of all of an account's users who are assigned a Zoom Phone license. |
List user assistantsuserAssistants | GET | List a user's assistants. |
List user profilesusersContactCenter | GET | Returns a list of Contact Center users. |
List user schedulersuserSchedulers | GET | List all of a user's schedulers. |
List user templatesListUserTemplates | GET | Return the user template list |
List usersListallusers | GET | Get all the users in the account. |
List usersuserSCIM2List | GET | Lists all users. |
List usersusers | GET | Retrieve a list of your account's users. |
List users' phone numbers for a customized outbound caller IDlistUserCustomizeOutboundCallerNumbers | GET | Retrieves phone numbers that can be the user-level customized outbound caller ID. |
Opt-in or opt-out a user's queuesBatchOptInOrOutUserQueues | PATCH | Change a Contact Center user's opt-in or opt-out status for queues assigned to the user. |
Remove users' customized outbound caller ID phone numbersdeleteUserOutboundCallerNumbers | DELETE | Removes the users' customized outbound caller ID phone numbers. |
Revoke a user's SSO tokenuserSSOTokenDelete | DELETE | Revokes a user's SSO token. |
Unassign a user's skilldeleteASkill | DELETE | Remove a skill from a Contact Center user. |
Unassign user's calling planunassignCallingPlan | DELETE | Unassigns a Zoom Phone user's calling plan. |
Update a useruserSCIM2Update | PUT | Updates a user's information. |
Update a useruserUpdate | PATCH | Updates a user's Zoom profile information. |
Update a user templateupdateAUserTemplate | PATCH | Update a user template. |
Update a user's emailuserEmailUpdate | PUT | Change a user's email address on a Zoom account that has managed domain set up. |
Update a user's passworduserPassword | PUT | Update the password of a user using which the user can login to Zoom. |
Update a user's presence statusupdatePresenceStatus | PUT | Update a user's presence status. |
Update a user's profileupdateUser | PATCH | Update a Contact Center user. |
Update a user's profileupdateUserProfile | PATCH | Updates a user's Zoom Phone profile. |
Update a user's profile settingsupdateUserSettings | PATCH | Updates the Zoom Phone profile settings of a user. |
Update a user's shared access settingupdateUserSetting | PATCH | Updates the user setting according to the setting type, specifically for delegation, intercom and shared access for voicemail and call recordings. |
Update a user's statusUpdateauser_sstatus | PATCH | Update a user's status. |
Update multiple users' properties in batchupdateUsersPropertiesInBatch | PUT | Updates multiple users' properties in batch. |
Update user call handling settingupdateUserCallHandlingSetting | PATCH | Updates a user's call handling settings for the specified hour type. |
Update user policyupdateUserPolicy | PATCH | Updates a user's Zoom Phone policy. |
Update user settingsuserSettingsUpdate | PATCH | Update a user's settings. |
Update user statususerStatus | PUT | Deactivate an active user or to reactivate a deactivated user. |
Update user's calling planupdateCallingPlan | PUT | Switches the calling plans of a Zoom Phone user. |
Upload a user's profile pictureuserPicture | POST | Upload a user's profile picture. |
Upload Virtual Background filesuploadVBuser | POST | Use this API to upload a Virtual Background files to a user's profile. |
Variable13
Create a variablecreateVariable | POST | Create a new variable. |
Create a variable groupcreateVariableGroup | POST | Create a custom variable group. |
Delete a variablevariableDelete | DELETE | Delete a variable. |
Delete a variable groupDeleteGroup | DELETE | Delete a specified variable group. |
Delete a variable logdeleteVariableLog | DELETE | Delete a variable log. |
Get a variablevariableGet | GET | Retrieve a variable. |
Get a variable groupgetAVariableGroup | GET | Get information about a variable group. |
Get a variable loggetVariableLog | GET | Get information about a variable log. |
List variable groupslistVariableGroups | GET | Return a list of variable groups. |
List variable logslistVariableLogs | GET | Return a list of variable logs. |
List variablesvariables | GET | Returns a list of variables for a specific variable group. |
Update a variablevariableUpdate | PATCH | Update a variable. |
Update a variable groupupdateVariableGroup | PATCH | Update a variable group. |
Video11
Add channel videosAddChannelVideos | POST | Adds videos to the channel. |
Add playlist videosAddPlaylistVideos | POST | Adds videos to a playlist. |
Delete channel videosDeleteChannelVideos | DELETE | Removes videos from the channel. |
Delete playlist videosDeletePlaylistVideos | DELETE | Deletes videos from a playlist. |
Get metadata for a specific videogetVideoMetadataEvents | GET | Retrieves metadata for a specific video, including title, description, duration, creation time, last updated time, and associated tags. |
Get metadata for a specific videogetVideoMetadataVideoManagement | GET | Retrieves metadata such as the name, description, and notes for a specific video. |
List all videosListAllVideos | GET | Retrieves the list of videos or recordings added by the user. |
List channel videosListChannelVideos | GET | Gets a list of the channel's videos. |
List playlist videosListPlaylistVideos | GET | Gets the playlist's list of videos. |
Update metadata for a specific videoupdateVideoMetadataEvents | PATCH | Updates video metadata. |
Update metadata for a specific video.updateVideoMetadataVideoManagement | PATCH | Updates video metadata. |
Video On Demand9
Add VOD channel videosAddVODChannelVideos | POST | Adds videos to the VOD channel. |
Create VOD channelcreateVodChannel | POST | Creates a channel for managing hub videos. |
Delete VOD ChannelDeleteVODChannel | DELETE | Deletes a video channel. |
Delete VOD channel videoDeleteVODChannelVideo | DELETE | Removes video from the VOD channel. |
Get VOD channel detailsgetVODChannelDetail | GET | Returns VOD channel details. |
List channelsgetVODChannels | GET | Retrieves the channel information for a hub. |
List VOD channel videosListVODChannelVideos | GET | Lists VOD channel videos. |
Update VOD channelUpdateVideoChannelEvents | PATCH | Updates a hub video channel. |
VOD channel actionsvodChannelActions | POST | Returns VOD channel action result. |
Video On Demand Registration4
Get VOD Registration QuestionsgetRegistrationQuestionsForVODChannel | GET | List registration questions and fields that are to be answered by users while registering for a vod channel. |
List VOD RegistrationListVODRegistration | GET | Retrieves the VOD registration information of a channel. |
update VOD channel registration questionsupdateRegistrationQuestionsForVODchannel | PUT | Updates registration questions and fields that are to be answered by users while registering for a VOD channel. |
VOD channel registrationVODTicketRegistration | POST | Creates registrations for a VOD channel. |
Video SDK Report5
Get cloud recording usage reportvsdkReportCloudRecording | GET | Retrieve cloud recording usage report for a specified period. |
Get daily usage reportvsdkReportDaily | GET | Get daily report of the account-wide usage of Zoom services for each day in a given month. |
Get operation logs reportvsdkReportOperationLogs | GET | Get operation logs report for a specified period of time. |
Get telephone reportvsdkReportTelephone | GET | Get the telephone report for a specified period of time. |
Get webhook logsgetWebhookLogsVideoSdk | GET | Get the webhook call logs for the Video SDK app created by the current account. |
Video SDK Session1
List session users QoS SummarysessionUsersQOSSummary | GET | Use this API to return a list of users from past sessions and a summary of their quality of service received during the session. |
Visitor Management6
Check in a visitorcheckinVisitor | POST | Check in an invitation. |
Delete an InvitationdeleteInvitation | DELETE | Visitor management is a software system used to manage the lifecycle of visitors. |
Get a list of visitors by locationinvitationList | GET | List the invitations under a Zoom user account. |
Invitation details by invitationIDgetInvitation | GET | Visitor management is a software system used to manage the lifecycle of visitors. |
Send an invitationcreateInvitation | POST | Send a invitation to a visitor. |
Update an invitationupdateInvitation | PATCH | Update a invitation. |
Voicemail7
Delete a voicemaildeleteVoicemail | DELETE | Deletes an account's voicemail message. |
Download a phone voicemailphoneDownloadVoicemailFile | GET | Downloads the Zoom phone voicemail. |
Get a voicemail by call element IDgetVoicemailDetailsByCallElementId | GET | Returns the detailed information on a voicemail by the call element's callElementId. |
Get account voicemailsaccountVoiceMails | GET | Gets a user's Zoom Phone voicemails. |
Get user's voicemailsphoneUserVoiceMails | GET | Returns a user's Zoom Phone voicemails. |
Get voicemail detailsgetVoicemailDetails | GET | Returns the information about a voicemail message. |
Update Voicemail Read StatusupdateVoicemailReadStatus | PATCH | Updates the status of voicemail message. |
Webinar53
Add a webinar registrantwebinarRegistrantCreate | POST | Create and submit a user's registration for a webinar. |
Add panelistswebinarPanelistCreate | POST | Panelists in a webinar can view and send video, screen share, annotate, and do much more compared to attendees in a webinar. |
Create a webinarwebinarCreate | POST | Schedule a webinar for a user who is a webinar host. |
Create a webinar templatewebinarTemplateCreate | POST | Create a webinar template from an existing webinar. |
Create a webinar's branding name tagcreateWebinarBrandingNameTag | POST | Create a webinar's session branding name tag. |
Create a webinar's pollwebinarPollCreate | POST | Creates a poll for a webinar. |
Create webinar's invite linkswebinarInviteLinksCreate | POST | Create a batch of invitation links for a webinar. |
Delete a live webinar messagedeleteWebinarChatMessageById | DELETE | Deletes a message in a live webinar based on ID. |
Delete a webinarwebinarDelete | DELETE | Delete a webinar. |
Delete a webinar pollwebinarPollDelete | DELETE | Delete a webinar's poll. |
Delete a webinar registrantdeleteWebinarRegistrant | DELETE | Delete a webinar registrant. |
Delete a webinar surveywebinarSurveyDelete | DELETE | Delete a webinar survey. |
Delete a webinar's branding name tagdeleteWebinarBrandingNameTag | DELETE | Delete a webinar's session branding name tag. |
Delete a webinar's branding virtual backgroundsdeleteWebinarBrandingVB | DELETE | Delete a webinar's session branding virtual background. |
Delete a webinar's branding wallpaperdeleteWebinarBrandingWallpaper | DELETE | Delete a webinar's session branding wallpaper file. |
Get a webinarwebinar | GET | Get details for a scheduled Zoom webinar. |
Get a webinar pollwebinarPollGet | GET | Returns a webinar's poll details. |
Get a webinar registrantwebinarRegistrantGet | GET | Zoom users with a webinar plan have access to creating and managing webinars. |
Get a webinar SIP URI with passcodegetWebinarSipDialingWithPasscode | POST | Get a webinar's SIP URI. |
Get a webinar surveywebinarSurveyGet | GET | Return information about a webinar survey. |
Get a webinar's archive token for local archivingwebinarLocalArchivingArchiveToken | GET | Use this API to get a webinar's archive token to allow local archiving. |
Get a webinar's join token for live streamingwebinarLiveStreamingJoinToken | GET | Retrieve a webinar's archive token to allow live streaming. |
Get a webinar's join token for local recordingwebinarLocalRecordingJoinToken | GET | Retrieve a webinar's join token to allow for local recording. |
Get live stream detailsgetWebinarLiveStreamDetails | GET | Get a webinar's live stream configuration details, such as Stream URL, Stream Key and Page URL. |
Get webinar absenteeswebinarAbsentees | GET | List absentees of a webinar. |
Get webinar tracking sourcesgetTrackingSources | GET | Webinar Registration Tracking Sources allow you to see where your registrants are coming from if you share the webinar registration page in multiple platforms. |
Get webinar's session brandinggetWebinarBranding | GET | Get the webinar's session branding information. |
Get webinar's tokenwebinarToken | GET | Use this API to get a webinar's closed caption token (caption URL). |
List a webinar's pollswebinarPolls | GET | Lists all the polls of a webinar. |
List panelistswebinarPanelists | GET | List all of a webinar's panelists. |
List past webinar instancespastWebinars | GET | List past webinar instances. |
List past webinar poll resultslistPastWebinarPollResults | GET | The polling feature for webinar lets you create single-choice or multiple-choice polling questions for your webinars. |
List Q&As of a past webinarlistPastWebinarQA | GET | List the Q&A of a specific past webinar. |
List registration questionswebinarRegistrantsQuestionsGet | GET | List registration questions and fields that are to be answered by users while registering for a webinar. |
List webinar participantslistWebinarParticipants | GET | Retrieve a list of all the participants who attended a webinar hosted in the past. |
List webinar registrantswebinarRegistrants | GET | List all users that have registered for a given webinar. |
List webinar templateslistWebinarTemplates | GET | Display a list of a user's webinar templates. |
List webinarswebinars | GET | List all the webinars scheduled by or on behalf a webinar host. |
Perform batch registrationaddBatchWebinarRegistrants | POST | Register up to 30 registrants at once for a scheduled webinar that requires registration. |
Remove a panelistwebinarPanelistDelete | DELETE | Remove a single panelist from a webinar. |
Remove all panelistswebinarPanelistsDelete | DELETE | Remove all the panelists from a webinar. |
Set webinar's default branding virtual backgroundsetWebinarBrandingVB | PATCH | Set a webinar's default session branding virtual background. |
Update a live streamwebinarLiveStreamUpdate | PATCH | Update a webinar's live stream information. |
Update a webinarwebinarUpdate | PATCH | Make updates to a scheduled webinar. |
Update a webinar pollwebinarPollUpdate | PUT | Updates a webinar's poll. |
Update a webinar surveywebinarSurveyUpdate | PATCH | Update a webinar survey. |
Update a webinar's branding name tagupdateWebinarBrandingNameTag | PATCH | Update a webinar's session branding name tag. |
Update live stream statuswebinarLiveStreamStatusUpdate | PATCH | Lets users live stream a webinar to a custom platform. |
Update registrant's statuswebinarRegistrantStatus | PUT | Update webinar registrants' registration status. |
Update registration questionswebinarRegistrantQuestionUpdate | PATCH | Update registration questions and fields of a scheduled webinar for users to answer during webinar registration. |
Update webinar statuswebinarStatus | PUT | Update a webinar's status. |
Upload a webinar's branding virtual backgrounduploadWebinarBrandingVB | POST | Upload a webinar's session branding virtual background. |
Upload a webinar's branding wallpaperuploadWebinarBrandingWallpaper | POST | Upload a webinar's session branding wallpaper file. |
Workspace39
Add a workspace photoAddaWorkspacephoto | POST | Use this API to add a workspace photo. |
Add or Update a Workspace floor mapAddOrUpdateAWorkspaceFloorMap | POST | Use this API to Add or Update a Workspace floor map. |
Check in/out of a reservationreservationEvent | POST | Use this API to check in to or out of a reservation. |
Create a reservationcreateReservation | POST | Creates a workspace reservation. |
Create a workspacecreateWorkspace | POST | Creates workspaces. |
Create a workspace assetAddaWorkspaceasset | POST | Create a new workspace asset. |
Delete a desk assignmentDeleteadeskassignment | DELETE | Deletes a desk assignment. |
Delete a reservationdeleteReservation | DELETE | Deletes a reservation. |
Delete a workspacedeleteWorkspace | DELETE | Deletes workspace detail. |
Delete a workspace assetDeleteaWorkspaceasset | DELETE | Delete a workspace asset by asset ID. |
Delete neighborhoodsDeleteNeighborhoods | DELETE | Delete one or more neighborhoods from a floor. |
Delete Workspace floor mapDeleteWorkspaceFloorMap | DELETE | Use this API to delete a workspace floor map. |
Delete workspace photosDeleteaWorkspacephoto | DELETE | Deletes workspace photos. |
Edit a workspace assetPatchWorkspaceasset | PATCH | Edit the workspace's asset based on asset ID. |
Get a desk assignmentGetadeskassignment | GET | Get a desk assignment. |
Get a floor's reservationsGetafloor_sreservations | GET | Retrieves a floor's reservations. |
Get a location's hot desk usagegetHotDeskUsage | GET | Creates a location's hot desk usage information. |
Get a neighborhoodGetNeighborhood | GET | Get a neighborhood by ID. |
Get a user's workspace's reservationsuserListReservations | GET | Retrieves a user's workspace's reservations. |
Get a workspacegetWorkspace | GET | Creates workspace detail. |
Get a workspace assetget_workspace_asset | GET | Create a workspace asset based on the asset ID. |
Get a workspace location floor mapGetlocationfloormap | GET | Get a location's floor map. |
Get a workspace QR codegetWorkspaceQRCode | GET | Use this API to get the workspace QR code. |
Get a workspace reservation by reservationIdGETGetaworkspacereservationbyreservationID | GET | Retrieves a workspace reservation ID. |
Get a workspace's reservationslistReservations | GET | Retrieves a workspace's reservations. |
Get all workspace assetsGetallworkspaceassets | GET | List all workspace assets. |
Get questionnaire answer summaryGetworkspacequestionnaireresponses | GET | Retrieves a summary of questionnaire answers for specified locations within a date range. |
Get Workspace Calendar Free/Busy EventGetWorkspaceCalendarFree_BusyEvent | GET | List workspace calendar free or busy event settings. |
List neighborhoodsListNeighborhoods | GET | List a floor's neighborhoods with optional neighborhood, workspace, user, or group filters. |
List released workspaces by timeoutgetWorksapceReservationReleaseInof | GET | Lists workspaces that were released due to missing check-in or checkout information. |
List workspace additional information with time rangeGetaworkspaceadditionalenhancements | GET | List a location's workspaces' additional information within a specified time range. |
List workspace reservation questionnairesListworkspacereservationquestionnaires | GET | List workspace reservation questionnaires. |
List workspace reservations by locationsGetworkspacereservationsinlocations | GET | List workspace reservations by location. |
List workspaceslistWorkspaces | GET | List a location's workspaces. |
Set a desk assignmentsetADeskAssignment | PUT | Set a desk assignment. |
Set Workspace Calendar Free/Busy EventSetCalendarFree_BusyEvent | POST | Set calendar free or busy event. |
Update a reservationupdateReservation | PATCH | Updates a reservation. |
Update a workspaceupdateWorkspace | PATCH | Updates workspace detail. |
Update workspace settingsupdateWorkspaceSettings | PATCH | Updates workspace settings. |
Zoom Room30
Add a Zoom RoomaddARoom | POST | Use this API to add a Zoom Room to a Zoom account. |
Add a Zoom Room to a Zoom PhoneaddZoomRoom | POST | Associates a Zoom Room with a Zoom Phone license. |
Assign calling plans to a Zoom RoomassignCallingPlanToRoom | POST | Assigns calling plans to a Zoom Room with a maximum of 200 numbers at a time. |
Assign phone numbers to a Zoom RoomassignPhoneNumberToZoomRoom | POST | Assigns phone numbers to a Zoom Room. |
Change a Zoom Room's locationchangeZRLocation | PUT | An account owner of a Zoom account can establish a Zoom Rooms Location Hierarchy to better organize Zoom Rooms spread across various locations. |
Create a device profilecreateRoomDeviceProfile | POST | Creates a Zoom Room device profile. |
Delete a device profiledeleteRoomProfile | DELETE | Deletes a Zoom Room device profile. |
Delete a Zoom RoomdeleteAZoomRoom | DELETE | Remove a specific Zoom Room profile from a Zoom account. |
Get a device profilegetRoomProfile | GET | Returns a Zoom Room device profile. |
Get a Zoom Room under Zoom Phone licensegetZoomRoom | GET | Specifies Zoom Room in an account with an assigned Zoom Phone license. |
Get device informationgetRoomDevices | GET | Returns information about a Zoom Room device. |
Get Zoom Room profilegetZRProfile | GET | Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing. |
Get Zoom Room sensor datagetZRSensorData | GET | Retrieves the sensor data from the specified Zoom Room. |
Get Zoom Room settingsgetZRSettings | GET | Get information on meeting, alert, digital signage or scheduling display settings applied to a specific Zoom Room. |
Get Zoom Rooms virtual controller URLgetWebzrcUrl | GET | Get the Zoom Rooms virtual controller URL. |
List device profilesgetRoomProfiles | GET | Returns a list of Zoom Room device profiles. |
List digital signage contentslistDigitalSignageContent | GET | Use this API to return information about a Zoom account's Zoom Rooms digital signage content. |
List Zoom Room deviceslistZRDevices | GET | List information about the devices that are being used for a specific Zoom Room in an account. |
List Zoom RoomslistZoomRooms | GET | Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing. |
List Zoom Rooms under Zoom Phone licenselistZoomRoomsPhone | GET | Retrieves a list of Zoom Rooms under the account that has the Zoom Phone license assigned. |
List Zoom Rooms without Zoom Phone assignmentlistUnassignedZoomRooms | GET | Returns Zoom Rooms that are not assigned a Zoom Phone. |
Remove a calling plan from a Zoom RoomunassignCallingPlanFromRoom | DELETE | Use this API to unassign a calling plan from a Zoom Room. |
Remove a phone number from a Zoom RoomUnassignPhoneNumberFromZoomRoom | DELETE | Use this API to unassign a phone number from a Zoom Room. |
Remove a Zoom Room from a ZP accountRemoveZoomRoom | DELETE | Use this API to remove Zoom Room from a Zoom Phone account. |
Update a device profileupdateDeviceProfile | PATCH | Updates a Zoom Room device profile. |
Update a Zoom Room profileupdateRoomProfile | PATCH | Update basic information on a specific Zoom Room in a Zoom account. |
Update a Zoom Room under Zoom Phone licenseupdateZoomRoom | PATCH | Use this API to update a Zoom Room in an account that has the Zoom Phone license assigned. |
Update E911 digital signagemanageE911signage | PATCH | Display or hide E911 emergency alert text content from Zoom Rooms digital signage. |
Update Zoom Room settingsupdateZRSettings | PATCH | Update meeting, alert, digital signage or scheduling display settings applied to a specific Zoom Room. |
Use Zoom Room controlscheckInRooms | PATCH | Controls Zoom Rooms, including: Room check-in and check-out. |
Zoom Rooms Account4
Get Zoom Room account profilegetZRAccountProfile | GET | Get details on the account profile of a Zoom Room. |
Get Zoom Room account settingsgetZRAccountSettings | GET | Get details on Account Settings of a Zoom Room. |
Update Zoom Room account profileupdateZRAccProfile | PATCH | Update information on the account profile of a Zoom Room. |
Update Zoom Room account settingsupdateZoomRoomAccSettings | PATCH | Update account settings applied for Zoom Rooms in a Zoom account. |
Zoom Rooms Calendar7
Add a calendar resource to a calendar serviceaddACalendarResourceToCalendarService | POST | Use this API to add a calendar resource to a Microsoft Exchange or Office 365 calendar service in a Zoom Room account. |
Delete a calendar resourcedeleteACalendarResource | DELETE | Deletes a Zoom Room account's calendar resource from a Microsoft Exchange or Office 365 calendar service. |
Delete a calendar servicedeleteACalendarService | DELETE | Deletes a Zoom Room account's calendar service. |
Get a calendar resource by IDgetCalendarResourceById | GET | List Zoom Room account's calendar resource. |
List calendar resources by calendar servicegetCalendarResourcesByServiceId | GET | List all of a Zoom Room account's calendar resources. |
List calendar servicesgetCalendarServices | GET | List all the existing calendar services in a Zoom Room account. |
Start calendar service sync processsyncACalendarService | PUT | Use this API to kick off the sync process for Zoom Room account's calendar service. |
Zoom Rooms Content31
Add a digital signage content folderAddadigitalsignagecontentfolder | POST | Use this API to add a Digital Signage Content folder. |
Add a digital signage image or videoAdddigitalsignageimageorvideo | POST | Upload an image or video to the Zoom Rooms Digital Signage Content Library. |
Add a Digital Signage library playlistAddaDigitalSignagelibraryplaylist | POST | Use this API to add a content library Digital Signage Playlist. |
Add a digital signage URLAddadigitalsignageURL | POST | Use this API to add a URL to the Zoom Rooms digital signage content library. |
Add Zoom Rooms background image library contentAddZoomRoomsBackgroundImageLibraryContent | POST | Upload an image to Zoom Room Content Library. |
Add Zoom Rooms Background Image Library FolderAddZoomRoomsBackgroundLibraryFolder | POST | Use this API to add a Zoom Rooms background image library content folder. |
Delete a Digital Signage content folderDeleteadigitalsignagecontentfolder | DELETE | Use this API to delete an individual digital signage content folder. |
Delete a Digital Signage content itemDeleteadigitalsignagecontentitem | DELETE | Use this API to delete an individual digital signage content item. |
Delete Digital Signage library playlistDeleteDigitalSignagelibraryplaylist | DELETE | Delete digital signage library playlist. |
Delete Zoom Rooms Background Image Library ContentDeleteZoomRoomsBackgroundImageLibraryContent | DELETE | Deletes a Zoom Rooms background image library content item. |
Delete Zoom Rooms Background Image Library FolderDeleteZoomRoomsBackgroundLibraryFolder | DELETE | Deletes a Zoom Rooms background image library content folder. |
Get Digital Signage content folderGetdigitalsignagecontentfolderdetails | GET | Use this API to get the details of an individual digital signage content folder. |
Get Digital Signage content itemGetdigitalsignagecontentitem | GET | Use this API to get the details of an individual digital signage content item. |
Get Digital Signage library playlistGetDigitalSignagelibraryplaylist | GET | Returns a Zoom Rooms content library digital signage playlist. |
Get Digital Signage library playlist content itemsGetDigitalSignagelibraryplaylistcontentitems | GET | Returns a Zoom Rooms content library digital signage playlist content items and their metadata. |
Get Zoom Rooms background image library contentGetZoomRoomsBackgroundImageLibraryContent | GET | Return a Zoom Rooms background image library content item. |
Get Zoom Rooms Background Image Library FolderGetZoomRoomsBackgroundLibraryFolder | GET | Returns a Zoom Rooms background image library folder. |
List default Zoom Rooms background image library contentsListDefaultZoomRoomsBackgroundImageLibrarycontents | GET | Display a list of Zoom-provided default background images from the background image library. |
List Digital Signage content itemsGETListdigitalsignagecontentitems | GET | Returns a list of Zoom Rooms digital signage library base folder content items. |
List Digital Signage library playlist published roomsListDigitalSignagelibraryplaylistpublishedrooms | GET | List Digital Signage library playlist published rooms. |
List Digital Signage library playlistsListDigitalSignagelibraryplaylists | GET | Returns a list of Zoom Rooms content library digital signage playlists. |
List Zoom Rooms background image library contentsListZoomRoomsbackgroundimagelibrarycontents | GET | Returns a list of Zoom Rooms background image library contents. |
List Zoom Rooms Background Image Library FoldersListZoomRoomsBackgroundLibraryFolders | GET | Returns a list of Zoom Rooms background image library content folders. |
Update a digital signage content folderUpdateadigitalsignagecontentfolder | PATCH | Updates a Digital Signage content folder’s attributes. |
Update a Digital Signage content item attributesUpdateadigitalsignagecontentitemattributes | PATCH | Use this API to update a digital signage content item's attributes. |
Update a Digital Signage image or video fileUpdateadigitalsignageimageorvideofile | PUT | Update an image or video content item in the Zoom Rooms digital signage content library. |
Update a Digital Signage library playlistUpdateaDigitalSignagelibraryplaylist | PATCH | Updates a Zoom Rooms content library digital signage playlist. |
Update Digital Signage library playlist content itemsUpdateDigitalSignagelibraryplaylistcontentitems | PUT | Updates a Zoom Rooms content library digital signage playlist content items and their metadata. |
Update Digital Signage library playlist published roomsUpdateDigitalSignagelibraryplaylistpublishedrooms | PUT | Update Digital Signage library playlist published rooms. |
Update Zoom Rooms background image library contentUpdateZoomRoomsBackgroundImageLibraryContent | PUT | Update a Zoom Rooms background image library content. |
Update Zoom Rooms Background Image Library FolderUpdateaZoomRoomsBackgroundLibraryFolderName | PATCH | Updates a Zoom Rooms background image library content folder. |
Zoom Rooms Device2
Change Zoom Rooms app versionchangeZoomRoomsAppVersion | PUT | Use this API to upgrade or downgrade the version of your installed Zoom Rooms app on your Mac or Windows device. |
Delete a Zoom Room user devicedeleteDeviceRooms | DELETE | Deletes a Zoom Room device. |
Zoom Rooms Location10
Add a locationaddAZRLocation | POST | Add a location to the location hierarchial structure(s) of Zoom Rooms in an account. |
Change the assigned parent locationchangeParentLocation | PUT | An account owner of a Zoom account can establish a Zoom Rooms Location Hierarchy to better organize Zoom Rooms spread across various locations. |
Delete a locationdeleteAZRLocation | DELETE | Remove a location from the location hierarchial structure(s) of Zoom Rooms in an account. |
Get location settingsgetZRLocationSettings | GET | Get information on meeting, alert, digital signage or scheduling display settings applied to Zoom Rooms located in a specific location. |
Get Zoom Room location profilegetZRLocationProfile | GET | Each location type of the Zoom Rooms location hierarchy has a profile page with information such as the location name, address, support email, and more. |
Get Zoom Room location structuregetZRLocationStructure | GET | Get the location hierarchial structure(s) applied on the Zoom Rooms in an account. |
List Zoom Room locationslistZRLocations | GET | A Zoom account owner or a Zoom Room administrator can establish a location hierarchy to help manage Zoom Rooms that are spread among a variety of locations. |
Update location settingsupdateZRLocationSettings | PATCH | Update meeting, alert, digital signage or scheduling display settings applied to Zoom Rooms located in a specific location. |
Update Zoom Room location profileupdateZRLocationProfile | PATCH | Each location type of the 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... |
Update Zoom Rooms location structureupdateZoomRoomsLocationStructure | PUT | Update the location hierarchial structure(s) applied on the Zoom Rooms in an account. |
Zoom Rooms Tag7
Assign Tags to a Zoom RoomAssignTagsToAZoomRoom | PATCH | Use this API to assign Tags to a Zoom Room |
Assign Tags to Zoom Rooms By Location IDAssignTagsToZoomRoomsByLocationID | PATCH | Use this API to assign Tags to Zoom Rooms by location ID Prerequisites: A Pro or a higher plan with a Zoom Rooms license. |
Create a new Zoom Rooms TagcreateZoomRoomTag | POST | Creates a new Zoom Rooms Tag. |
Delete TagdeleteZoomRoomTag | DELETE | Deletes Tag. |
Edit TageditZoomRoomTag | PATCH | Edits Tag. |
List all Zoom Room TagslistZoomRoomTags | GET | List all Zoom Rooms Tags Prerequisites: A Pro or a higher plan with a Zoom Rooms license. |
Un-assign Tags from a Zoom RoomunassignZoomRoomTag | DELETE | Un-assign Tags from a Zoom Room Prerequisites: A Pro or a higher plan with a Zoom Rooms license. |