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

  1. In Neblex open Connect › Connections and click New Connection.
  2. Search for Zoom and give the connection a clear name.
  3. Fill in the fields. Secret values are encrypted and never shown again.
  4. Click Test, then Create Connection.
FieldWhat 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.

EventWhat it doesHow
New or updated commentFires for each comment that appears or changes since the last check.Checks for changes
New or updated faxFires for each fax that appears or changes since the last check.Checks for changes
New or updated knowledge managementFires for each knowledge management created or changed since the last check.Checks for changes by updated_at
New or updated engagementFires for each engagement that appears or changes since the last check.Checks for changes
New or updated clinicalnoteFires for each clinicalnote that appears or changes since the last check.Checks for changes
New or updated data requestFires for each data request that appears or changes since the last check.Checks for changes
New or updated api connectorFires for each api connector that appears or changes since the last check.Checks for changes
New or updated smsFires for each sms that appears or changes since the last check.Checks for changes
New or updated clipFires for each clip that appears or changes since the last check.Checks for changes
New or updated workspaceFires for each workspace that appears or changes since the last check.Checks for changes
New or updated information barrierFires for each information barrier that appears or changes since the last check.Checks for changes
New or updated eventFires for each event that appears or changes since the last check.Checks for changes
New or updated userFires for each user that appears or changes since the last check.Checks for changes
New or updated inbound blocked listFires for each inbound blocked list that appears or changes since the last check.Checks for changes
New or updated prospect managementFires for each prospect management that appears or changes since the last check.Checks for changes
New or updated videoFires for each video created or changed since the last check.Checks for changes by modified_time
New or updated appFires for each app that appears or changes since the last check.Checks for changes
New or updated audio libraryFires for each audio library that appears or changes since the last check.Checks for changes
New or updated playlistFires for each playlist that appears or changes since the last check.Checks for changes
New or updated collaboratorFires for each collaborator that appears or changes since the last check.Checks for changes
New or updated zoom rooms contentFires for each zoom rooms content that appears or changes since the last check.Checks for changes
New or updated firmware update ruleFires for each firmware update rule that appears or changes since the last check.Checks for changes
New or updated flowFires for each flow that appears or changes since the last check.Checks for changes
New or updated hubFires for each hub that appears or changes since the last check.Checks for changes
New or updated phone roleFires for each phone role that appears or changes since the last check.Checks for changes
New or updated regionFires for each region that appears or changes since the last check.Checks for changes
New or updated room templateFires for each room template that appears or changes since the last check.Checks for changes
New or updated sip phoneFires for each sip phone that appears or changes since the last check.Checks for changes
New or updated sms consentFires for each sms consent that appears or changes since the last check.Checks for changes
New or updated phone deviceFires for each phone device that appears or changes since the last check.Checks for changes
New or updated exhibitorFires for each exhibitor that appears or changes since the last check.Checks for changes
New or updated video on demandFires for each video on demand that appears or changes since the last check.Checks for changes
New or updated video on demand registrationFires for each video on demand registration that appears or changes since the last check.Checks for changes
New or updated documentFires for each document that appears or changes since the last check.Checks for changes
New or updated aclFires for each acl that appears or changes since the last check.Checks for changes
New or updated calendar listFires for each calendar list that appears or changes since the last check.Checks for changes
New or updated settingFires for each setting that appears or changes since the last check.Checks for changes
New or updated accountFires for each account created or changed since the last check.Checks for changes by last_modified_time
New or updated voicemailFires for each voicemail that appears or changes since the last check.Checks for changes
New or updated contact groupFires for each contact group that appears or changes since the last check.Checks for changes
New or updated h323 deviceFires for each h323 device that appears or changes since the last check.Checks for changes
New or updated noteFires 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 queueFires for each call queue that appears or changes since the last check.Checks for changes
New or updated chat channelFires for each chat channel that appears or changes since the last check.Checks for changes
New or updated chat messageFires for each chat message that appears or changes since the last check.Checks for changes
New or updated conversationFires for each conversation created or changed since the last check.Checks for changes by last_modified_time
New or updated sessionFires for each session that appears or changes since the last check.Checks for changes
New or updated taskFires for each task that appears or changes since the last check.Checks for changes
New or updated queueFires for each queue created or changed since the last check.Checks for changes by last_modified_time
New or updated speakerFires for each speaker that appears or changes since the last check.Checks for changes
New or updated teamFires for each team that appears or changes since the last check.Checks for changes
New or updated ticketFires for each ticket that appears or changes since the last check.Checks for changes
New or updated webinarFires for each webinar that appears or changes since the last check.Checks for changes
New or updated groupFires for each group that appears or changes since the last check.Checks for changes
New or updated im groupFires for each im group that appears or changes since the last check.Checks for changes
New or updated visitor managementFires for each visitor management that appears or changes since the last check.Checks for changes
New or updated outbound callingFires for each outbound calling that appears or changes since the last check.Checks for changes
New or updated provision templateFires for each provision template that appears or changes since the last check.Checks for changes
New or updated dealFires for each deal that appears or changes since the last check.Checks for changes
New or updated archivingFires for each archiving that appears or changes since the last check.Checks for changes
New or updated asset libraryFires for each asset library that appears or changes since the last check.Checks for changes
New or updated auto receptionistFires for each auto receptionist that appears or changes since the last check.Checks for changes
New or updated scribeFires for each scribe that appears or changes since the last check.Checks for changes
New or updated summarizerFires for each summarizer that appears or changes since the last check.Checks for changes
New or updated translatorFires for each translator that appears or changes since the last check.Checks for changes
New or updated block list ruleFires for each block list rule created or changed since the last check.Checks for changes by last_modified_time
New or updated blocked listFires for each blocked list that appears or changes since the last check.Checks for changes
New or updated operating hourFires for each operating hour that appears or changes since the last check.Checks for changes
New or updated campaignFires for each campaign that appears or changes since the last check.Checks for changes
New or updated classification labelFires for each classification label that appears or changes since the last check.Checks for changes
New or updated common areaFires for each common area that appears or changes since the last check.Checks for changes
New or updated address bookFires for each address book that appears or changes since the last check.Checks for changes
New or updated deviceFires for each device that appears or changes since the last check.Checks for changes
New or updated dispositionFires for each disposition created or changed since the last check.Checks for changes by last_modified_time
New or updated divisionFires for each division that appears or changes since the last check.Checks for changes
New or updated emergency addressFires for each emergency address that appears or changes since the last check.Checks for changes
New or updated recordingFires for each recording that appears or changes since the last check.Checks for changes
New or updated external contactFires for each external contact that appears or changes since the last check.Checks for changes
New or updated group call pickupFires for each group call pickup that appears or changes since the last check.Checks for changes
New or updated inboxFires for each inbox created or changed since the last check.Checks for changes by last_modified_time
New or updated legal holdFires for each legal hold that appears or changes since the last check.Checks for changes
New or updated emergency service locationFires for each emergency service location that appears or changes since the last check.Checks for changes
New or updated templateFires for each template that appears or changes since the last check.Checks for changes
New or updated monitoring groupFires for each monitoring group that appears or changes since the last check.Checks for changes
New or updated phone numberFires for each phone number that appears or changes since the last check.Checks for changes
New or updated siteFires for each site that appears or changes since the last check.Checks for changes
New or updated setting templateFires for each setting template that appears or changes since the last check.Checks for changes
New or updated shared line groupFires for each shared line group that appears or changes since the last check.Checks for changes
New or updated shared spaceFires for each shared space that appears or changes since the last check.Checks for changes
New or updated skillFires for each skill created or changed since the last check.Checks for changes by last_modified_time
New or updated chat channel mention groupFires for each chat channel mention group that appears or changes since the last check.Checks for changes
New or updated zoom roomFires for each zoom room that appears or changes since the last check.Checks for changes
New or updated meetingFires for each meeting that appears or changes since the last check.Checks for changes
New or updated channelFires for each channel that appears or changes since the last check.Checks for changes
New or updated zoom rooms locationFires for each zoom rooms location that appears or changes since the last check.Checks for changes
New or updated zoom rooms tagFires for each zoom rooms tag that appears or changes since the last check.Checks for changes
New or updated availabilityFires for each availability that appears or changes since the last check.Checks for changes
New or updated draftFires for each draft that appears or changes since the last check.Checks for changes
New or updated settings filterFires for each settings filter that appears or changes since the last check.Checks for changes
New or updated threadFires for each thread that appears or changes since the last check.Checks for changes
New or updated messageFires for each message that appears or changes since the last check.Checks for changes
New or updated labelFires for each label that appears or changes since the last check.Checks for changes
New or updated scheduled eventFires for each scheduled event that appears or changes since the last check.Checks for changes
New or updated scheduleFires for each schedule that appears or changes since the last check.Checks for changes
New or updated cloud recordingFires for each cloud recording that appears or changes since the last check.Checks for changes
New or updated invitation & registrationFires for each invitation & registration that appears or changes since the last check.Checks for changes
New or updated roleFires for each role that appears or changes since the last check.Checks for changes
New commentFires for each comment created since the last check.Checks for changes by create_time
New faxFires for each fax created since the last check.Checks for changes by create_time
New knowledge managementFires for each knowledge management created since the last check.Checks for changes by created_at
New engagementFires for each engagement that appears since the last check.Checks for changes
New clinicalnoteFires for each clinicalnote that appears since the last check.Checks for changes
New data requestFires for each data request created since the last check.Checks for changes by created_at
New api connectorFires for each api connector that appears since the last check.Checks for changes
New smsFires for each sms that appears since the last check.Checks for changes
New clipFires for each clip that appears since the last check.Checks for changes
New workspaceFires for each workspace that appears since the last check.Checks for changes
New information barrierFires for each information barrier that appears since the last check.Checks for changes
New eventFires for each event that appears since the last check.Checks for changes
New userFires for each user that appears since the last check.Checks for changes
New inbound blocked listFires for each inbound blocked list that appears since the last check.Checks for changes
New prospect managementFires for each prospect management that appears since the last check.Checks for changes
New videoFires for each video created since the last check.Checks for changes by created_time
New appFires for each app that appears since the last check.Checks for changes
New audio libraryFires for each audio library that appears since the last check.Checks for changes
New playlistFires for each playlist that appears since the last check.Checks for changes
New collaboratorFires for each collaborator that appears since the last check.Checks for changes
New zoom rooms contentFires for each zoom rooms content that appears since the last check.Checks for changes
New firmware update ruleFires for each firmware update rule that appears since the last check.Checks for changes
New flowFires for each flow that appears since the last check.Checks for changes
New hubFires for each hub that appears since the last check.Checks for changes
New phone roleFires for each phone role that appears since the last check.Checks for changes
New regionFires for each region that appears since the last check.Checks for changes
New room templateFires for each room template that appears since the last check.Checks for changes
New sip phoneFires for each sip phone that appears since the last check.Checks for changes
New sms consentFires for each sms consent created since the last check.Checks for changes by create_time
New phone deviceFires for each phone device that appears since the last check.Checks for changes
New exhibitorFires for each exhibitor that appears since the last check.Checks for changes
New video on demandFires for each video on demand that appears since the last check.Checks for changes
New video on demand registrationFires for each video on demand registration that appears since the last check.Checks for changes
New documentFires for each document created since the last check.Checks for changes by created_date
New aclFires for each acl that appears since the last check.Checks for changes
New projectFires for each project created since the last check.Checks for changes by created_date
New calendar listFires for each calendar list that appears since the last check.Checks for changes
New settingFires for each setting that appears since the last check.Checks for changes
New accountFires for each account created since the last check.Checks for changes by created_time
New voicemailFires for each voicemail that appears since the last check.Checks for changes
New contact groupFires for each contact group that appears since the last check.Checks for changes
New h323 deviceFires for each h323 device that appears since the last check.Checks for changes
New noteFires 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 queueFires for each call queue that appears since the last check.Checks for changes
New chat channelFires for each chat channel that appears since the last check.Checks for changes
New chat messageFires for each chat message that appears since the last check.Checks for changes
New conversationFires for each conversation created since the last check.Checks for changes by created_time
New custom crmFires for each custom crm created since the last check.Checks for changes by create_time
New sessionFires for each session that appears since the last check.Checks for changes
New taskFires for each task created since the last check.Checks for changes by create_time
New speakerFires for each speaker that appears since the last check.Checks for changes
New teamFires for each team that appears since the last check.Checks for changes
New ticketFires for each ticket that appears since the last check.Checks for changes
New webinarFires for each webinar that appears since the last check.Checks for changes
New groupFires for each group that appears since the last check.Checks for changes
New im groupFires for each im group that appears since the last check.Checks for changes
New visitor managementFires for each visitor management that appears since the last check.Checks for changes
New outbound callingFires for each outbound calling that appears since the last check.Checks for changes
New provision templateFires for each provision template that appears since the last check.Checks for changes
New dealFires for each deal created since the last check.Checks for changes by create_time
New archivingFires for each archiving that appears since the last check.Checks for changes
New asset libraryFires for each asset library that appears since the last check.Checks for changes
New auto receptionistFires for each auto receptionist that appears since the last check.Checks for changes
New scribeFires for each scribe that appears since the last check.Checks for changes
New summarizerFires for each summarizer that appears since the last check.Checks for changes
New translatorFires for each translator that appears since the last check.Checks for changes
New block list ruleFires for each block list rule created since the last check.Checks for changes by created_time
New blocked listFires for each blocked list that appears since the last check.Checks for changes
New operating hourFires for each operating hour that appears since the last check.Checks for changes
New campaignFires for each campaign that appears since the last check.Checks for changes
New classification labelFires for each classification label created since the last check.Checks for changes by create_time
New common areaFires for each common area that appears since the last check.Checks for changes
New address bookFires for each address book that appears since the last check.Checks for changes
New deviceFires for each device that appears since the last check.Checks for changes
New dispositionFires for each disposition that appears since the last check.Checks for changes
New divisionFires for each division that appears since the last check.Checks for changes
New emergency addressFires for each emergency address that appears since the last check.Checks for changes
New recordingFires for each recording that appears since the last check.Checks for changes
New external contactFires for each external contact that appears since the last check.Checks for changes
New group call pickupFires for each group call pickup that appears since the last check.Checks for changes
New inboxFires for each inbox that appears since the last check.Checks for changes
New legal holdFires for each legal hold that appears since the last check.Checks for changes
New emergency service locationFires for each emergency service location that appears since the last check.Checks for changes
New templateFires for each template that appears since the last check.Checks for changes
New monitoring groupFires for each monitoring group that appears since the last check.Checks for changes
New phone numberFires for each phone number that appears since the last check.Checks for changes
New siteFires for each site that appears since the last check.Checks for changes
New chat reminderFires for each chat reminder created since the last check.Checks for changes by create_time
New setting templateFires for each setting template that appears since the last check.Checks for changes
New shared line groupFires for each shared line group that appears since the last check.Checks for changes
New shared spaceFires for each shared space that appears since the last check.Checks for changes
New chat channel mention groupFires for each chat channel mention group that appears since the last check.Checks for changes
New zoom roomFires for each zoom room that appears since the last check.Checks for changes
New meetingFires for each meeting created since the last check.Checks for changes by created_at
New variableFires for each variable created since the last check.Checks for changes by created_at
New channelFires for each channel that appears since the last check.Checks for changes
New zoom rooms locationFires for each zoom rooms location that appears since the last check.Checks for changes
New zoom rooms tagFires for each zoom rooms tag that appears since the last check.Checks for changes
New availabilityFires for each availability that appears since the last check.Checks for changes
New draftFires for each draft that appears since the last check.Checks for changes
New settings filterFires for each settings filter that appears since the last check.Checks for changes
New threadFires for each thread that appears since the last check.Checks for changes
New messageFires for each message that appears since the last check.Checks for changes
New labelFires for each label that appears since the last check.Checks for changes
New scheduled eventFires for each scheduled event that appears since the last check.Checks for changes
New scheduleFires for each schedule that appears since the last check.Checks for changes
New cloud recordingFires for each cloud recording that appears since the last check.Checks for changes
New invitation & registrationFires for each invitation & registration created since the last check.Checks for changes by create_time
New roleFires for each role that appears since the last check.Checks for changes

Use it in a flow

  1. Open a flow, open the node library and search for Zoom.
  2. Drag it onto the canvas and choose an Operation and your connection.
  3. Map the operation's fields from earlier steps, or click Map with Matt.
  4. 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 IDaddOutboundCallerNumbersPOSTAdds the account-level customized outbound caller ID phone numbers.
Delete phone numbers for an account's customized outbounddeleteOutboundCallerNumbersDELETEDeletes the account-level customized outbound caller ID phone numbers.
Delete virtual background filesdelVBDELETEDeletes an account's existing virtual background files.
Get account settingsaccountSettingsGETReturns an account's settings.
Get account's managed domainsaccountManagedDomainGETRetrieve a list of an account's managed domains.
Get account's trusted domainsaccountTrustedDomainGETRetrieve an account's trusted domains.
Get an account's webinar registration settingsaccountSettingsRegistrationGETGet an account's webinar registration settings.
Get Cisco/Polycom Room Account SettinggetCiscoPolycomRoomAccountSettingGETRetrieves details of the managed Cisco or Polycom rooms account profile settings.
Get indicators settingsaccountIndicatorsSettingsGETGet the account's indicators settings.
Get locked settingsgetAccountLockSettingsGETRetrieves an account's locked settings.
List an account's customized outbound caller ID phone numberslistCustomizeOutboundCallerNumbersGETRetrieves phone numbers that can be used as the account-level customized outbound caller ID.
List an account's Zoom Phone settingslistZoomPhoneAccountSettingsGETReturns an account's Zoom Phone settings.
List storage locationsListStorageLocationsGETList all available storage locations for this account.
Update account settingsaccountSettingsUpdatePATCHUpdate an account's settings.
Update an account's webinar registration settingsaccountSettingsRegistrationUpdatePATCHUpdate an account's webinar registration settings.
Update Cisco/Polycom Room Account SettingUpdateCiscoPolycomRoomAccountSettingPATCHUpdates details of the managed Cisco/Polycom rooms account profile settings.
Update locked settingsupdateAccountLockSettingsPATCHUpdates an account's locked settings.
Update the account ownerupdateAccountOwnerPUTChanges an account's owner.
Upload virtual background filesuploadVBPOSTUploads virtual background files for all users on the account to use.
Account Management4
Add contacts to an existing end customer or your own account.addAccountContactPOSTAdd contacts to an existing end customer or your own account.
Create an end customer accountcreateAccountPOSTCreates an end customer account.
Get the account details for a Zoom Partner/Subreseller/EndgetAccountDetailsGETReturns the account details for a Zoom Partner, Subreseller, and End Customer.
Get the list of all accounts associated with a ZoomgetAllAccountsGETReturns 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 ruleInsertaclPOSTCreates an access control list rule.
Delete an existing ACL ruleDeleteaclDELETEDeletes an access control list (ACL) rule.
Get the specified ACL ruleGetaclGETReturns an access control list (ACL) rule.
List ACL rules of specified calendarListaclGETReturns the rules in the access control list for the calendar.
Update the specified ACL rulePatchaclPATCHUpdates an access control list rule.
Address Book24
Batch create address book contactsbatchCreateContactPOSTBatch create new contacts in an address book (https://support.zoom.us/hc/en-us/articles/4471544949389).
Batch delete address book contactsbatchDeletecontactDELETEBatch delete contacts from an address book.
Batch update address book contactsbatchUpdateContactPATCHBatch update contacts in an address book (https://support.zoom.us/hc/en-us/articles/4471544949389).
Create an address bookcreateAddressBookPOSTCreate an address book.
Create an address book contactcreateContactPOSTCreate a new contact in an address book.
Create an address book custom fieldCreateacustomfieldPOSTCreate an address book custom field.
Create an address book unitcreateUnitPOSTCreate an address book unit.
Delete an address bookdeleteAddressBookDELETEDelete an address book.
Delete an address book contactcontactDeleteDELETEDelete a contact from an address book.
Delete an address book custom fieldDeleteancustomfieldDELETEDelete an address book custom field.
Delete an address book unitdeleteUnitDELETEDelete an address book unit.
Get an address bookgetAddressBookGETReturns information about an address book.
Get an address book contactgetContactGETReturns information about an address book's contact.
Get an address book unitgetUnitGETReturns information about an address book unit.
Get an address book's custom fieldGetaaddressbookcustomfieldGETGet information about an address book's custom field.
List address book contactslistContactsGETWhen the emails or phone numbers query parameter is included, the address book returns a maximum of 10,000 contacts.
List address book unitslistUnitsGETReturn all address book units.
List address bookslistAddressBooksGETReturn a list of all address books.
List an address book contact's custom fieldsListContactCustomFieldsGETList all custom fields on a contact.
List an address book's custom fieldsListaddressbookcustomfieldsGETReturn all address book custom fields.
Update an address bookupdateAddressBookPATCHUpdate an address book's information.
Update an address book contactupdateContactPATCHUpdate an address book's contact.
Update an address book custom fieldUpdateacustomfieldPATCHUpdate an address book custom field.
Update an address book unitupdateUnitPATCHUpdate an address book unit.
Agent Statuse5
Create a system statuscreateSystemStatusPOSTCreate custom statuses for the agent status and queue opt out and not ready status categories.
Delete a system statusdeleteSystemStatusDELETEDelete a custom status for the agent status and queue opt out and not ready status categories.
Get a system statusgetAStatusGETGet information about a system status.
List system statuseslistSystemStatusGETGet a list of system statuses.
Update a system statusupdateSystemStatusPATCHUpdate a custom status for the agent status and queue opt out and not ready status categories.
Alert5
Add an alert settingAddAnAlertSettingPOSTAdds an alert setting.
Delete an alert settingDeleteAnAlertSettingDELETEDeletes an alert setting.
Get alert setting detailsGetAlertSettingDetailsGETReturns detailed information about a specific alert setting.
List alert settings with paging queryListAlertSettingsWithPagingQueryGETGets alert settings for an account with paging query.
Update an alert settingUpdateAnAlertSettingPATCHUpdates information of an Alert setting.
Analytic1
Report analyticsreport_analyticsGETGenerates the scheduler analytics report.
Api Connector7
Create an API ConnectorCreateAPIConnectorPOSTCreates an Enhanced API Connector.
Delete an API ConnectorDeleteAPIConnectorDELETEDeletes an enhanced API connector.
Get an API ConnectorGetAPIConnectorGETReturns the details of an enhanced API connector.
Get an API Connector's private keyGetanAPIConnector_sprivatekeyGETRetrieves the private key of an Enhanced API Connector.
List API ConnectorsGetListAPIConnectorsGETReturns the Enhanced API Connectors for Cisco or Polycom Rooms.
Update an API ConnectorUpdateAPIConnectorPATCHUpdates the settings of an Enhanced API Connector.
Update an API Connector's private keyUpdateAPIConnectorPrivateKeyPATCHRegenerates the enhanced API connector's private key.
App25
Add app allow requests for usersAddAppAllowRequestsForUsersPOSTUse this API to add app allow requests for all users, groups of users, or specific users.
Create an event subscriptioncreateEventSubscriptionPOSTProgrammatically create event subscriptions for an authorized application.
Create appsCreateAppsPOSTCreate Server to Server OAuth, Meeting SDK or General apps in the Zoom Marketplace.
Delete an event subscriptiondeleteEventSubscriptionDELETEDelete an event subscription.
Deletes an appdeleteAppDELETEPermanently delete an app on behalf of a user.
Enable or disable user app subscriptionEnable_DisableuserappsubscriptionPATCHEnable or disable a user's app subscription.
Generate an app deeplinkgenerateAppDeeplinkPOSTCreate an app deeplink.
Generate Zoom App DeeplinkGenerateZoomAppDeeplinkPOSTCreate a Zoom App Deeplink.
Get a user's app requestsgetUserAppRequestsGETUse this API to get all of a user's app requests.
Get a user's entitlementsgetUserEntitlementRequestsGETGet a user's entitlements.
Get an app's user requestsgetAppUserRequestsGETUse this API to get an app's user requests and the status of their approval.
Get API call logsGetapicalllogsGETGet log of app's API calls.
Get app user entitlementsgetAppUserEntitlementRequestsGETGet the app user's entitlements information.
Get information about an appgetAppInfoGETUse this API to get app information.
Get user or account event subscriptiongetUserEventSubscriptionsGETReturns event subscriptions for users or accounts.
Get user's custom field valuesgetCustomFieldValuesGETGet custom field values for user.
Get webhook logsgetWebhookLogsMarketplaceGETGet users' webhook call logs and query records from the past 7 days.
List appsListAppsGETList all active and past app requests, or list all approved public and private apps.
Rotate client secretRotateClientSecretPOSTCreate or update a marketplace application's client secret rotating schedule.
Send app notificationsSendappnotificationsPOSTSend app notifications to the Zoom Activity Center.
Subscribe to an event subscriptionsubscribeEventSubscriptionPATCHSubscribe to an event subscription.
Unsubscribe to an app event subscriptionunSubscribeEventSubscriptionDELETEUse this API endpoint to unsubscribe an event subscription.
Update an event subscriptionupdateEventSubscriptionPATCHUpdate an event subscription.
Update app pre approval settingUpdateapppreapprovalsettingPOSTThis 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 statusupdateAppRequestStatusPATCHUse this API to update an app's request status or update app status.
Archived1
Get AI Companion conversation archivesGetAICconversationarchivesGETRetrieve the AI Companion conversation archives.
Archiving11
Delete a meeting's archived filesdeleteArchivedFilesDELETEDelete all of a meeting's archived files.
Download archive attachmentsBatchGetArchiveAttachmentDownloadUrlGETBatch retrieve download URLs for attachments in archived files.
Download Whiteboards activity fileDownloadwhiteboardsactivityfileGETUse this API to download the Whiteboard archival file.
Get a meeting's archive token for local archivingmeetingLocalArchivingArchiveTokenGETGet a meeting's archive token to allow local archiving.
Get a meeting's archived filesgetArchivedFilesGETReturn a specific meeting instance's archived files.
Get archived file statisticsgetArchivedFileStatisticsGETGet statistics about an account's archived meeting or webinar files.
List archived fileslistArchivedFilesGETGet an account's archived meeting or webinar files.
List doc archive dataListdocarchiveGETList archived documents for a given account within a specified time range.
List whiteboard sessions activitiesListwhiteboardsessionsarchivedfilesGETLists a session's activity information.
List whiteboards sessionsCreatewhiteboardsarchivefilesGETCreates a list of archived sessions under current account.
Update an archived file's auto-delete statusupdateArchivedFilePATCHUpdate an archived file's auto-delete status.
Asset Library13
Batch update asset itemsBatchUpdateAssetItemsPATCHBatch updates asset items across multiple assets in a single request.
Create an assetcreateAnAssetPOSTCreate an asset to store in the Contact Center Asset Library.
Create an asset categorycreateAnAssetCategoryPOSTCreate an asset category.
Delete an assetdeleteAnAssetDELETEDelete or achive an existing asset.
Delete an asset categorydeleteAnAssetCategoryDELETEDelete an existing asset category.
Delete asset itemsDeleteassetitemsDELETEDelete specific asset items.
Duplicate an assetduplicateAnAssetPOSTCreates new assets based on an existing asset.
Get an assetgetAnAssetGETGet information about an asset.
Get an asset categorygetAnAssetCategoryGETGet an asset category.
List asset categorieslistAssetCategoriesGETList asset categories.
List assetslistAssetsGETList Contact Center assets.
Update an assetupdateAnAssetPATCHUpdate an asset.
Update an asset categoryupdateAnAssetCategoryPATCHUpdate an asset category.
Assignee3
Add assignees to a taskaddTasksAssigneesPOSTAdd one or more assignees to a specified task.
Get assignees of a taskGetAssigneesOfATaskGETRetrieves the list of assignees of a specified task.
Remove Assignee from taskremoveTaskAssigneeDELETERemoves a specific assignee from a task.
Attendee Action4
List event attendee actionsListEventAttendeeActionsGETRetrieves the attendee actions performed by the host for an event.
List session attendee actionsListSessionAttendeeActionsGETRetrieves the attendee actions performed by the host for an event session.
Update event attendee actionsUpdateEventAttendeeActionsPATCHRetrieves attendee onsite action for an event.
Update session attendee actionsUpdateSessionAttendeeActionsPATCHPerforms attendee onsite action for an event session.
Audio Library6
Add an audio item for text-to-speech conversionAddAnAudioPOSTAdds an audio item for text-to-speech conversion.
Add audio itemsAddAudioItemPOSTAdds the audio items.
Delete an audio itemDeleteAudioItemDELETEDeletes an audio item.
Get an audio itemGetAudioItemGETReturns an audio item.
List audio itemsListAudioItemsGETReturns personal audios.
Update an audio itemUpdateAudioItemPATCHUpdates an audio item.
Auto Receptionist19
Add a policy subsettingAddPolicyPOSTAdds a policy subsetting for a specific auto receptionist according to the policyType.
Add an auto receptionistaddAutoReceptionistPOSTAdds an auto receptionist to a Zoom Phone.
Add auto receptionist settingaddAutoReceptionistSettingPOSTAdds the auto receptionist setting according to the setting type.
Assign phone numbersassignPhoneNumbersAutoReceptionistPOSTAssigns available phone numbers to an auto receptionist.
Delete a non-primary auto receptionistdeleteAutoReceptionistDELETEDeletes a non-primary auto receptionist.
Delete a policy subsettingDeletePolicyDELETERemoves the policy subsetting for a specific auto receptionist according to the policyType.
Delete auto receptionist settingdeleteAutoReceptionistSettingDELETEDelete the auto receptionist setting according to the setting type.
Get an auto receptionistgetAutoReceptionistDetailGETReturns information on a specific auto receptionist.
Get an auto receptionist policygetAutoReceptionistsPolicyGETReturns the policy setting of a specific auto receptionist.
Get auto receptionist call handling settinggetAutoReceptionistCallHandlingSettingsGETReturns the call handling setting of an auto receptionist for the specified hour type.
Get auto receptionist settingsgetAutoReceptionistSettingsGETReturns auto receptionist settings.
List auto receptionistslistAutoReceptionistsGETReturns a list of auto receptionists.
Unassign a phone numberunassignAPhoneNumAutoReceptionistDELETEUnassigns a specific phone number that was previously assigned to an auto receptionist.
Unassign all phone numbersunassignAllPhoneNumsAutoReceptionistDELETEUnassigns all phone numbers that were previously assigned to an auto receptionist.
Update a policy subsettingupdatePolicyPATCHUpdates the policy subsetting of a specific auto receptionist according to the policyType.
Update an auto receptionistupdateAutoReceptionistPATCHChanges information such as the display name and the extension number assigned to the main auto receptionist.
Update an auto receptionist policyupdateAutoReceptionistPolicyPATCHUpdates the policy setting of a specific auto receptionist.
Update auto receptionist call handling settingupdateAutoReceptionistCallHandlingSettingsPATCHUpdate the call handling setting of an auto receptionist for the specified hour type.
Update auto receptionist settingupdateAutoReceptionistSettingPATCHUpdates the auto receptionist setting according to the setting type.
Availability5
Delete availabilitydelete_availabilityDELETERemoves a user's availability.
Get availabilityget_availabilityGETReturns the availability schedule of the given UUID.
Insert availabilityinsert_availabilityPOSTInserts a user availability schedule.
List availabilitylist_availabilityGETReturns the availability schedules of the given user.
Patch availabilitypatch_availabilityPATCHAdjusts the availability schedule content of the given UUID.
Billing3
Get detailed information about a specific invoice for agetInvoiceDetailGETReturns detailed information about a specific invoice for a distributor or a reseller.
Gets all billing documents for a distributor or a resellergetAllBillingDocsGETReturns all billing documents for a distributor or a reseller.
Gets the PDF document for the billing document IDdownloadBillingDocGETReturns the PDF document for the billing document ID.
Billing Account2
Get billing account detailsGetABillingAccountGETA Zoom account owner or a user with admin privilege can use this API to get information about a billing account.
List billing accountslistBillingAccountGETRetrieves 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 addressescreateBlockListRulesIpAddressesPOSTCreate block list rules for IP addresses.
Create block list rules for phone numberscreateBlockListRulesPhoneNumbersPOSTCreate block list rules for phone numbers.
Delete IP addresses' block list rulesdeleteBlockListRuleIpAddressesDELETEDelete block list rules of IP addresses.
Delete phone numbers' block list rulesdeleteBlockListRulePhoneNumbersDELETEDelete block list rules of phone numbers.
Get a block list rule of IP addressesgetBlockListRuleIpAddressGETGet a block list rule of IP addresses.
Get a block list rule of phone numbersgetBlockListRulePhoneNumberGETGet a block list rule of phone numbers.
List block list rules for IP addresseslistBlockListRulesIpAddressesGETList block list rules for IP addresses.
List block list rules of phone numberslistBlockListRulesPhoneNumbersGETList block list rules of phone numbers.
Blocked List5
Create a blocked listaddAnumberToBlockedListPOSTCreates a block list and add a number to the list.
Delete a blocked listdeleteABlockedListDELETEDeletes a blocked list, which removes the associated number from the blocked list.
Get blocked list detailsgetABlockedListGETReturns the information about a specific blocked list.
List blocked listslistBlockedListGETReturns all the blocked lists in an acccount.
Update a blocked listupdateBlockedListPATCHUpdates the information in the blocked list.
Byos Storage6
Add storage locationbyosStoragePostPOSTAdd the Bring Your Own Storage (BYOS) location.
Change storage location detailbyosStorageDetailPatchPATCHChange one of the Bring Your Own Storage (BYOS) storage location details.
Delete storage location detailbyosStorageDetailDeleteDELETEDelete one of the the Bring Your Own Storage (BYOS) storage locations.
List storage locationbyosStorageGetGETList the Bring Your Own Storage (BYOS) location.
Storage location detailbyosStorageDetailGetGETGet details about one of the Bring Your Own Storage (BYOS) locations.
Update Bring Your Own Storage settingsbyosStorageSwitchPatchPATCHChange Cloud Recording's Bring Your Own Storage setting.
Calendar4
Create a new secondary calendarInsertcalendarPOSTCreates a secondary calendar.
Delete a calendar owned by a userDeletecalendarDELETEDeletes a calendar
Get the specified calendarGetcalendarGETReturns metadata for a calendar.
Update the specified calendarPatchcalendarPATCHUpdates metadata for a calendar.
Calendar List5
Delete an existing calendar from the user's own calendarListDeletecalendarListDELETERemoves a calendar from the user's calendar list.
Get a specified calendar from the user's own calendarListGetcalendarListGETReturns a calendar from the user's calendar list.
Insert an existing calendar to the user's own calendarListInsertcalendarListPOSTInserts an existing calendar into the user's calendar list.
List the calendars in the user's own calendarListListcalendarListGETReturns the calendars in the user's calendar list.
Update an existing calendar in the user's own calendarListPatchcalendarListPATCHUpdates an existing calendar on the user's calendar list.
Call Control3
Command control of a useruserControlPOSTIssue a command to trigger an action for a Contact Center user.
Control an engagement's recordingengagementRecordingControlPUTControls the recording state for an engagement.
List user's devicesListuserdevicesGETList a Contact Center user's device information.
Call Handling1
Delete a call handling settingdeleteCallHandlingDELETEDeletes a Zoom Phone's call handling settings.
Call History & Reporting4
Get Call HistoryGetCallHistoryGETRetrieve call history with pagination and various filtering options.
Get call history by IDGetCallDetailsbyCallIDGETRetrieve call history for a call history ID.
Get Report Call HistoryGetReportCallHistoryGETReturns the synchronous, page-based call history report for the resolved reporting scope and date window.
Get Seller Productivity ReportGetSellerProductivityReportGETReturns seller productivity metrics for the resolved reporting scope and date window.
Call List Management5
Create Call ListCreateCallListPOSTCreate a new call list
Delete Call ListDeleteCallListDELETEDelete a call list and all its associated prospects.
Get Call List by IDGetCallListbyIDGETRetrieve details of a specific call list by its ID
List Call ListsListCallListsGETRetrieve all call lists in the account.
Update Call ListUpdateCallListPATCHUpdate an existing call list.
Call Log8
Add a client code to a call historyaddClientCodeToCallHistoryPATCHAdds a client code to a call log.
Delete a user's call historydeleteUserCallHistoryDELETEDeletes a user's call history.
Get account's call historyaccountCallHistoryGETReturns an account's new edition of call logs.
Get call elementgetCallElementGETReturns the call element for a given call element ID.
Get call historygetCallPathGETReturns information about a call log.
Get User AI Call Summary DetailgetUserAICallSummaryGETReturns AI call summary details.
Get user's call historyphoneUserCallHistoryGETReturns a user's Zoom phone call history.
Sync user's call historysyncUserCallHistoryGETSyncs a user's Zoom phone call history.
Call Queue32
Add a policy subsetting to a call queueaddCQPolicySubSettingPOSTAdds the policy subsetting for a specific call queue according to the policyType.
Add call queue settingaddCallQueueSettingPOSTAdds a call queue setting according to the setting type.
Add members to a call queueaddMembersToCallQueuePOSTAdds phone users or common areas as members to a specific call queue.
Add members to a custom groupAddmemberstoacustomgroupPOSTAdds call queue members to a custom group.
Assign numbers to a call queueassignPhoneToCallQueuePOSTAssigns numbers to a call queue.
Create a call queuecreateCallQueuePOSTCreates a call queue.
Create a custom group in a call queueCreateacustomgroupinacallqueuePOST
Delete a call queuedeleteACallQueueDELETECall queues allow you to route incoming calls to a group of users.
Delete a CQ policy settingremoveCQPolicySubSettingDELETEUse this API to remove the policy sub-setting for a specific call queue according to the policyType.
Delete a custom groupDeleteacustomgroupDELETEDelete a custom group.
Delete call queue settingdeleteCallQueueSettingDELETEDelete the call queue setting by the setting type.
Get call queue call handling settinggetCallQueueCallHandlingSettingGETReturns the call handling setting of a call queue for the specified hour type.
Get call queue custom group detailGetacustomgroupGET
Get call queue detailsgetACallQueueGETRoutes incoming calls to a group of users and returns information on a specific call queue.
Get call queue policygetCallQueuePolicyGETReturns the policy setting of a specific [call queue].
Get call queue recordingsgetCallQueueRecordingsGETUse this API to view call recordings from the call queue.
Get call queue settingsgetCallQueueSettingsGETReturns call queue settings.
List call queue analyticscallqueueanalyticsGETReturns the call queue analytics overview.
List call queue memberslistCallQueueMembersGETReturns a list of call queue members.
List call queueslistCallQueuesGETCall queues allow you to route incoming calls to a group of users.
List custom groups of a call queueListcustomgroupsofacallqueueGETReturns a list of custom groups for a call queue.
Remove a member from a custom groupRemoveamemberfromacustomgroupDELETE
Unassign a memberunassignMemberFromCallQueueDELETERemoves a member who was previously added to a call queue.
Unassign a phone numberunAssignPhoneNumCallQueueDELETEUnbinds a phone number from a call queue.
Unassign all membersunassignAllMembersDELETERemoves all members from a call queue who were previously assigned to that call queue.
Unassign all phone numbersunassignAPhoneNumCallQueueDELETEUnbinds all phone numbers that are assigned to a call queue.
Update a call queue's policy subsettingupdateCQPolicySubSettingPATCHUpdates the policy subsetting for a specific call queue according to the policyType.
Update a custom groupUpdateacustomgroupPATCHUpdate a custom group.
Update call queue call handling settingupdateCallQueueCallHandlingSettingPATCHUpdates the call handling setting of a call queue for the specified hour type.
Update call queue detailsupdateCallQueuePATCHUpdates information of a specific call queue.
Update call queue policyupdateCallQueuePolicyPATCHUpdates a call queue's policy settings.
Update call queue settingupdateCallQueueSettingPATCHUpdate the call queue setting according to the setting type.
Campaign28
Batch create a campaign DNC list's phonesbatchCreateCampaignDncListPhonesPOSTBatch add phone numbers to a Do Not Call (DNC) list.
Batch delete a campaign DNC list's phonesbatchDeleteCampaignDncListPhoneDELETEBatch delete phone numbers from a Do Not Call (DNC) list.
Batch update campaign contact listsBatchupdatecampaigncontactlistsPATCHBatch update campaign contact lists.
Create a campaign contact listcreateCampaignContactListPOSTCreate a campaign contact list.
Create a campaign contact list's contactcreateCampaignContactListContactPOSTAdd a new contact to a campaign contact list.
Create a campaign contact list's custom fieldcreateACampaignContactCustomFieldPOSTCreate a custom field for a campaign contact list.
Create an outbound campaigncreateOutboundCampaignPOSTCreate an outbound Contact Center campaign.
Delete a campaign contact list's custom fielddeleteACampaignCustomFieldDELETEDelete a custom field in a campaign contact list.
Delete an outbound campaigndeleteOutboundCampaignDELETEDelete a Contact Center's outbound campaign.
Get a campaign contact listgetCampaignContactListGETGet a campaign contact list.
Get a campaign contact list's contactgetCampaignContactListContactGETGet a contact on a campaign contact list.
Get a campaign contact list's custom fieldgetACampaignContactCustomFieldGETRetrieve information about a campaign contact list custom field.
Get an outbound campaigngetOutboundCampaignGETGet a Contact Center outbound campaign.
Insert a batch of contacts into a campaign contact listInsertabatchofcontactstoacampaigncontactlistPOSTBatch insert contacts into a campaign contact list.
List a campaign contact list's contactslistCampaignContactListContactsGETList contacts on a campaign contact list.
List a campaign contact's custom fieldslistCampaignContactCustomFieldsGETRetrieve all custom fields associated with a contact.
List campaign contact listslistCampaignContactListsGETList campaign contact lists.
List campaign contact lists' custom fieldslistCampaignCustomFieldsGETRetrieve all custom fields defined for campaign contact lists.
List campaign DNC phone numberslistCampaignDncListPhonesGETList phone numbers on a campaign DNC (Do Not Call) list.
List outbound campaignslistOutboundCampaignsGETList Contact Center outbound campaigns.
Remove a campaign contact listdeleteCampaignContactListDELETEDelete a campaign contact list
Remove campaign contact list's contactdeleteCampaigncontactListContactDELETERemove a contact by ID from a campaign contact list.
Update a batch of contacts on a campaign contact listUpdateabatchofcontactsonacampaigncontactlistPATCHBatch update contacts on a campaign contact list.
Update a campaign contact listupdateCampaignContactListPATCHUpdate a campaign contact list
Update a campaign contact list's custom fieldupdateACampaignCustomFieldPATCHUpdate details of a campaign contact list's custom field.
Update an outbound campaignupdateOutboundCampaignPATCHUpdate an outbound Contact Center campaign.
Update an outbound campaign statusUpdateanoutboundcampaignstatusPATCHUpdate an outbound campaign status.
Update contact on a campaign contact listupdateCampaignContactListContactPATCHUpdate a contact on a campaign contact list.
Carrier Reseller4
Activate phone numbersactiveCRPhoneNumbersPATCHUse this API to change phone number status to 'active' in a carrier reseller's master account.
Create phone numberscreateCRPhoneNumbersPOSTUse this API to add phone numbers to a carrier reseller (master) account.
Delete a phone numberdeleteCRPhoneNumberDELETEUse this API to delete or unassign a phone number from a carrier reseller account.
List phone numberslistCRPhoneNumbersGETUse this API to list phone numbers in a carrier reseller (master) account that can be pushed to its subaccounts.
Channel6
Channel actionschannelActionsPATCHPerform state transition actions on a video channel .
Create a channelcreateChannelVideoManagementPOSTCreates a channel for managing videos.
Delete channelDeleteChannelDELETEDeletes a video channel.
Get channel detailsgetChannelDetailGETReturns the details of the video channel.
List channelslistVideoChannelsGETRetrieves the list of channels.
Update channelUpdateVideoChannelVideoManagementPATCHUpdates a video channel.
Chat Channel16
Batch remove members from a channelbatchRemoveChannelMembersDELETERemoves multiple members from a chat channel in a batch.
Create a channelcreateChannelPOSTCreates a channel for a user.
Delete a channeldeleteUserLevelChannelDELETEDeletes a specific channel.
Get a channelgetUserLevelChannelGETReturns information about a specific channel.
Invite channel membersInviteUserLevelChannelMembersPOSTInvites members that are in a user's contact list to a channel.
Invite channel members (Groups)inviteChannelMembersGroupsPOSTAdds members and groups to a channel.
Join a channeljoinChannelPOSTJoins a channel that is open for anyone in the same organization to join.
Leave a channelleaveChannelDELETELeaves a specific channel.
List channel activity logslistAllChannelActivityLogsGETReturns a list of a channel's activity logs.
List channel memberslistUserLevelChannelMembersGETLists all members of a channel.
List channel members (Groups)listChannelMembersGroupsGETReturns a list of channel member groups.
List user's channelsgetChannelsGETGenerates a list of user's chat channels.
Perform operations on channelsPerformOperationsOnChannelsPATCHPerforms different operations on channels.
Remove a memberremoveAUserLevelChannelMemberDELETERemoves a member from a chat channel.
Remove a member (group)removeAMemberGroupDELETERemoves a group from a chat channel.
Update a channelupdateUserLevelChannelPATCHUpdate the name, type, and settings of a specific channel you own or administer.
Chat Channel Mention Group7
Add channel members to a mention groupaddAChannelMembersToMentionGroupPOSTAdds the channel members to a mention group.
Create a channel mention groupcreateChannelMentionGroupPOSTCreates a channel mention group.
Delete a channel mention groupdeleteAChannelMentionGroupDELETERemoves a mention group in a channel.
List channel mention groupsgetChannelMentionGroupGETReturns a list of all the mention groups in a channel.
List the members of a mention grouplistTheMembersOfMentionGroupGETReturns a list of the members in the mention group.
Remove channel mention group membersremoveChannelMentionGroupMembersDELETERemoves a mention group in channel.
Update a channel mention group informationupdateChannelMentionGroupPATCHUpdates a mention group's information.
Chat Channels (Account Level)17
Assign a new channel ownerreassignChannelOwnerPATCHChange the owner of a chat channel to another member within that channel.
Batch delete channelsbatchDeleteChannelsAccountLevelDELETEDelete channels in batches.
Batch demote channel administratorsbatchDemoteChannelAdministratorsDELETEDemotes administrators in a channel in batch.
Batch remove members from a user's channelbatchRemoveUserChannelMembersDELETERemoves multiple members from a user's chat channel in a batch.
Delete a channeldeleteChannelDELETEDeletes a specific channel.
Get a channelgetChannelGETReturns information about a specific channel.
Get retention policy of a channelgetChannelRetentionGETReturns the retention policy of a channel.
Invite channel membersinviteChannelMembersPOSTInvites members that are in a user's contact list to a channel.
List account's public channelsgetAccountChannelsGETLists public chat channels that the account's users create.
List channel activity logslistChannelActivityLogsGETReturns a list of a channel's activity logs.
List channel administratorslistChannelAdministratorsGETLists all administrators of a channel.
List channel memberslistChannelMembersGETReturns a list of all members of a channel.
Promote channel members to administratorspromoteChannelMembersAsAdminPOSTPromotes members to an administrator role in a channel.
Remove a memberremoveAChannelMemberDELETERemoves a member from a chat channel.
Search user's or account's channelssearchChannelsPOSTSearches user's or account's chat channels.
Update a channelupdateChannelPATCHUpdates the name, type, and settings of a specific channel that the user owns or administers.
Update retention policy of a channelupdateChannelRetentionPATCHUpdates the retention policy of a channel.
Chat Emoji3
Add a custom emojiaddACustomEmojiPOSTAdd a custom emoji.
Delete a custom emojiDeleteCustomEmojiDELETEDelete a custom emoji by fileId .
List custom emojislistCustomEmojisGETQueries the custom emojis list.
Chat File4
Delete a chat filedeleteChatFileDELETEDeletes a chat file.
Get file infogetFileInfoGETReturns information about the chat file.
Send a chat filesendChatFilePOSTSends 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 fileuploadAChatFilePOSTUploads a file to chat.
Chat Message15
Add or remove a bookmarkaddOrRemoveABookmarkPATCHAdds a bookmark to a message or removes the bookmark from a message.
Delete a messagedeleteChatMessageDELETEDeletes a chat message previously sent to a contact or a channel.
Delete a scheduled messagedeleteScheduleMessageDELETEDeletes a scheduled message.
Get a forwarded messagegetForwardedMessageGETReturns a chat message previously sent to a contact or a channel.
Get a messagegetChatMessageGETReturns a chat message previously sent to a contact or a channel.
List bookmarksfetchBookmarksGETReturns the bookmarks for a given channel, 1:1 conversation, or across all of the sessions
List pinned history messages of channellistChannelPinnedMessagesGETReturns a list of pinned history messages of channel.
List scheduled messageslistScheduledMessagesGETReturns a list of scheduled messages.
List user's chat messagesgetChatMessagesGETReturns a list of chat messages and shared files between a user and an individual contact, or a chat channel.
Mark message read or unreadmarkMessagePATCHMarks a chat message as read or unread.
Perform operations on the message of channelPerformMessageOfChannelPATCHPerforms different operations, such as pin or unpin, on the message of channel.
React to a chat messagereactMessagePATCHAdds or removes an emoji to a chat message.
Retrieve a threadretrieveThreadGETRetrieves all messages under a thread.
Send a chat messagesendaChatMessagePOSTSends chat messages to a user in your contact list or to a channel of which you are a member.
Update a messageeditMessagePUTEdits a chat message that you previously sent to either a contact or a channel in Zoom.
Chat Migration9
Get migrated Zoom channel IDsgetMigrationChannelsMappingGETReturns Zoom channel IDs by their corresponding migrated channel IDs.
Get migrated Zoom user IDsgetMigrationUsersMappingGETReturns Zoom user IDs by their corresponding migrated user IDs.
Migrate 1:1 conversation or channel operationsMigrate1_1ConversationOrChannelOperationsPOSTPerforms operations on migrated 1:1 conversations or channels.
Migrate a channel tabMigrateAChannelTabPOSTMigrate a web link tab to a Zoom Team Chat channel.
Migrate a chat channelMigrateAChatChannelPOSTMigrates a chat channel.
Migrate a shared spaceMigrateASharedSpacePOSTMigrates a shared space.
Migrate channel membersMigrateChannelMembersPOSTAdds a maximum of 20 members to a migrated chat channel.
Migrate chat message reactionsMigrateChatMessageReactionsPOSTAdds emoji reactions to a migrated chat message.
Migrate chat messagesMigrateChatMessagesPOSTAdds a maximum of 20 messages to migrated 1:1 conversations or channels.
Chat Reminder3
Create a reminder messagecreateReminderForMessagePOSTCreates a reminder for a person or a chat channel.
Delete a reminder for a messagedeleteReminderForMessageDELETEDeletes a reminder.
List reminderslistRemindersGETReturns a list reminders for a person or a chat channel.
Chat Session2
List a user's chat sessionsgetChatSessionsGETRetrieves a user's chat sessions.
Star or unstar a channel or contact userstarUnstarChannelContactPATCHStars or unstars a contact or channel user.
Chatbot Message4
Delete a Chatbot messagedeleteAChatbotMessageDELETEDeletes a message from your Chatbot app.
Edit a Chatbot messageeditChatbotMessagePUTUse this API to edit a message sent by your Chatbot app.
Link UnfurlsunfurlingLinkPOSTUnfurls a link with your Marketplace Chat app.
Send Chatbot messagessendchatbotPOSTSends messages from your Marketplace Chatbot app.
Cisco/Polycom Room5
Create a Managed RoomCreateaManagedRoomPOSTCreates a Managed Cisco/Poly Room.
Delete a managed roomDeleteamanagedroomDELETEDeletes a managed Cisco/Poly Room.
Get a Managed RoomGetaManagedRoomGETReturns the details of a managed room.
List Managed RoomsListManagedRoomsGETReturns the Managed Cisco/Polycom rooms.
Update a Managed RoomUpdateaManagedRoomPATCHUpdates the settings of a Cisco or Polycom Room.
Classification Label7
Apply classification to whiteboardApplyclassificationtowhiteboardPUTApplies or updates a classification label on a whiteboard.
Create a classification labelcreateClassificationLabelPOSTCreates a new classification label for the account.
Delete classification labeldeleteClassificationLabelDELETEDeletes an existing classification label.
Get classification labelgetClassificationLabelGETRetrieves detailed information about a specific classification label.
List classification labelslistClassificationLabelsGETRetrieves all classification labels for the account.
Remove classification from whiteboardremoveWhiteboardClassificationDELETERemoves the classification label from a whiteboard.
Update a classification labelupdateClassificationLabelPATCHUpdates an existing classification label.
Clinicalnote3
Get a Clinical NoteGetaClinicalNoteGETGets a single clinical note identified by noteId.
List clinical notesGetClinicalNoteGETRetrieves a list of clinical notes.
Update a Clinical NoteUpdateClinicalNotePATCHUpdates a clinical note associated with the noteId.
Clip3
Batch star clipsBatchstarclipsPOSTStars or unstars multiple clips in one request.
Get collaborators of a clipGetClipCollaboratorsGETReturns 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 clipsGetUserClipsGETReturns a list of clips of the current user or a list of all clips under the account.
Cloud Peering Provider Exchange5
Add peering phone numbersaddPeeringPhoneNumbersPOSTEnables provider exchange partners to add phone numbers to a Zoom account.
List peering phone numberslistPeeringPhoneNumbersGETReturns 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 providerListpeeringphonenumbersforproviderGETReturns phone numbers the carrier pushes to different customers.
Remove peering phone numbersdeletePeeringPhoneNumbersDELETERemoves the phone number from the Zoom customer account.
Update peering phone numbersupdatePeeringPhoneNumbersPATCHAllows partners to update the status or details associated with the phone numbers.
Cloud Recording23
Create a recording registrantmeetingRecordingRegistrantCreatePOSTRegister a user to gain access to On-demand cloud recordings of a previous meeting.
Delete a meeting or webinar transcriptDeleteMeetingTranscriptDELETEDelete a transcript for a meeting or webinar.
Delete a recording file for a meeting or webinarrecordingDeleteOneDELETEDelete a specific recording file from a meeting or webinar.
Delete meeting or webinar recordingsrecordingDeleteDELETEDelete all of a meeting's or webinar's recording files.
Delete session's recording filerecordingDeleteOneVideoSdkDELETEDelete a specific recording file from a session.
Delete session's recordingsrecordingDeleteVideoSdkDELETEDelete all recording files of a session.
Get a meeting or webinar recording's analytics detailsanalytics_detailsGETRetrieve a meeting or webinar recording's analytics details.
Get a meeting or webinar recording's analytics summaryanalytics_summaryGETRetrieve meeting recording's analytics summary.
Get a meeting transcriptGetMeetingTranscriptGETReturn a meeting's transcript information.
Get meeting recording settingsrecordingSettingUpdateGETRetrieve settings applied to a meeting's cloud recording.
Get meeting recordingsrecordingGetGETReturns all of a meeting's recordings.
Get registration questionsrecordingRegistrantsQuestionsGetGETRetrieve a list of questions that are displayed for users to complete when registering to view the recording of a specific meeting.
List all recordingsrecordingsListGETLists all cloud recordings for a user.
List recording registrantsmeetingRecordingRegistrantsGETGet a list of registrants of a past meeting's on-demand cloud recordings.
List recordings of an accountrecordingsListVideoSdkGETList Video SDK Cloud Recordings available on an account.
List session's recordingsrecordingGetVideoSdkGETGet all the recordings from a session instance.
Recover a single recordingrecordingStatusUpdateOnePUTRecover a single recording file from the meeting.
Recover a single recordingrecordingStatusUpdateOneVideoSdkPUTZoom allows users to recover recordings from trash for up to 30 days from the deletion date.
Recover meeting recordingsrecordingStatusUpdateMeetingsPUTRecover all deleted cloud recordings of a specific meeting.
Recover session's recordingsrecordingStatusUpdateVideoSdkPUTZoom allows users to recover recordings from trash for up to 30 days from the deletion date.
Update a registrant's statusmeetingRecordingRegistrantStatusPUTUpdate a registrant's status.
Update meeting recording settingsrecordingSettingsUpdatePATCHUpdate settings applied to a meeting's cloud recording.
Update registration questionsrecordingRegistrantQuestionUpdatePATCHUpdate registration questions for users to answer while registering to view a recording.
Co Editor2
Add or remove event co-editorscoeditoractionsPATCHAdds or removes event co-editor actions.
List coeditorsgetCoEditorsGETRetrieves the list of co-editors and their edit permissions for an event.
Collaborator13
Add collaborators for a fileAddCollaboratorsPOSTShare a file with newly added Zoom users or Zoom Team Chat channels.
Add collaborators to a taskaddTasksCollaboratorsPOSTAdd one or more collaborators to a specified task.
Get collaborators of a taskGetcollaboratorsofataskGETRetrieves all collaborators of a specified task.
Get collaborators of a whiteboardGetAWhiteboardCollaboratorGETReturns a list of a whiteboard collaborators.
List collaborators of a fileListCollaboratorsGETList collaborators of a file.
Modify a collaborator’s role on a fileModifyCollaboratorRolePATCHModify a collaborator’s role on a file.
Remove a collaborator from a fileRemoveACollaboratorDELETERemove a collaborator from a file.
Remove collaborator from taskremoveTaskCollaboratorDELETERemoves a specific collaborator from a task.
Remove the collaborator from a clipDeleteCollaboratorDELETERemoves a collaborator from a clip.
Remove the collaborator from a whiteboardDeleteAWhiteboardCollaboratorDELETERemoves a collaborator from a whiteboard.
Share a clip with new usersCreateCollaboratorPOSTCreate collaborators for a clip.
Share a whiteboard to new users or team chat channels.AddAWhiteboardCollaboratorPOSTAdd collaborators to a whiteboard.
Update whiteboard collaboratorsUpdateAWhiteboardCollaboratorPATCHUse this API to update whiteboard collaborators.
Color1
Get the color definitions for calendars and eventsGetcolorGETReturns the color definitions for calendars and events.
Comment5
Add a comment to a taskaddCommentPOSTAdds a comment to a specific task.
Delete a commentDeleteacommentDELETERemoves a comment from a clip.
Delete a task's commentDeleteTaskCommentDELETEDeletes a specific comment from a task by its ID.
Get a task's commentsGetAV1TasksCommentGETRetrieves all comments associated with a specific task.
List clip commentsListclipcommentsGETReturns the list of comments for a clip.
Common Area19
Add a common areaaddCommonAreaPOSTAdds an instance of a common area.
Add common area settingAddCommonAreaSettingPOSTAdds the common area setting according to the setting type.
Apply template to common areasApplyTemplatetoCommonAreasPOSTApplies a template to common areas.
Assign calling plans to a common areaassignCallingPlansToCommonAreaPOSTAssigns calling plans to a common area.
Assign phone numbers to a common areaassignPhoneNumbersToCommonAreaPOSTAssigns phone numbers to a common area.
Delete a common areadeleteCommonAreaDELETERemoves the common area.
Delete common area settingdeleteCommonAreaSettingDELETERemoves the common area subsetting from desk phones.
Generate activation codes for common areasGenerateactivationcodesforcommonareasPOSTGenerates activation codes for common areas.
Get common area call handling settinggetCommonAreaCallHandlingSettingGETReturns the call handling setting of a common area for the specified hour type.
Get common area detailsgetACommonAreaGETReturns detailed information on the common area.
Get common area settingsgetCommonAreaSettingsGETReturns common area settings.
List activation codeslistActivationCodesGETReturns a list of activation code information of the common areas under an account.
List common areaslistCommonAreasGETLists common areas under an account.
Unassign a calling plan from the common areaunassignCallingPlansFromCommonAreaDELETEUse this API to unassign a calling plan from the common area.
Unassign phone numbers from common areaunassignPhoneNumbersFromCommonAreaDELETEUnassigns a phone number from a common area.
Update common areaupdateCommonAreaPATCHUpdates the common area information.
Update common area call handling settingupdateCommonAreaCallHandlingSettingPATCHUpdate the call handling setting of a common area for the specified hour type.
Update common area pin codeUpdateCommonAreaPinCodePATCHUpdates the common area pin code.
Update common area settingUpdateCommonAreaSettingPATCHUpdates the common area setting according to the setting type.
Contact3
Get user's contact detailsgetUserContactGETReturns information on a specific contact of the Zoom user.
List user's contactsgetUserContactsGETLists all the contacts of a Zoom user.
Search company contactssearchCompanyContactsGETSearches for users that are in the company contacts of a Zoom account.
Contact Group8
Add contact group memberscontactGroupMemberAddPOSTUse this API to add members to a contact group.
Create a contact groupcontactGroupCreatePOSTUse this API to create a contact group.
Delete a contact groupcontactGroupDeleteDELETEUse this API to delete a contact group.
Get a contact groupcontactGroupGETGet a contact group under an account.
List contact group memberscontactGroupMembersGETList members in contact groups under an account.
List contact groupscontactGroupsGETList contact groups under an account.
Remove members in a contact groupcontactGroupMemberRemoveDELETERemoves members in a contact group.
Update a contact groupcontactGroupUpdatePATCHUpdate a contact group under your account.
Content3
Delete Whiteboard ContentDeleteWhiteboardContentDELETEDelete whiteboard content.
Get Whiteboard ContentGetWhiteboardContentGETGet whiteboard content.
Save Whiteboard ContentSaveWhiteboardContentPOSTSave whiteboard content.
Conversation17
Add conversation by file id or download url.AddConversationByFileIdOrDownloadUrlPOSTAdd conversation by file ID or third party download URL.
Add conversation by meeting record url or meeting UUID.addConversationByRecordPOSTAdd new conversations by meeting record URL or meeting UUID.
Add new comments to the conversationaddConversationCommentsPOSTAdd new comments to a specific conversation.
Delete conversation by conversation IDdeleteConversationByIdDELETEDelete conversation by conversation ID.
Delete conversation's commentdeleteConversationCommentByIdDELETEDelete comment from a specific conversation.
Edit conversation commenteditConversationCommentByIdPATCHEdit a comment for a specific conversation.
Get a user's playlistgetUserPlaylistsGETGet all playlists for a user.
Get conversation commentsgetConversationCommentsByIdGETGet comments for a specific conversation.
Get conversation content analysisgetConversationContentAnalysisByIdGETGet the content analysis for a specific conversation.
Get conversation informationgetConversationDetailGETGet information for a specific conversation.
Get conversation interactionsgetConversationInteractionGETGet interactions for a specific conversation.
Get conversation scorecardsgetConversationScorecardsByIdGETGet scorecards for a specific conversation.
Initiate and complete a multipart upload.InitiateAndCompleteAMultipartUploadPOSTInitiate or complete a multipart upload.
List conversationslistAllConversationsGETList all conversations.
Update conversation host idUpdateConversationhostid2NewHostidByConversationIdPATCHUpdate the conversation host id to a new host id by conversation id.
Upload IQ fileUploadZraFilePOSTUpload a file to Zoom Revenue Acclerator.
Upload iq multipart file.UploadZraMultipartFilePOSTUse this API to upload a multipart file.
Custom CRM12
Bulk import CRM accountsbulkImportAccountsPOSTBulk import CRM account objects asynchronously.
Bulk import CRM contactsbulkImportContactsPOSTBulk import CRM contact objects asynchronously.
Bulk import CRM dealsbulkImportDealsPOSTBulk import CRM deal objects asynchronously.
Bulk import CRM leadsbulkImportLeadsPOSTBulk import CRM lead objects asynchronously.
Get current CRM API registrationgetCrmRegistrationGETRetrieves the current CRM API registration information.
Get imported CRM accountsgetCrmAccountsGETRetrieve CRM account objects by their CRM IDs.
Get imported CRM contactsgetCrmContactsGETRetrieve CRM contact objects by their CRM IDs.
Get imported CRM dealsgetCrmDealsGETRetrieve CRM deal objects by their CRM IDs.
Get imported CRM leadsgetCrmLeadsGETRetrieve CRM lead objects by their CRM IDs.
Poll async task resultgetAsyncTaskGETRetrieve the execution result of asynchronous task.
Register CRM API connectionregisterCrmPOSTRegister new CRM API integration
Unregister CRM API connectionunregisterCrmDELETEUnregister the current CRM API integration.
Dashboard45
Get AI adoptionGetAIAdoptionGETGet the AI adoption summary.
Get AI KPIsGetAIROIKPIsGETGet AI key performance indicators.
Get AI usage detailsGetAIDetailsGETGet AI usage and engagement details.
Get AI usage trendGetAItrendsGETGet the AI usage and engagement trend.
Get AIC ROI KPIsgetDashboardKpisGETGet AIC ROI KPI data.
Get AIC ROI meeting summary usagedashboardMeetingSummaryUsageGETGet AIC ROI meeting summary usage data.
Get call details from call loggetCallLogMetricsDetailsGETReturns call log details of a specific call.
Get call QoSgetCallQoSGETGets the call quality of service (QoS) data for a call made or received by a Zoom phone user in the account.
Get chat metricsdashboardChatGETGet metrics for how users are utilizing Zoom Chat to send messages.
Get CRC port usagedashboardCRCGETA Cloud Room Connector allows H.323/SIP endpoints to connect to a Zoom meeting.
Get issues of Zoom RoomsdashboardIssueDetailZoomRoomGETUse this API to return information about the Zoom Rooms in an account with issues, such as disconnected hardware or bandwidth issues.
Get meeting detailsdashboardMeetingDetailGETGet details on live or past meetings.
Get meeting participant QoSdashboardMeetingParticipantQOSGETReturn the quality of service (QoS) report for participants from live or past meetings.
Get meeting quality scoresdashboardQualityGETUse this API to return meeting quality score information.
Get meeting sharing/recording detailsdashboardMeetingParticipantShareGETRetrieve the sharing and recording details of participants from live or past meetings.
Get post meeting feedbackparticipantFeedbackGETWhen a meeting ends, each attendee will be prompted to share their meeting experience by clicking either thumbs up or thumbs down.
Get post webinar feedbackparticipantWebinarFeedbackGETWhen 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 RoomsdashboardZoomRoomIssueGETGet top 25 issues of Zoom Rooms.
Get top 25 Zoom Rooms with issuesdashboardIssueZoomRoomGETGet information on top 25 Zoom Rooms with issues in a month.
Get webinar detailsdashboardWebinarDetailGETRetrieve details from live or past webinars.
Get webinar participant QoSdashboardWebinarParticipantQOSGETReturns the quality of service (QoS) for participants during live or past webinars.
Get webinar participantsdashboardWebinarParticipantsGETGet information about participants from live or past webinars.
Get webinar sharing/recording detailsdashboardWebinarParticipantShareGETRetrieve the sharing and recording details of participants from live or past webinars.
Get zoom meetings client feedbackdashboardClientFeedbackDetailGETRetrieve detailed information on a Zoom meetings client feedback.
Get Zoom Rooms detailsdashboardZoomRoomGETThe 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 logslistCallLogsMetricsGETReturns monthly call logs metrics.
List client meeting satisfactionlistMeetingSatisfactionGETIf 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 userslistUserDefaultEmergencyAddressGETReturns the users who provide a default personal emergency address rather than a default site address or default account address.
List detectable personal location userslistUserDetectablePersonalLocationGETReturns the users who created one or more detectable personal locations with associated network data.
List meeting participantsdashboardMeetingParticipantsGETReturn a list of participants from live or past meetings.
List meeting participants QoSdashboardMeetingParticipantsQOSGETShow a list of meeting participants from live or past meetings, and their quality of service received during the meeting.
List meeting participants QoS SummarydashboardMeetingParticipantsQOSSummaryGETReturns a list of meeting participants from past meetings and the summary of their quality of service received during the meeting.
List meetingsdashboardMeetingsGETLists the total live or past meetings that occurred during a specified period of time.
List nomadic emergency services userslistUserNomadicEmergencyServicesGETReturns users who have been enabled for nomadic emergency services.
List past call metricslistPastCallMetricsGETReturns all the call logs metrics of the account from the selected time period.
List real time location for IP phoneslistPhoneRealtimelocationGETReturns currently detected location of IP phones.
List real time location for userslistUserRealtimeLocationGETReturns the user's currently detected location.
List the client versionsgetClientVersionsGETUse this API to list all the client versions and its count.
List tracked locationslistTrackedLocationsGETLists the tracked locations.
List users permission for location sharinglistUserLocationSharingPermissionGETReturns users that have enabled location services and allowed location sharing with Zoom applications on client devices.
List webinar participant QoSdashboardWebinarParticipantsQOSGETShow a list of webinar participants from live or past webinars and the quality of service they received during the webinar.
List webinar participants QoS SummarydashboardWebinarParticipantsQOSSummaryGETUse 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 webinarsdashboardWebinarsGETLists all the live or past webinars from a specified period of time.
List Zoom meetings client feedbackdashboardClientFeedbackGETUse this API to return Zoom meetings client feedback survey results.
List Zoom RoomsdashboardZoomRoomsGETList information on all Zoom Rooms in an account.
Data Request5
Cancel data deletion requestCancelDataRequestDELETECancel a pending data request with ID requestId.
Create data (export/deletion) requestCreateDataAccessRequestPOSTSubmit a request to: Export data for a specified time period.
Get download link for data access request fileDownloadfilesfromDataRequestGETReturns download link for given fileId.
List data request historyGetDataRequestsHistoryGETLists all data requests for account.
List downloadable files for export data requestGetDownloadableFilesforDataRequestGETFetches downloadable file information from an individual data request
DataTable Content2
Delete a columnDeleteacolumnDELETEDelete a column from a table.
Delete rowsDeleterowsDELETEBatch delete rows.
Deal4
Delete activity from the dealDeleteActivityFromDealDELETEDelete specific activity from a deal.
Get deal activitiesgeAllActivitiesFromDealGETGet activities for a specific deal.
Get deal informationgetDealDetailGETGet information for a specific deal.
List dealslistAllDealsGETList all deals.
Deal Registration5
Creates a new deal registration for a partnercreateDealRegPOSTCreates a new Deal Registration for a partner.
Get details of a deal registration by registration numbergetDealRegDetailsGETRetrieve details for a deal registration by the deal registration number.
Gets all valid Deal Registrations for a partnergetAllDealRegsGETRetrieves all valid deal registrations for a partner.
Retrieves all valid Zoom Campaigns which a deal registrationgetCampaignsGETRetrieves all valid Zoom Campaigns which a deal registration can be associated with.
Updates an existing deal registrationUpdatesanexistingdealregistrationPATCHUpdates an existing deal registration that has been returned (Deal status = returned).
Device13
Add a new deviceaddDevicePOSTAdd a new device to Zoom account.
Assign a device to a groupassginGroupPATCHAssign a device to a new group.
Assign a device to a user or commonareaAssigndevicetoauser_commonareaPOSTAssign a device to a user or common area, or move a device to another user or common area, or remove a device.
Change deviceupdateDevicePATCHChange device name.
Change device associationchangeDeviceAssociationPATCHChange a device's association from one Zoom Room to another.
Delete devicedeleteDeviceMeetingsDELETEDelete a device from a Zoom account.
Delete ZPA device by vendor and mac addressDeleteZpaDeviceByVendorAndMacAddressDELETERemove a ZPA device from the device manager, by vendor and mac address.
Get device detailgetDeviceGETRetrieve a device's details.
Get ZDM group infoGetzdmgroupinfoGETGet Zoom Device Manager (ZDM) group information for an account.
Get Zoom Phone Appliance settings by user IDGetZpaDeviceListProfileSettingOfaUserGETGet a user's Zoom Phone Appliance (ZPA) device profile settings.
Get ZPA version infoGetZpaVersioninfoGETGet ZPA firmware and app version information that can be upgraded for devices.
List deviceslistDevicesGETThis API lets you list devices.
Upgrade ZPA firmware or appUpgradeZpas_appPOSTUpgrade ZPA firmware or app by Zoom Device Manager (ZDM) group ID.
Device Line Key2
Batch update device line key positionbatchUpdateDeviceLineKeySettingPATCHUse this API to batch update the Zoom Phone device line key position information.
Get device line keys informationlistDeviceLineKeySettingGETUse this API to get information on the Zoom Phone device line keys settings and position.
Dial By Name Directory6
Add users to a directoryAddUsersToDirectoryPOSTUse this API to add users to a directory.
Add users to a directory of a siteAddUsersToDirectoryBySitePOSTUse this API to add users to a directory of the specified site.
Delete users from a directoryDeleteUsersFromDirectoryDELETEUse this API to delete users from the directory.
Delete users from a directory of a siteDeleteUsersFromDirectoryBySiteDELETEUse this API to delete users from a directory of the specified site.
List users in a directory by siteListUsersFromDirectoryBySiteGETUse this API to get users that are in or not in a directory of the specified site.
List users in directoryListUsersFromDirectoryGETUse this API to get users that are in or not in a directory.
Disposition10
Create a dispositioncreateDispositionPOSTCreate a new disposition.
Create a disposition setcreateSetPOSTCreate a new disposition set.
Delete a dispositiondeleteDispositionDELETEDelete an existing disposition.
Delete a disposition setdeleteSetDELETEDelete a disposition set.
Get a dispositiongetDispositionGETRetrieve information about a disposition.
Get a disposition setgetSetGETRetrieve information about a disposition set.
List disposition setslistSetsGETReturn a list of available disposition sets.
List dispositionslistDispositionsGETReturn a list of available dispositions.
Update a dispositionupdateDispositionPATCHUpdate an existing disposition.
Update a disposition setupdateSetPATCHUpdate an existing disposition set.
Division7
Assign a divisionassigndivisionMemberPOSTAssign a division to members.
Create a divisionCreateadivisionPOSTCreate a division.
Delete a divisionDeletedivisionDELETEDelete an entire division.
Get a divisionGetdivisionGETGet a division under an account.
List division memberslistDivisionMembersGETList the users of a division under your account.
List divisionslistDivisionsGETList divisions under an account.
Update a divisionUpdateadivisionPATCHUpdate a group under your account.
Doc Content4
Delete a specific blockDeleteBlockDELETEDeletes a block and all its content from the document.
Insert blocks into a documentInsertblocksintoadocumentPOSTInsert new blocks at a specific position in a document.
Replace a range of blocksReplacearangeofblocksPOSTReplace a contiguous range of sibling blocks with new blocks in a single atomic operation.
Update a specific blockUpdateBlockPATCHUpdates the content of an existing block using XML-formatted content.
Document5
Create a new whiteboardnewWhiteboardCreatePOSTCreates a new whiteboard for a user.
Delete a whiteboardDeleteAWhiteboardDELETEDeletes a whiteboard.
Get a whiteboardGetAWhiteboardGETReturns a whiteboard's information.
List all whiteboardsListWhiteboardsGETUse 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 informationUpdateAWhiteboardMetadataPUTUse this API to rename a whiteboard, update whiteboard status (locked or unlocked).
Download1
Download a clipdownloadClipGETRetrieves the download URL for a specific clip and redirects the client to that URL.
Draft6
Create a new draft emailcreate_draft_emailPOSTCreates a new draft email message.
Delete an existing draft emaildelete_draft_emailDELETEImmediately and permanently deletes the specified draft.
Get the specified draft emailget_draft_emailGETRetrieves the specified draft.
List emails from draft folderlist_draft_emailsGETLists the draft messages in the mailbox.
Send out a draft emailsend_draft_emailPOSTSends the specified draft.
Update the specified draft emailupdate_draft_emailPUTReplaces a draft email's content.
Email2
List event email typeslistEmailTypesGETGet the list of email types defined for an event.
List event emails sent statuslistEmailSentStatusesGETGet the list of email sent status for an event email type.
Emergency Address5
Add an emergency addressaddEmergencyAddressPOSTAdds an emergency address.
Delete an emergency addressdeleteEmergencyAddressDELETERemoves an emergency address.
Get emergency address detailsgetEmergencyAddressGETGets the emergency address information.
List emergency addresseslistEmergencyAddressesGETLists the emergency addresses.
Update an emergency addressupdateEmergencyAddressPATCHUpdates an emergency address information.
Emergency Service Location6
Add an emergency service locationaddLocationPOSTAdds an emergency service location.
Batch add emergency service locationsbatchAddLocationsPOSTAdds emergency service locations in batch.
Delete an emergency locationdeleteLocationDELETERemoves an emergency location.
Get emergency service location detailsgetLocationGETReturns an emergency service location's information.
List emergency service locationslistLocationsGETReturns emergency service locations.
Update emergency service locationupdateLocationPATCHUpdates an emergency location's information.
Engagement12
Get a historical engagementgetEngagementGETRetrieve details about a historical/completed engagement.
Get an engagement's attachmentsListAttachmentsGETRetrieve a list of attachments for a specified engagement.
Get an engagement's eventsgetEngagementEventsGETRetrieve information about an engagement's events.
Get an engagement's surveygetEngagementSurveyGETGet an engagement's survey
Get available transfer flowsGetAvailableTransferFlowsGETRetrieve a list of flows that are available for transfer.
Get available transfer queuesGetAvailableTransferQueuesGETReturn a list of queues that are available for transfer.
Get available transfer usersGetAvailableTransferUsersGETRetrieve a list of available transfer users.
List historical engagementslistEngagementsGETRetrieve a list of historical/completed engagements.
List open engagementslist_open_engagementsGETReturn a list of open engagements.
Poll an engagement recording's statusEngagementRecordingStatusGETPolls a video or voice engagement's recordings' status.
Start an engagementStartworkitemengagementPOSTStart an engagement.
Update an engagementupdateEngagementPATCHAllows performing an action on an engagement
Evaluation3
List automated evaluationsListAutomatedEvaluationsGETList automated evaluations.
List evaluationsListevaluationsGETList manually completed evaluations.
View evaluation detailEvaluationDetailGETView a specific interaction's evaluation detail.
Event15
Create an eventcreateEventPOSTCreates an event.
Delete an eventdeleteEventDELETEDelete a draft event.
Delete an existing event from the specified calendarDeleteeventDELETEDeletes an event.
Event actionsEventActionsPOSTUpdates the event actions that the host performs for an event.
Get an eventgetEventInfoGETReturns information on a specified event.
Get the specified event on the specified calendarGeteventGETReturns a Zcalendar event.
Import event to the specified calendarImporteventPOSTImports an event.
Insert a new event to the specified calendarInserteventPOSTCreates an event.
List all instances of the specified recurring eventInstanceeventGETReturns instances of the specified recurring event.
List eventsgetEventsGETRetrieves all events associated with the user.
List events on the specified calendarListeventGETReturns events on the specified calendar.
Move the specified event from a calendar to another specifiedMoveeventPOSTMoves an event to another calendar, such as changing an event's organizer.
Quick add an event to the specified calendarQuickaddeventPOSTCreates an event based on a simple text string.
Update an eventupdateEventPATCHUpdates an event.
Update the specified event on the specified calendarPatcheventPATCHUpdates an event.
Event Access5
Create event access linkcreateEventAccessLinkPOSTCreates an access link for an event.
Delete event access linkdeleteEventAccessLinkDELETEDeletes an event access link.
Get event access linkGetEventAccessLinkGETRetrieves event access link information.
List event access linksgetEventAccessLinksGETRetrieves a list of all the event's access links associated with the event.
Update event accessupdateEventAccessPATCHUpdates the event access for an event ID.
Exhibitor6
Create an exhibitorcreateExhibitorPOSTCreates an exhibitor for a multi-session and conference-type event.
Delete an exhibitordeleteExhibitorDELETEDeletes an exhibitor.
Get an exhibitorgetExhibitorInfoGETReturns the exhibitor information of a specified event.
List exhibitorsgetExhibitorsGETLists all exhibitors associated with an event.
List sponsor tiersListSponsorTiersGETLists all sponsor tiers associated with an event.
Update exhibitor for an eventupdateExhibitorPATCHUpdates the exhibitor for an event ID.
Export6
Create a file exportCreateafileexportPOSTCreates a export for specified file.
Create whiteboard exportCreatewhiteboardsexportPOSTGenerates the export for the provided whiteboards.
Download whiteboard exportDownloadwhiteboardexportGETUse this API to download the whiteboard export.
Get file contentGetfilecontentGETRetrieves the file name and full file content in Markdown format.
Get file export statusGetfileexportstatusGETUse this API to query the status of a file export.
Get whiteboard export generation statusGetwhiteboardexportdatagenerationstatusGETUse this API to query the status of the whiteboard export generation.
External Contact5
Add an external contactaddExternalContactPOSTAdds an external contact.
Delete an external contactdeleteAExternalContactDELETERemoves an external contact.
Get external contact detailsgetAExternalContactGETReturns an external contact's information.
List external contactslistExternalContactsGETLists the external contacts.
Update external contactupdateExternalContactPATCHUpdates an external contact's information.
Fax8
Delete fax logDeleteFaxLogDELETEDeletes a specific fax log.
Download fax fileDownloadfaxfileGETDownloads the fax file.
Get account's fax logsGetAccount_sFaxLogsGETReturns the account's fax logs.
Get extension's fax logsGetuser_sfaxlogsGETReturns the extension's fax logs.
Get fax log detailsGetFaxLogDetailsGETReturns the fax log's details.
Send faxSendEFaxPOSTSends a fax to receivers.
Update fax log read statusUpdateFaxLogReadStatusPATCHUpdates the read status of a specific fax log.
Upload fax fileUploadFaxFilesPOSTUploads fax file
File8
Download Imported Whiteboard FileDownloadembeddedwhiteboardfileGETDownload files imported into the whiteboard, including images, PDFs, DOCX, and other supported formats.
Initiate and complete the multipart file uploadinitiateAndCompleteAEventMultipartUploadPOSTUploads 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 fileuploadAFilePOSTUpload a file.
Upload a file in tasksUploadfilefortasksimportPOSTUploads a file to tasks.
Upload events fileuploadEventFilePOSTUploads files to Zoom Webinars Plus & Events.
Upload events multipart filesuploadMultipartEventFilePOSTUploads a multipart file.
Upload file for video managementuploadFileToVideoMgmtPOSTUploads a file to Zoom Video Management and returns a file id that can be used in subsequent resource requests.
Upload file for whiteboard importUploadfileforwhiteboardimportPOSTUploads a file to whiteboard.
File Management7
Create a new fileCreateDocPOSTCreates a new file for a user.
Delete a fileDeleteFileDELETEDelete a file.
Get metadata of a fileQueryFileMetadataGETGet metadata of a file.
Get user My docs infoGetUserMyDocsIDGETGet the specified user's My docs info.
List all children of a fileListAllChildrenGETList all children of a file.
Modify metadata of a fileModifyMetadataPATCHModify metadata of a file.
Transfer ownership of a fileTransferOwnershipOfAFilePUTTransfer a file’s ownership to another user.
File Upload1
Create file upload for docs import or attachmentsUploadfilefordocsimportorattachmentsPOSTCreate a file upload for document import or attachments.
Filter Group1
List filter groupsListfiltergroupsGETGet all filter groups
Firmware Update Rule6
Add a firmware update ruleAddFirmwareRulePOSTUse this API to add a firmware update rule.
Delete firmware update ruleDeleteFirmwareUpdateRuleDELETEUse this API to delete the firmware update rule.
Get firmware update rule informationGetFirmwareRuleDetailGETUse this API to get the firmware update rule information.
List firmware update rulesListFirmwareRulesGETUse this API to get firmware update rules.
List updatable firmwaresListFirmwaresGETUse this API to get updatable firmwares.
Update firmware update ruleUpdateFirmwareRulePATCHUse this API to update a specific firmware update rule.
Flow11
Add flow entry pointsAddFlowEntryPointsPOSTAdd entry points to a flow.
Delete a flowDeleteFlowDELETEDelete a flow.
Edit a flowEditFlowPATCHEdit a flow's attributes.
Export a flowExportFlowGETExport a flow's content as JSON.
Get a flowgetAFlowGETGet information about a flow.
Import a flowImportFlowPOSTImport and create a flow, using content from another flow's exported JSON.
List entry pointsListentryPointsGETRetrieve a list of entry points.
List flow's entry pointsListFlowEntryPointsGETRetrieve a list of the entry points bound to the current flow.
List flowslistFlowsGETReturn a list of flows.
Publish a flowPublishFlowPUTPublish a flow version.
Remove flow entry pointsRemoveFlowEntryPointsDELETERemove entry points from a flow.
Follow Up Task3
Get a follow-up taskengagementFollowUpTaskGetGETReturns a single follow-up task by engagement and task ID.
List engagement follow-up tasksengagementFollowUpTasksBatchListGETReturns a list of follow-up tasks under an engagement.
Update a follow-up taskengagementFollowUpTaskPatchPATCHUpdates a single follow-up task.
Forecast2
Get a forecast for a scheduling groupGetforecastofschedulinggroupGETList forecasted values for a scheduling group within a forecast.
List forecastsListforecastsGETList forecasts.
Freebusy1
Query freebusy information for a set of calendarsQueryfreebusyPOSTReturns free or busy information for a set of calendars.
General Access2
Get the general access setting of a fileGetFileGeneralAccessGETGet the general access settings of a file.
Modify the general access setting of a fileModifyFileGeneralAccessPATCHModify the general access setting for a file.
Group29
Add group adminsgroupAdminsCreatePOSTUse this API to add administrators to a group under your account.
Add group membersgroupMembersCreatePOSTUse this API to add users to a group in your account.
Create a groupgroupCreatePOSTUse this API to create a group.
Create a groupgroupScim2CreatePOSTCreate a new group.
Delete a groupgroupDeleteDELETEDelete an entire group.
Delete a groupgroupSCIM2DeleteDELETEDelete a group.
Delete a group admingroupAdminsDeleteDELETEUse this API to remove a group administrator in a Zoom account.
Delete a group membergroupMembersDeleteDELETEUse this API to remove a user from a group in an account.
Delete Virtual Background filesdelGroupVBDELETEUse this API to delete a group's Virtual Background files.
Get a groupgroupGETGet a group under an account.
Get a groupgroupSCIM2GetGETGet the specific group's information.
Get a group's settingsgetGroupSettingsGETGet settings for a group.
Get a group's webinar registration settingsgroupSettingsRegistrationGETGet webinar registration settings for a group.
Get group phone settingsgetGroupPhoneSettingsGETReturns group phone settings.
Get group policy detailsGetGroupPolicyDetailsGETReturns the group policy details.
Get locked settingsgetGroupLockSettingsGETRetrieve a group's locked settings.
List group adminsgroupAdminsGETUse this API to return a list of group administrators under your account.
List group channelsgroupChannelsGETReturns a list of channels for a group under your account.
List group membersgroupMembersGETList the members of a group under your account.
List groupsgroupSCIM2ListGETList all groups.
List groupsgroupsGETList groups under an account.
Update a groupgroupSCIM2UpdatePATCHUpdate group information and manage its members, including adding, removing, and replacing members.
Update a groupgroupUpdatePATCHUpdate a group under your account.
Update a group memberupdateAGroupMemberPATCHUse 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 settingsupdateGroupSettingsPATCHUpdate settings for a group.
Update a group's webinar registration settingsgroupSettingsRegistrationUpdatePATCHUpdate 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 policyupdateGroupPolicyPATCHUpdates the group policy.
Update locked settingsgroupLockedSettingsPATCHUpdate a group's locked settings.
Upload Virtual Background filesuploadGroupVBPOSTUse this API to upload Virtual Background files for all users in a group to use.
Group Call Pickup8
Add a group call pickup objectaddGCPPOSTUse 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 groupaddGCPMembersPOSTUse this API to add members to the specified Group Call Pickup object.
Delete group call pickup objectsdeleteGCPDELETEUse this API to remove a Group Call Pickup object.
Get call pickup group by IDGetGCPGETUse this API to retrieve information on a specific Group Call Pickup object in an account.
List call pickup group memberslistGCPMembersGETUse this API to retrieve members of a call pickup group in an account.
List group call pickup objectslistGCPGETUse this API to retrieve a list of Group Call Pickup objects in an account.
Remove members from call pickup groupremoveGCPMembersDELETEUse this API to remove member from the Group Call Pickup object.
Update the group call pickup informationupdateGCPPATCHUse this API to update a specific Group Call Pickup object information.
H323 Device4
Create a H.323/SIP devicedeviceCreatePOST
Delete a H.323/SIP devicedeviceDeleteDELETE
List H.323/SIP devicesdeviceListGET
Update a H.323/SIP devicedeviceUpdatePATCHEdit information for a H.323/SIP device from your Zoom account.
History1
List history of events for mailboxlist_mailbox_historyGETLists the history of the changes to the given mailbox.
Hub5
Creates a new hub hostcreateHubHostPOSTAdd a host to the hub.
List hub HostsgethubhostListGETRetrieves a list of hub hosts.
List hub videosListHubVideosGETLists the video/recording resources of a hub.
List hubsgetHubListGETRetrieves a list of event hubs.
Remove hub hostdeleteHubHostDELETEDelete a host from the hub.
IM Chat1
Send IM messagessendimmessagesPOSTSends the chat message to a user.
IM Group8
Add IM directory group membersimGroupMembersCreatePOSTAdd members to an IM directory group under an account.
Create an IM directory groupimGroupCreatePOSTCreate an IM directory group under your account.
Delete an IM directory groupimGroupDeleteDELETEDeletes an IM directory group under your account.
Delete IM directory group memberimGroupMembersDeleteDELETEDelete a member from an IM directory group under an account.
List IM directory group membersimGroupMembersGETLists the members of an IM directory group.
List IM directory groupsimGroupsGETLists IM directory groups.
Retrieve an IM directory groupimGroupGETRetrieves an IM directory group under your account.
Update an IM directory groupimGroupUpdatePATCHUpdates an IM directory group under your account.
Import12
Create a new file by importCreateanewfilebyimportPOSTCreates a new file from a file upload.
Create a new file from contentcreateNewFileWithMarkdownPOSTCreates a new doc from Markdown content.
Create a new whiteboard by importCreateWhiteboardImportPOSTCreates a new whiteboard for a user by converting Miro, Mural, or Visio files.
Delete historical agent statusdeleteHistoricalAgentStatusDELETEDelete historical agent status events for a user within a specified time range (start time inclusive, end time exclusive).
Get file import statusGetdocsfileimportstatusGETUse this API to query the status of a new file by import.
Get historical queue metrics import metadataViewhistoricalqueuemetricimoprtmetaGETRetrieve a list of historical queue metrics import metadata.
Get import job statusgetTasksImportJobGETRetrieve an import job's current status and results.
Get whiteboard import statusGetWhiteboardimportstatusGETUse this API to query the status of new whiteboard by import.
Submit a task import jobsubmitTasksImportJobPOSTSubmit an asynchronous import job to import tasks from an external platform into Zoom Tasks.
Upload forecast staffingUploadStaffingPOSTImport interval-level staffing into Zoom Workforce Management (WFM) by uploading a CSV file and creating an imported staffing forecast.
Upload historical agent statusuploadHistoricalAgentStatusPOSTImport external historical agent status change events into WFM for adherence reporting.
Upload historical queue metricsUploadhistoricalqueuemetricsPOSTImport historical queue metrics to Workforce Management (WFM).
In Meeting App2
Add a meeting appmeetingAppAddPOSTAdd an auto-open app in a meeting.
Delete a meeting appmeetingAppDeleteDELETEDelete a meeting auto-open app.
In Meeting Feature5
Delete a live meeting messagedeleteMeetingChatMessageByIdDELETEDelete a message in a live meeting, based on ID.
Get a meeting's join token for local recordingmeetingLocalRecordingJoinTokenGETGet a meeting's join token to allow for local recording.
Get meeting's tokenmeetingTokenGETGet a meeting's closed caption token (caption URL).
In-meeting controlsinMeetingRecordingControlPATCHIn-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 messageupdateMeetingChatMessageByIdPATCHUpdate a message in a live meeting, based on ID.
Inbound Blocked List10
Add an account's inbound block ruleAddAccountLevelInboundBlockRulesPOSTAdds an account level block rule for inbound calls and messaging from a phone number.
Add an extension's inbound block ruleAddExtensiontLevelInboundBlockRulesPOSTAdds the given extension's block rule for inbound calls and messaging.
Delete an account's inbound block ruleDeleteAccountLevelInboundBlockRulesDELETEDeletes the account level blocked rule for inbound calls and messaging.
Delete an account's inbound blocked statisticsDeleteAccountLevelInboundBlockedStatisticsDELETEDeletes the statistic of extensions blocked rule for inbound calls and messaging.
Delete an extension's inbound block ruleDeleteExtensiontLevelInboundBlockRulesDELETEDeletes the given extension's blocked rule for inbound calls and messaging.
List an account's inbound block rulesListAccountLevelInboundBlockRulesGETReturns a list of account level inbound block rule for inbound calls and messaging.
List an account's inbound blocked statisticsListAccountLevelInboundBlockedStatisticsGETReturns the list of the statistics of the extensions blocked rule for inbound calls and messaging.
List an extension's inbound block rulesListExtensionLevelInboundBlockRulesGETReturns a list of the given extension's block rule for inbound calls and messaging.
Mark a phone number as blocked for all extensionsMarkPhoneNumberAsBlockedForAllExtensionsPATCHPromotes and applies the phone number blocked from the extension level blocked rule to the account level blocked rule.
Update an account's inbound block ruleUpdateAccountLevelInboundBlockRulePATCHUpdates the account level block rule for inbound calls and messaging.
Inbox18
Assign inbox access queuesassignInboxQueuesPOSTAssign queues access to an inbox.
Assign inbox access usersassignInboxUsersPOSTAssign users to a Contact Center inbox.
Create an inboxinboxCreatePOSTCreate a new inbox.
Delete an inbox messageinboxMessageDeleteDELETEDelete a single message in an inbox.
Delete an inbox's messagesinboxMessagesDeleteDELETEDelete messages in an inbox.
Delete inbox messagesinboxesMessagesDeleteDELETEDelete messages.
Delete inboxesinboxesDeleteDELETEDelete one or more inboxes.
Get an inboxgetInboxGETRetrieve an inbox.
Get an inbox email notification listGetinboxemailnotificationlistGETRetrieve a list of inbox email notifications.
Get inbox access queueslistInboxQueuesGETRetrieve a list of queues that have access to an inbox.
List an account's inbox messageslistInboxesMessagesGETReturn all messages in an inbox.
List an inbox's messageslistInboxMessagesGETReturn a list of all messages in an inbox.
List inbox userslistInboxUsersGETRetrieve a list of users assigned to an inbox.
List inboxeslistInboxGETReturn a list of inboxes.
Remove inbox access queuesunassignInboxQueuesDELETERemove queues' access to an inbox.
Unassign inbox access usersunassignInboxUsersDELETERemove users' access to an inbox.
Update an inboxinboxUpdatePATCHUpdate an inbox.
Update an inbox's email notification settingUpdateaninboxemailnotificationPATCHUpdate an inbox's email notification setting for a given user.
Information Barrier5
Create an Information Barrier policyInformationBarriersCreatePOSTCreate a new Information Barrier policy.
Get an Information Barrier policy by IDInformationBarriersGetGETReturn an Information Barriers policy by its ID.
List information Barrier policiesInformationBarriersListGETReturn a list of all Information Barriers policies and their information.
Remove an Information Barrier policyInformationBarriersDeleteDELETERemove an Information Barrier policy.
Update an Information Barriers policyInformationBarriersUpdatePATCHUpdate an Information Barriers policy.
Insight1
Get attendee engagement datagetAttendeeEngagementGETRetrieves engagement data for a specific attendee in a Zoom Events hub.
Interaction3
Add an interactionAddinteractionPOSTAdd an interaction by a third party download URL.
List interactionsListInteractionsGETList interactions.
View interaction detailInteractionDetailGETView the details of a specific interaction.
Invitation1
Send new contact invitationsendNewContactInvitationPOSTSends a new contact invitation.
Invitation & Registration10
Add a meeting registrantmeetingRegistrantCreatePOSTCreate and submit a user's registration to a meeting.
Create a meeting's invite linksmeetingInviteLinksCreatePOSTCreate a batch of invitation links for a meeting.
Delete a meeting registrantmeetingregistrantdeleteDELETEDelete a meeting registrant.
Get a meeting registrantmeetingRegistrantGetGETRetrieve details on a specific user who has registered for the meeting.
Get meeting invitationmeetingInvitationGETRetrieve the meeting invitation note for a specific meeting.
List meeting registrantsmeetingRegistrantsGETList users that have registered for a meeting.
List registration questionsmeetingRegistrantsQuestionsGetGETList registration questions that will be displayed to users while registering for a meeting.
Perform batch registrationaddBatchRegistrantsPOSTRegister up to 30 registrants at once for a meeting that requires registration.
Update registrant's statusmeetingRegistrantStatusPUTUpdate a meeting registrant's status by either approving, cancelling or denying a registrant from joining the meeting.
Update registration questionsmeetingRegistrantQuestionUpdatePATCHUpdate registration questions that will be displayed to users while registering for a meeting.
IVR2
Get auto receptionist IVRgetAutoReceptionistIVRGETReturns an interactive voice response (IVR) system of the specified auto receptionist.
Update auto receptionist IVRupdateAutoReceptionistIVRPATCHUpdates the interactive voice response (IVR) system of the specified auto receptionist.
Knowledge Management7
Create articleCreateArticlePOSTCreates a knowledge base article.
Create sync requestCreateSyncRequestPOSTCreates a sync request for the specified knowledge base
Delete articleDeleteArticleDELETEDeletes a knowledge base article.
Get articleGetArticleGETReturns a knowledge base article.
Get articlesGetArticlesGETReturns multiple knowledge base articles.
Get syncGetSyncGETReturns the details of a knowledge base sync.
Update articleUpdateArticlePUTUpdates a knowledge base article.
Label6
Create a new label in mailboxcreate_label_in_mailboxPOSTCreates a new label.
Delete an existing label from mailboxdelete_label_from_mailboxDELETEImmediately 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_mailboxGETRetrieves the specified label.
List labels in the mailboxlist_labels_in_mailboxGETLists all labels in the mailbox.
Patch the specified label in mailboxpatch_label_in_mailboxPATCHPatch the specified label.
Update the specified label in mailboxupdate_label_in_mailboxPUTUpdates the specified label.
Legal Hold6
Add a legal hold matteraddLegalHoldMatterPOSTAdds a new legal hold matter.
Delete legal hold mattersdeleteLegalHoldMattersDELETEDeletes a legal hold matter.
Download legal hold files for given matterdownloadLegalHoldFilesGETDownloads a zip file.
List legal hold files by given matterlistLegalHoldFilesGETReturns a list files for given legal hold matter.
List legal hold matterslistLegalHoldMattersGETReturns a list of legal hold matters.
Update legal hold matterupdateLegalHoldMatterPATCHUpdates the name for a given legal hold matter.
Line Key3
Batch update line key position and settings informationBatchUpdateLineKeySettingPATCHUse this API to batch update the Zoom Phone line key settings information.
Delete a line key setting.DeleteLineKeyDELETEUse this API to delete the Zoom Phone line key settings information.
Get line key position and settings informationlistLineKeySettingGETUse this API to get the Zoom Phone line key settings information.
Live Streaming4
Get a meeting's join token for live streamingmeetingLiveStreamingJoinTokenGETGet a meeting's join token to allow live streaming.
Get livestream detailsgetLiveStreamDetailsGETZoom allows users to livestream a meeting to a custom platform.
Update a livestreammeetingLiveStreamUpdatePATCHUpdate a meeting's livestream information.
Update livestream statusmeetingLiveStreamStatusUpdatePATCHZoom allows users to livestream a meeting to a custom platform.
Log5
List email message historygetEmailMessageHistoryGETRetrieve the list of messages exchanged during a specific email engagement.
List message historygetMessageHistoryGETRetrieve the list of messages exchanged during a specific messaging engagement.
List SMS logslistSMSGETReturns a list of SMS engagement logs.
List voice call logslistVoiceCallGETReturn a list of voice call engagement logs.
List work item message historygetWorkItemMessageHistoryGETRetrieve the list of messages exchanged during a specific work item engagement.
Mailbox1
Get the mailbox profileget_mailbox_profileGETGet the mailbox profile.
Manifest3
Export an app manifest from an existing appgetAppManifestGETExports an app's manifest file.
Update an app by manifestupdateAppByManifestPUTUpdates an app from an app manifest
Validate an app manifestvalidatingManifestPOSTValidates an app manifest.
Meeting13
Create a meetingmeetingCreatePOSTCreates a meeting for a user.
Delete a meetingmeetingDeleteDELETEDelete a meeting.
Get a meetingmeetingGETRetrieve the given meeting's details.
Get a meeting SIP URI with passcodegetSipDialingWithPasscodePOSTGet a meeting's SIP URI.
Get past meeting detailspastMeetingDetailsGETGet information about a past meeting.
Get past meeting participantspastMeetingParticipantsGETRetrieve participant information for a past meeting.
List meetingsmeetingsGETList a meeting host user's scheduled meetings.
List past meeting instancespastMeetingsGETReturn a list of past meeting instances.
List past meetings' Q&AlistPastMeetingQAGETList Q&A of a specific meeting.
List upcoming meetingslistUpcomingMeetingGETList a Zoom user's upcoming meetings.
Update a meetingmeetingUpdatePATCHUpdates meeting details.
Update meeting statusmeetingStatusPUTUpdate the status of a meeting.
Update participant Real-Time Media Streams (RTMS) app statusmeetingRTMSStatusUpdatePATCHUpdate the Real-Time Media Streams (RTMS) status for a specific participant in an ongoing meeting.
Message10
Batch delete the specified emailsbatch_delete_emailsPOSTDeletes multiple messages specified in request body.
Batch modify the specified emailsbatch_modify_emailsPOSTModifies the labels on the specified messages.
Create a new emailcreate_emailPOSTDirectly inserts a message into this mailbox.
Delete an existing emaildelete_emailDELETEImmediately and permanently deletes the specified message.
Get the specified emailget_emailGETRetrieves the specified message.
List emails from the mailboxlist_emailsGETLists the messages in the user's mailbox.
Move the specified email out of TRASH folderuntrash_emailPOSTMoves a message out of TRASH folder.
Move the specified email to TRASH foldertrash_emailPOSTMoves the specified message to the TRASH folder.
Send out an emailsend_emailPOSTSends the specified message to the recipients as specified in the email.
Update the specified emailupdate_emailPOSTModifies the labels on the specified message.
Messages Attachment1
Get the specified attachment for an emailget_email_attachmentGETRetrieves the specified message attachment.
Messaging1
Send a messageSendaMessagePOSTSend a message via the specified messaging channel.
Monitoring Group9
Add members to a monitoring groupaddMembersPOSTUse this API to add members to a Monitoring Group.
Create a monitoring groupcreateMonitoringGroupPOSTCreates a monitoring group.
Delete a monitoring groupdeleteMonitoringGroupDELETEUse this API to delete a Monitoring Group.
Get a list of monitoring groups on an accountlistMonitoringGroupGETReturns an account's monitoring group list.
Get members of a monitoring grouplistMembersGETUse this API to return members list of a Monitoring Group.
Get monitoring group by IDgetMonitoringGroupByIdGETReturns a monitoring group for the specified ID.
Remove a member from a monitoring groupremoveMemberDELETEUse this API to remove a member from a Monitoring Group.
Remove all monitors or monitored members from a monitoring groupremoveMembersDELETEUse this API to remove all monitor or monitored members from a Monitoring Group.
Update a monitoring groupupdateMonitoringGroupPATCHUse this API to update a Monitoring Group.
My Notes Management2
Get My Notes content and transcriptDocBridgeInternalOpenAPIService_InternalOpenAPIGetMyNotesGETRetrieve a note from My Notes, including its metadata and note content.
List my notesListMyNotesByMeetingIdGETRetrieves the user's notes associated with a specific meeting.
Note4
Get a notegetNoteGETRetrieve a note.
List engagement notesengagementNotesGETReturn a list of notes under an engagement.
List notesnotesGETReturn a list of notes.
Update a notenoteUpdatePATCHUpdate a note.
Operating Hour14
Create a closure setclosuresSetCreatePOSTCreate a new closure set.
Create business hoursbusinessHourCreatePOSTCreate new business hours.
Delete a closure setclosureSetDeleteDELETEDelete closure sets.
Delete business hoursbusinessHourDeleteDELETEDelete business hours.
Get a closure setgetAClosureSetGETGet information about a closure set.
Get business hoursgetABusinessHourGETGet information about business hours.
List business hourslistBusinessHoursGETGet a list of business hours.
List closureslistClosuresGETGet a list of closures.
List the business hours' flowslistBusinessHourFlowsGETShow a list of flows using business hours.
List the business hours' queueslistBusinessHourQueuesGETShow a list of queues using business hours.
List the closures' flowslistClosureSetFlowsGETShow a list of flows using closures.
List the closures' queueslistClosureSetQueuesGETShow a list of queues using closures.
Update a closure setclosureSetUpdatePATCHUpdate information about a closure set.
Update business hoursbusinessHourUpdatePATCHUpdate business hours.
Order4
Create a subscription order for a Zoom partnercreateOrderPOSTCreate a subscription order for a Zoom partner's end customers.
Get order details by order reference IDgetOrderDetailsGETGets order details by order reference ID.
Gets all orders for a Zoom partner.getAllOrdersGETReturns all orders for a Zoom partner based on specified filters.
Preview delta order metrics and subscriptions in an ordercreateOrderPreviewPOSTPreviews the delta order metrics and subscriptions in an order.
Organizational Group5
Create an organizational groupcreateOrganizationalGroupPOSTCreate an organizational group.
Delete organizational groupdeleteOrganizationalGroupDELETEDelete an organizational group.
Get a single organizational groupgetOrganizationalGroupGETGet a single organizational group.
Get multiple organizational groupsgetMultipleOrganizationalGroupsGETGet multiple organizational groups.
Update an organizational groupupdateOrganizationalGroupPATCHUpdate an organizational group.
Outbound Calling24
Add account level outbound calling exception ruleAddAccountOutboundCallingExceptionRulePOSTAdds the account level outbound calling policy exception rule for country region.
Add common area level outbound calling exception ruleAddCommonAreaOutboundCallingExceptionRulePOSTAdds the common area level outbound calling policy exception rule for the country region.
Add site level outbound calling exception ruleAddSiteOutboundCallingExceptionRulePOSTAdds the site level outbound calling policy exception rule for the country region.
Add user level outbound calling exception ruleAddUserOutboundCallingExceptionRulePOSTAdds an user level outbound calling policy exception rule for the country region.
Delete account level outbound calling exception ruledeleteAccountOutboundCallingExceptionRuleDELETEDeletes the account level outbound calling exception rule.
Delete common area level outbound calling exception ruledeleteCommonAreaOutboundCallingExceptionRuleDELETEDeletes the common area level outbound calling exception rule.
Delete site level outbound calling exception ruledeleteSiteOutboundCallingExceptionRuleDELETEDeletes the site level outbound calling exception rule.
Delete user level outbound calling exception ruledeleteUserOutboundCallingExceptionRuleDELETEDeletes the user level outbound calling exception rule.
Get account level outbound calling countries and regionsGetAccountOutboundCallingCountriesAndRegionsGETReturns the account level outbound calling countries and regions.
Get common area level outbound calling countries and regionsGetCommonAreaOutboundCallingCountriesAndRegionsGETReturns the common area level outbound calling countries and regions.
Get site level outbound calling countries and regionsGetSiteOutboundCallingCountriesAndRegionsGETReturns the site level outbound calling countries and regions.
Get user level outbound calling countries and regionsGetUserOutboundCallingCountriesAndRegionsGETReturns the user level outbound calling countries and regions.
List account level outbound calling exception ruleslistAccountOutboundCallingExceptionRuleGETLists the account level outbound calling policy exception rules.
List common area level outbound calling exception ruleslistCommonAreaOutboundCallingExceptionRuleGETLists the common area level outbound calling policy exception rules.
List site level outbound calling exception ruleslistSiteOutboundCallingExceptionRuleGETReturns a list of site level outbound calling policy exception rules.
List user level outbound calling exception ruleslistUserOutboundCallingExceptionRuleGETReturns a list of the user level outbound calling policy exception rules.
Update account level outbound calling countries or regionsUpdateAccountOutboundCallingCountriesOrRegionsPATCHUpdates the account level outbound calling policy country or region.
Update account level outbound calling exception ruleUpdateAccountOutboundCallingExceptionRulePATCHUpdates the account level outbound calling policy for the country region exception rule.
Update common area level outbound calling countries or regionsUpdateCommonAreaOutboundCallingCountriesOrRegionsPATCHUpdates the common area level outbound calling policy country or region.
Update common area level outbound calling exception ruleUpdateCommonAreaOutboundCallingExceptionRulePATCHUpdates the common area level outbound calling policy for the country region exception rule.
Update site level outbound calling countries or regionsUpdateSiteOutboundCallingCountriesOrRegionsPATCHUpdates the site level outbound calling policy country or region.
Update site level outbound calling exception ruleUpdateSiteOutboundCallingExceptionRulePATCHUpdates the site level outbound calling policy for the country region exception rule.
Update user level outbound calling countries or regionsUpdateUserOutboundCallingCountriesOrRegionsPATCHUpdates the user level outbound calling policy country or region.
Update user level outbound calling exception ruleUpdateUserOutboundCallingExceptionRulePATCHUpdates the user level outbound calling policy for the country region exception rule.
PAC1
List a user's PAC accountsuserPACsGETRetrieve a list of a user's personal audio conference (PAC) accounts.
Participant1
Get participant identifier codeget_participant_identifier_codeGETAuthenticate CRC meetings.
Permission4
Create channel permissionscreateChannelPermissionsPOSTCreates permissions for the given channel ID.
Delete channel permissionsDeleteChannelPermissionsDELETEDelete channel permissions.
List channel permissionslistChannelPermissionsGETRetrieves the list of permissions for a channel.
Update channel permissionsupdateChannelPermissionsPATCHUpdates channel permissions.
Phone Device11
Add a deviceaddPhoneDevicePOSTAdds an unassigned desk phone or an assigned (to a user or a common area) desk phone.
Assign an entity to a deviceaddExtensionsToADevicePOSTBy default, all Zoom Phone users can make and receive calls using the Zoom desktop and mobile applications.
Delete a devicedeleteADeviceDELETERemove a desk phone device or ATA (Analog Telephone Adapter) from the Zoom Phone System Management.
Get device detailsgetADeviceGETReturns detailed information about a specific desk phone device.
List deviceslistPhoneDevicesGETLists all the desk phone devices that are configured with Zoom Phone on an account.
List SmartphonesListSmartphonesGETReturns a list of all the smartphones configured with Zoom Phone on an account.
Reboot a desk phonerebootPhoneDevicePOSTUse this API to reboot an online zero-touch or assisted-provisioning device.
Sync deskphonessyncPhoneDevicePOSTUse this API to resync all online zero-touch or assisted-provisioning devices in an account or a site.
Unassign an entity from the devicedeleteExtensionFromADeviceDELETEUse this API to unassign a specific assignee from the device.
Update a deviceupdateADevicePATCHUpdates the information of a desk phone device.
Update provision template of a deviceupdateProvisionTemplateToDevicePUTUse 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 numbersAddBYOCPhoneNumberPOSTAdds BYOC (Bring Your Own Carrier) phone numbers to Zoom Phone.
Allocate/Unallocate phone numbersAllocateNumberPATCHAllocates or unallocates phone numbers for those with CPL routing.
Assign a phone number to a userassignPhoneNumberPOSTAssigns a phone number to a user who has already enabled Zoom Phone.
Delete phone numbersDeleteNumbersDELETEDeletes phone numbers.
Get a phone numbergetPhoneNumberGETReturns information about an account's phone number.
List phone numberslistPhoneNumbersGETReturns a list of phone numbers in an account.
Unassign a phone numberUnassignPhoneNumberDELETEUnassigns Zoom Phone user's phone number.
Update a phone numberupdatePhoneNumberDetailPATCHUpdates a phone number's information.
Update a site's unassigned phone numbersupdateSiteForUnassignedPhoneNumbersPATCHUpdates a site's unassigned phone numbers.
Phone Plan2
List calling planslistCallingPlansGETReturns all of an account's Zoom Phone calling plans.
List phone number plan informationListphonenumberplaninformationGETRetrieves an account's phone number plan information, phone number usage, and availability.
Phone Role11
Add members to rolesAddRoleMembersPhonePOSTUse this API to add members to roles.
Add phone role targetsAddPhoneRoleTargetsPOSTAdds targets to phone roles.
Delete a phone roleDeletePhoneRoleDELETEUse this API to delete a phone role.
Delete members in a roleDelRoleMembersDELETEUse this API to delete member(s) in a role.
Delete phone role targetsDeletePhoneRoleTargetsDELETEDeletes the targets of a phone role.
Duplicate a phone roleDuplicatePhoneRolePOSTUse this API to duplicate a phone role.
Get role informationgetRoleInformationPhoneGETUse this API to get information on a phone role.
List members in a roleListRoleMembersGETUse this API to get members (not) in a role.
List phone role targetsListPhoneRoleTargetsGETTargets of a phone role.
List phone rolesListPhoneRolesGETReturns the phone roles.
Update a phone roleUpdatePhoneRolePATCHUse this API to update a role.
Platform3
Download a file associated with a quote or deal registration.downloadFileGETDownload a file associated with a quote or deal registration.
Gets details of all files associated with a quote or dealallFileDetailsGET
Upload an attachment pdf file in context of a deal registrationuploadFilePOST
Playlist7
Add channel playlistsAddChannelPlaylistsPOSTAdds playlists to the channel.
Create a playlistcreatePlaylistPOSTCreates a playlist for managing videos.
Delete channel playlistsDeleteChannelPlaylistsDELETERemoves playlists from the channel.
Delete playlistDeletePlaylistDELETEDeletes a playlist.
List channel playlistsListChannelPlaylistsGETRetrieves the list of playlists for the channel.
List playlistsListPlaylistsGETRetrieves the list of playlists for the user.
Update playlistUpdatePlaylistPATCHUpdate playlist.
Poll7
Create a meeting pollmeetingPollCreatePOSTPolls allow the meeting host to survey attendees.
Delete a meeting pollmeetingPollDeleteDELETEPolls allow the meeting host to survey attendees.
Get a meeting pollmeetingPollGetGETRetrieves information about a specific meeting poll.
List meeting pollsmeetingPollsGETPolls allow the meeting host to survey attendees.
List past meeting's poll resultslistPastMeetingPollsGETPolls allow the meeting host to survey attendees.
Perform batch poll creationcreateBatchPollsPOSTPolls allow the meeting host to survey attendees.
Update a meeting pollmeetingPollUpdatePUTPolls allow the meeting host to survey attendees.
Private Directory4
Add members to a private directoryaddMembersToAPrivateDirectoryPOSTAdds members to a private directory.
List private directory memberslistPrivateDirectoryMembersGETReturns the member list of a private directory.
Remove a member from a private directoryremoveAMemberFromAPrivateDirectoryDELETERemoves a member from a private directory.
Update a private directory memberupdateAPrivateDirectoryMemberPATCHUpdates a member of a private directory.
Product Catalog4
Gets the details for a Zoom product or offer.getOfferDetailGETReturns the details for a Zoom product or offer.
Gets the pricebook in a downloadable filedownloadPricebookGETReturns 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 PartnergetOffersPOSTReturns the Zoom product catalog for a Zoom Partner.
Validate offer compatibility and dependenciesvalidateOffersPOSTValidates offers against dependency rules, quantity constraints, and eligibility criteria.
Project13
Create a new projectCreateprojectPOSTThis API endpoint allows you to create a new project for a user, optionally adding collaborators and initializing it with existing whiteboards.
Create a subprojectcreateSubProjectPOSTCreates a new subproject under the specified parent project.
Delete a projectDeleteprojectDELETEThis API endpoint allows you to delete a specified project.
Get a projectGetaprojectGETRetrieves detailed information about a specific project.
Get collaborators of a projectGetcollaboratorsofaprojectGETReturns a list of a project collaborators.
List all projectsListallprojectsGETRetrieves a list of projects.
List subprojectslistSubProjectsGETRetrieves a list of all subprojects under a parent project.
Move whiteboards to a projectMovewhiteboardstoprojectPOSTThis API endpoint allows you to move one or more whiteboards to a specified project.
Remove the collaborator from a projectRemovethecollaboratorfromaprojectDELETEThis API endpoint allows you to remove a specific collaborator from a designated project.
Remove whiteboards from a projectRemovewhiteboardsfromaprojectDELETEThis API endpoint allows you to remove one or more whiteboards from a specified project.
Share a project to new usersShareaprojecttonewusersPOSTAdd new collaborators to a specified project.
Update project basic informationUpdateprojectPATCHThis API endpoint allows you to update the basic information of a specific project.
Update project collaboratorsUpdateprojectcollaboratorsPATCHUpdates 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 ProspectCreateProspectPOSTCreate and add a prospect to a call list
Create Prospects batchCreateProspectsPOSTBatch call to add prospects to a call list.
Delete ProspectDeleteProspectDELETEDelete a single prospect from a call list by its ID.
Get Prospect by IDGetProspectbyIDGETRetrieve details of a specific prospect.
List All Prospects in Call ListListAllProspectsInCallListGETRetrieve all prospects in a specific call list.
Update ProspectUpdateProspectPATCHUpdate an existing prospect.
Update Prospects batchUpdateProspectsPATCHBatch update existing prospects.
Provision Template5
Add a provision templateaddProvisionTemplatePOSTUse this API to create a provision template in a Zoom account.
Delete a provision templatedeleteProvisionTemplateDELETEUse this API to delete a provision template in a Zoom account.
Get a provision templateGetProvisionTemplateGETUse this API to get a specific provision template.
List provision templateslistAccountProvisionTemplateGETUse this API to list all provision templates in a Zoom account.
Update a provision templateupdateProvisionTemplatePATCHUse this API to update a provision template in a Zoom account.
Queue40
Assign a queue menu based interruptassignQueueMenuBasedInterruptPOSTCreate a menu of options to offer to consumers during the queue waiting experience.
Assign queue agentsassignQueueAgentsPOSTAssign users to a Contact Center queue as agent persona.
Assign queue disposition setsassignQueueDispositionSetsPOSTAdd disposition sets to a queue.
Assign queue dispositionsassignQueueDispositionsPOSTAdd dispositions to a queue.
Assign queue supervisorsassignQueueSupervisorsPOSTAssign users to a Contact Center queue as supervisor persona.
Assign queue teamsassignQueueTeamsPOSTAdd teams to a queue.
Batch create queues with a templateBatchcreatequeueswithatemplatePOSTCreate bulk of contact center queues with templateId.
Batch delete queue templatesdeleteQueueTemplatesDELETEDelete multiple Contact Center queue templates.
Batch delete queuesBatchdeletequeuesDELETEDelete Contact Center queues in bulk.
Create a queuequeueCreatePOSTCreate a queue that determines which agents handle incoming engagements - voice, video, chat, messaging, email, and other channels.
Create a queue templatecreateQueueTemplatePOSTCreate a Contact Center queue template.
Delete a queuequeueDeleteDELETEDelete a specified queue.
Delete a queue templatedeleteQueueTemplateDELETEDelete a Contact Center queue template.
Delete a queue's interrupt menu configurationdeleteQueueInterruptMenuDELETEDeletes the interrupt menu configuration for a specific queue.
Delete an attendee from a scheduled callback eventDeleteascheduledcallbackforanattendeeDELETERemove an attendee from an event slot on a scheduled callback.
Delete queue recordingsdeleteQueueRecordingsDELETEDelete all recordings in a queue.
Get a queuegetAQueueGETGet information about a queue.
Get a queue templategetQueueTemplateGETRetrieve a Contact Center queue template.
Get a queue's interrupt settingsgetQueueInterruptSettingsGETRetrieve the interrupt settings for a specific queue, including audio interrupts and notify interrupts.
Get a queue's operating hoursgetAQueueOperatingHoursGETGet information about a queue's operating hours.
List a queue's scheduled callbacks availabilityListqueuescheduledcallbacksavailabilityGETList scheduled callbacks booking slots for a scheduler set up under a queue.
List queue agentsgetQueueAgentsGETRetrieve the list of Contact Center users assigned to a queue, including their agent persona assignments for that queue.
List queue disposition setsgetQueueDispositionSetsGETReturn a list of queue's disposition sets(https://support.zoom.us/hc/en-us/articles/4470153057549-Managing-dispositions).
List queue dispositionsgetQueueDispositionsGETReturn a list of queue's dispositions.
List queue recordingslistQueueRecordingsGETReturn a list of all recordings in a queue.
List queue supervisorsgetQueueSupervisorsGETRetrieve the list of a queue's assigned Contact Center users with supervisor persona assignment to the Contact Center queue.
List queue templatesListqueuetemplatesGETRetrieve a list of queue templates.
List queueslistQueuesGETGet information about all available queues.
Schedule a callback on a queueScheduleacallbackonaqueuePOSTSchedule a callback on a queue.
Unassign a queue agentdeleteQueueAgentDELETERemove an agent from a Contact Center queue.
Unassign a queue dispositiondeleteQueueDispositionDELETEDelete a disposition from a queue.
Unassign a queue disposition setdeleteQueueDispositionSetDELETEDelete a disposition set from a queue.
Unassign a queue supervisordeleteQueueSupervisorDELETERemove a supervisor from a Contact Center queue.
Unassign a queue teamdeleteQueueTeamDELETERemove a team from a queue.
Unassign queue teamsbatchDeleteQueueTeamsDELETERemove teams from a queue.
Update a queuequeueUpdatePATCHUpdate a queue's settings.
Update a queue agent's opt-in/opt-out statusupdateQueueAgentPATCHUpdates the opt-in or opt-out status of an agent assigned to a Contact Center queue.
Update a queue templateupdateQueueTemplatePATCHUpdate a Contact Center queue template.
Update a queue's interrupt settingsupdateQueueInterruptsPATCHUpdate the interrupt settings for a voice queue.
Update a queue's operating hoursQueueOperatingHoursUpdatePATCHUpdate a queue's operating hours.
Queue Waiting Experience2
Assign a queue waiting experience interrupt menu strategyassignQueueWaitingExperienceInterruptMenuPUTCreate or replace the menu of options offered to consumers during the queue waiting experience.
Delete a queue waiting experience interrupt menu strategydeleteQueueWaitingExperienceInterruptMenuStrategyDELETERemove the interrupt menu configuration from the queue waiting experience.
Quote6
Create a subscription quote for a Zoom PartnercreateQuotePOSTCreate a subscription quote for a Zoom partner's end customers.
Get quote details by quote reference IDgetQuoteDetailsGETGet quote details by quote reference ID.
Gets all quotes for a Zoom partnergetAllQuotesGETReturns all quotes for a Zoom partner based on specified filters.
Preview delta quote metrics and subscriptions in a quotecreateQuotePreviewPOSTPreviews the delta quote metrics and subscriptions in a quote.
Submits a subscription quote for provisioningprovisionQuotePATCHSubmits a subscription quote for provisioning.
Update a subscription quote for a Zoom PartnerupdateQuotePATCHUpdate a subscription quote for a Zoom partner's end customers.
Recording12
Delete a call recordingdeleteCallRecordingDELETEDeletes a call recording.
Delete a recordingdeleteRecordingDELETEDelete a selected recording.
Delete engagement recordingsdeleteEngagementRecordingsDELETEDelete all recordings in a given engagement.
Download a phone recordingphoneDownloadRecordingFileGETDownloads the phone recording.
Download a phone recording transcriptphoneDownloadRecordingTranscriptGETDownloads the phone recording transcript.
Get a recording by call element IDgetPhoneRecordingByCallElementIdGETReturns an account's call recording by the call element's callElementId.
Get call recordingsgetPhoneRecordingsGETReturns an account's call recordings.
Get user's recordingsphoneUserRecordingsGETGets a user's Zoom Phone recordings.
List engagement recordingslistEngagementRecordingsGETReturn a list of all of an engagement's recordings.
List recordingslistRecordingsGETReturn a list of available recordings.
Update auto delete fieldUpdateAutoDeleteFieldPATCHUpdates the auto delete field for recording.
Update Recording StatusUpdateRecordingStatusPUTUpdates the status of a single recording in account.
Region7
Assign users to a regionAssignUsersToARegionPOSTAssign users to a region.
Create a regionCreateARegionPOSTCreate a new region.
Delete a regionDeleteARegionDELETEDelete a site and move its members to another region.
Get a regionGetARegionGETGet information about a region.
List a region's usersListRegion_sUsersGETRetrieve the list of a region's assigned Contact Center users.
List regionsListRegionsGETGet information about all available regions.
Update a regionUpdateARegionPATCHUpdate information for a region.
Registrant2
List registrantsgetRegistrantsGETRetrieves event registrants.
List session attendeesgetSessionAttendeeListGETRetrieves session attendees.
Report45
Get a meeting activities reportreportMeetingactivitylogsGETRetrieve a list of a meeting activity logs.
Get active or inactive host reportsreportUsersGETRetrieve a host report for a specified period of time within the last six months.
Get billing invoice reportsgetBillingInvoicesReportsGETGet department billing invoices reports for a specific billing period.
Get billing reportsgetBillingReportGETGet department billing reports of a Zoom account.
Get call charges usage reportGetCallChargesUsageReportGETRetrieves the Phone Call Charges Report.
Get chat message reportsreportChatMessagesGETReturns Zoom Chat message reports for a specified period of time.
Get chat sessions reportsreportChatSessionsGETReturns Zoom Chat session reports for a specified period of time.
Get chat transcripts reportChatTranscriptsReportGETRetrieves the chat transcripts report for an event.
Get cloud recording usage reportreportCloudRecordingGETRetrieve cloud recording usage report for a specified period.
Get custom reportgetCustomEventReportGETRetrieves data for the custom report for the given report ID.
Get daily usage reportreportDailyGETRetrieve daily report to access the account-wide usage of Zoom services for each day in a given month.
Get disclaimer reportGetdisclaimerreportGETRetrieve a list of disclaimer records.
Get event attendance (Live or Lobby) reportEventAttendanceReportGETRetrieves the event attendance (live or lobby) report for the event.
Get event registrations reportEventRegistrationsReportGETRetrieves event ticket registrations.
Get event survey reportEventSurveyReportApiGETRetrieve event and session survey information.
Get fax charges usage reportGetfaxchargesusagereportGETRetrieves the Phone Fax Charges Report.
Get history meeting and webinar listGethistorymeetingandwebinarlistGETRetrieve a list of history meetings and webinars.
Get meeting detail reportsreportMeetingDetailsGETGet a detailed report for a past meeting.
Get meeting participant reportsreportMeetingParticipantsGETReturn a report of a past meeting with two or more participants, including the host.
Get meeting poll reportsreportMeetingPollsGETUse this API to get a report of poll results for a past meeting.
Get meeting Q&A reportreportMeetingQAGETRetrieve a report on questions asked and answered by participants from past meetings.
Get meeting reportsreportMeetingsGETRetrieve report on past meetings and webinars for a specified time period.
Get meeting survey reportreportMeetingSurveyGETRetrieve a report on past meeting survey.
Get operation logs reportgetPSOperationLogsGETRetrieves the phone system operation logs report.
Get operation logs reportreportOperationLogsGETThe 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 reportGetremotesupportreportGETRetrieve a list of remote support records.
Get session attendance reportSessionAttendanceReportGETRetrieves a session attendance report.
Get sign In / sign out activity reportreportSignInSignOutActivitiesGETRetrieve a list of sign in / sign out activity logs report of users under a Zoom account.
Get SMS/MMS charges usage reportGetSMSChargesUsageReportGETRetrieves the SMS/MMS Charges Report .
Get telephone reportsreportTelephoneGETThe 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 reportreportUpcomingEventsGETUse this API to list upcoming meeting and/or webinar events within a specified period of time.
Get VOD channel registration reportVodChannelReigistrationGETRetrieves VOD channel registrations and view duration information.
Get webinar detail reportsreportWebinarDetailsGETRetrieve a report containing past webinar details.
Get webinar participant reportsreportWebinarParticipantsGETGet a detailed report on each webinar attendee.
Get webinar poll reportsreportWebinarPollsGETRetrieve a report on past webinar polls.
Get webinar Q&A reportreportWebinarQAGETRetrieve a report on questions asked by participants and answered by panelists, co-hosts and hosts from past webinars.
Get webinar survey reportreportWebinarSurveyGETRetrieve a report on past webinar survey.
Get ZVA engagementsGetZVAEngagementsGETGenerates a list of ZVA engagements.
Get ZVA query detailsGetZVAQueryDetailsGETReturns a list of ZVA engagement query details.
Get ZVA SurveysGetZVASurveysGETReturns a list of ZVA engagement surveys.
Get ZVA transcriptsGetZVATranscriptsGETGenerates a list of ZVA transcripts.
Get ZVA variable detailsGetZVAengagementvariabledetailsGETGet a list of ZVA engagement variable details.
List agents' adherence datalistAdherenceAgentsGETGet agents' adherence data.
List AI Management operation logsListAIManagementOperationLogsGETList AI Management operation logs.
List all schedule agentslistScheduleAgentsGETList all the schedule agents for the particular date and timezone
Reports V1 (Legacy)7
List agent leg reportslistAgentLegMetricGETGenerate a list of agent's leg reports.
List agent's status history reportslistAgentStatusHistoryGETGenerate a list of an agent's status history reports.
List agent's time sheet reportslistAgentTimeSheetGETGenerate a list of an agent's time sheet reports.
List historical agent reports by queuelistQueueAgentsMetricsGETGenerate detailed historical reports of agents from a specific queue.
List historical detail reportslistHistoricalDetailMetricGETRetrieve historical engagement details.
List historical queue reportslistHistoricalQueueMetricGETGenerate a list of historical queue reports.
List historical queue's agents reportslistQueueAgentMetricGETGenerate a list of a historical queue's agent reports.
Reports V2 (CX Analytics)15
Get historical custom report tabular schemagetHistoricalCustomReportTabularSchemaGETGenerate the schema information for a tabular based on the custom report after enabling API in the CX Analytics.
List historical agent performance dataset dataListhistoricalagentperformancedatasetdataGETGenerate a list of agent performance dataset raw data.
List historical agent timecard dataset dataListhistoricalagenttimecarddatasetdataGETGenerate a list of agent timecard dataset raw data.
List historical custom report tabular dataListhistoricalcustomreporttabulardataGETGenerate a list of tabular data based on the custom report after enabling the API in the CX Analytics.
List historical disposition dataset dataListhistoricaldispositiondatasetdataGETView 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 dataListengagementdatasetdataGETGenerate a list of engagement dataset raw data.
List historical engagement log dataListhistoricalengagementlogsGETRetrieve a list of all historical engagement log data.
List historical engagement timelineslistHistoricalEngagementTimelinesGETRetrieve engagement timelines, including entities and segments, for engagements in a time range.
List historical expert assist dataset dataListexpertassistdatasetdataGETDisplay expert assist dataset key metrics on the adoption of AI expert assist and its impact on key engagement measures.
List historical flow performance dataset dataListhistoricalflowperformancedatasetdataGETGenerate a list of flow performance dataset raw data.
List historical outbound dialer performance dataset dataListhistoricaloutbounddialerperformancedatasetdataGETGenerate a list of outbound dialer performance dataset raw data.
List historical queue performance dataset dataListhistoricalqueueperformancedatasetdataGETGenerate a list of queue performance dataset raw data.
List historical routing log performance dataset dataListhistoricalroutinglogperformancedatasetdataGETGenerate a list of routing log performance dataset raw data.
List historical Zoom Phone to Contact Center call journey dataListhistoricalZoomphonetozcccalljourneydataGETView the complete customer journey of a call across both Contact Center and Zoom Phone.
List operation logslistOperationLogsGETRetrieve the Zoom Contact Center management system operation logs.
Role18
Assign a roleAddRoleMembersPOSTUser roles can have a set of permissions that allows access only to the pages a user needs to view or edit.
Assign a roleassignRoleUsersPOSTUse this API to assign users to a role.
Create a rolecreateRolePOSTEach Zoom user automatically has a role which can either be owner, administrator, or member.
Create a rolecreateRoleContactCenterPOSTCreate a new role.
Delete a roledeleteRoleDELETEEach Zoom user automatically has a role which can either be owner, administrator, or a member.
Delete a roledeleteRoleContactCenterDELETEDelete a role.
Delete role privilegesDeleteroleprivilegesDELETERemoves the specified privileges from a role when given a valid role ID and privilege list.
Duplicate a roleDuplicatearolePOSTDuplicate the role specified by the original role name and assign it a new name.
Get a rolegetRoleGETGet information about a role.
Get role informationgetRoleInformationGETEach Zoom user automatically has a role which can either be owner, administrator, or member.
List members in a roleroleMembersGETUser roles can have a set of permissions that allows access only to the pages a user needs to view or edit.
List roleslistRolesGETUse this API to return a list of roles.
List rolesrolesGETList roles on your account
List users of a rolegetRoleUsersGETRetrieve a list of users assigned to a Contact Center role.
Unassign a roleroleMemberDeleteDELETEUser 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 roledeleteRoleUserDELETERemove a specific user from a Contact Center role.
Update a roleupdateRoleContactCenterPATCHUpdate a role.
Update role informationupdateRolePATCHEach Zoom user automatically has a role which can either be owner, administrator, or a member.
Room App1
Config Zoom Room Controller AppsConfigZoomRoomControllerAppsPOSTUse this API to configure Zoom Room Controller installed Zoom Apps.
Room Template5
Create a Room TemplateCreateaRoomTemplatePOSTCreates a Managed Cisco/Poly Room.
Delete a room templateDeletearoomtemplateDELETEDeletes a Managed Cisco/Poly Room Template.
Get a Room TemplateGetaRoomTemplateGETReturns the details of a Cisco/Polycom room template.
List Room TemplatesListRoomTemplatesGETReturns the Managed Cisco/Polycom rooms Templates.
Update a Room TemplateUpdateaRoomTemplatePATCHUpdates the settings of a Cisco/Polycom Room Template.
Routing Form2
get routing responseGetroutingresponseGETReturns the response submitted for a routing form.
list account routing responselist_account_routing_responseGETReturns a list of routing responses across all routing forms under the account.
Routing Profile10
Create a consumer routing profileCreateaconsumerroutingprofilePOSTCreate a consumer routing profile.
Create an agent routing profileCreateanagentroutingprofilePOSTCreate an agent routing profile.
Delete a consumer routing profileDeleteaconsumerroutingprofileDELETEDelete a consumer routing profile.
Delete an agent routing profileDeleteanagentroutingprofileDELETEDelete an agent routing profile.
Get a consumer routing profileGetaconsumerroutingprofileGETRetrieve the consumer routing profile.
Get an agent routing profilegetAgentRoutingProfileGETRetrieve the agent routing profile.
List agent routing profilesListagentroutingprofilesGETReturns a list of agent routing profiles.
List consumer routing profilesListconsumerroutingprofilesGETReturn a list of consumer routing profiles.
Update a consumer routing profile's detailsUpdateaconsumerroutingprofile_sdetailsPATCHUpdate a consumer routing profile details.
Update an agent routing profile's detailsUpdateanagentroutingprofile_sdetailsPATCHUpdate an agent routing profile details.
Routing Rule5
Add directory backup routing ruleaddRoutingRulePOSTCreates a directory backup routing rule.
Delete directory backup routing ruledeleteRoutingRuleDELETEDeletes the directory backup routing rule.
Get directory backup routing rulegetRoutingRuleGETReturns the directory backup routing rule.
List directory backup routing ruleslistRoutingRuleGETReturns a list of directory backup routing rules.
Update directory backup routing ruleupdateRoutingRulePATCHUpdates the directory backup routing rule.
RTMS1
Update engagement Real-Time Media Streams (RTMS) app statusengagementRTMSStatusUpdatePUTUpdate the RTMS status for a specific engagement.
Schedule7
Delete schedulesdelete_schedulesDELETEDeletes a schedule.
Get schedulesget_scheduleGETReturns a schedule.
Insert schedulesinsert_schedulePOSTCreates a schedule.
List all schedule agentslistSchedulesGETList the schedule agents for the particular date and timezone.
List schedule available timeslist_available_timeGETReturns available time slots for a given schedule, including day-level and spot-level availability, custom fields, recurrence rules, and scheduling segments.
List scheduleslist_schedulesGETReturns a list of all schedules.
Patch schedulespatch_schedulePATCHPatches a schedule.
Scheduled Event6
Create a booking for a schedule slotcreate_bookingPOSTBooks a time slot on an existing schedule in Zoom Scheduler.
Delete scheduled eventsdelete_scheduled_eventsDELETEDeletes a scheduled event.
Get scheduled event attendeeget_scheduled_event_attendeeGETReturns information about a specified attendee (person invited to an event).
Get scheduled eventsget_scheduled_eventsGETReturns a scheduled event.
List scheduled eventslist_scheduled_eventsGETReturns a list of all scheduled events.
Patch scheduled eventspatch_scheduled_eventsPATCHPatches a scheduled event.
ScheduleMeeting1
List scheduled meetingsListallscheduledmeetingsGETList all scheduled meetings for a user.
Scheduling Group1
List scheduling groupsListschedulinggroupsGETGet all the scheduling group name and id
Scheduling Link1
Single use linksingle_use_linkPOSTCreates a single-use scheduling link.
Scribe8
Cancel Batch JobcancelBatchJobDELETECancels a batch transcription job.
Get Batch Job StatusgetBatchJobStatusGETRetrieves job-level summary for a batch transcription job.
Get Batch Scribe Job FilegetBatchScribeJobFileGETRetrieves the processing result for a specific file within a batch Scribe transcription job.
List Batch Job FileslistBatchJobFilesGETRetrieves per-file processing status for a batch transcription job.
List Batch JobslistBatchJobsGETRetrieves a paginated list of batch transcription jobs for the authenticated tenant.
Live Scribe WebSocketliveTranscribeGETOpens a WebSocket session for real-time transcription.
Scribe (Synchronous)createFastAsrPOSTUploads a single audio file and receive transcript inline.
Submit Batch Scribe JobsubmitBatchAsrPOSTSubmits a batch transcription job for asynchronous processing.
Search1
Search filesSearchPOSTSearch for files accessible to the current user by query and filters (file types, ancestor ids, created by, owner id).
Session40
Add session reservationsAddSessionReservationsPOSTReserve a spot for a user in the given session.
Create a sessionCreateasessionPOSTCreate a Video SDK session.
Create a sessioncreateEventSessionPOSTCreates a session.
Create a stream ingestionCreateastreamingestionPOSTCreate a stream ingestion.
Create or update session interpretersupdateSessionInterpretersPUTCreates or updates the list of interpreters for the session.
Create or update session pollsupdateSessionPollsPUTCreate or update the list of polls for the session.
Delete a sessiondeleteEventSessionDELETEDeletes a session.
Delete a sessionsessionDeleteDELETEDelete a session.
Delete a stream ingestionDeleteastreamingestionDELETEDelete a stream ingestion.
Delete session reservationsDeleteSessionReservationsDELETEThis tool removes a user's reservation spot for a given session.
Get a session SIP URI with passcodeGetASessionSIPURIWithPasscodePOSTGet a live video SDK session's SIP URI.
Get a stream ingestionGetastreamingestionGETGet information about a stream ingestion.
Get session detailsGetasessionGETGet a information about live or past Cobrowse sessions.: Prerequisites: Cobrowse SDK.
Get session detailssessionDetailGETGet information about scheduled, live, or past sessions.
Get session live stream detailsgetLiveStreamDetailsVideoSdkGETUse this API to return a session's live stream configuration details, such as the stream's URL, key, and page URL.
Get session livestream configurationgetSessionLivestreamConfigurationGETList the livestream configuration for the given session.
Get session user QoSsessionUserQOSGETRetrieve the quality of service (QoS) for users from live or past sessions.
Get sharing/recording detailssessionParticipantShareGETRetrieve the sharing and recording details of participants from live or past sessions.
Get the session informationgetEventSessionInfoGETReturns the session information.
Get ticket session join token by Event ID and Session IDgetSessionJoinTokenGETRetrieves the join token to join an event session.
List live sessionsListlivesessionsGETList the total live sessions that occurred during a specified period of time.
List past sessionsListpastsessionGETList the total live or past sessions that occurred during a specified period of time.
List session interpretersgetSessionInterpreterListGETRetrieves interpreters in a session.
List session pollsgetSessionPollsGETList all the polls of a session.
List session reservationsListSessionReservationsGETRetrieves the list of reservations made by registrants for the session.
List session streaming ingestionsListsessionstreamingingestionsGETList all streaming ingestions of a live session.
List session usersListsessionusersGETList the users from live or past sessions.
List session userssessionUsersGETUse this API to return a list of users from live or past sessions.
List session users QoSsessionUsersQOSGETReturn a list of session users from live or past sessions along with the quality of service (QoS) they received during the session.
List sessionsgetEventSessionListGETRetrieves the sessions in an event.
List sessionssessionsGETList the total live or past sessions that occurred during a specified period of time.
List stream ingestionsListstreamingestionsGETList all the stream ingestions on your Zoom account.
Update a sessionupdateEventSessionPATCHUpdates an existing session in an event.
Update a session live streamsessionLiveStreamUpdatePATCHUse this API to update a session's live stream information.
Update a stream ingestionUpdateastreamingestionPATCHUpdate a stream ingestion.
Update Realtime Media Streams (RTMS) app statusupdateSessionRtmsAppStatusPATCHUpdate the status of the Realtime Media Streams (RTMS) app in an ongoing session.
Update session livestream configurationUpdateSessionLivestreamConfigurationPATCHUpdate the livestream configuration for the given session.
Update session livestream statussessionLiveStreamStatusUpdatePATCHUpdate a session's livestream status.
Update session statussessionStatusPUTUse this API to update a session's status.
Use in-session events controlsinSessionEventsControlPATCHControl 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 detailsGetAccountPolicyDetailsGETReturns the account policy details.
Get mailbox vacation response settingget_mail_vacation_response_settingGETGets vacation respondes settings.
Get phone account settingsphoneSettingGETReturns an account's settings.
Get ported numbers detailsGetportednumbersdetailsGETReturns the details on the ported numbers by specifying order id.
Get the specified user calendar settings of the authenticatedGetsettingGETReturns a single setting.
List all user calendar settings of the authenticated userListsettingsGETReturns all user settings for the authenticated user.
List BYOC SIP trunksListBYOCSIPtrunksGETReturns a list of an account's assigned BYOC (Bring Your Own Carrier) SIP (Session Initiation Protocol) trunks.
List ported numbersListportednumbersGETReturns a list of ported numbers in a Zoom account.
List SIP groupsListSIPgroupsGETReturns a list of SIP (Session Initiation Protocol) groups.
Patch the specified user calendar settings of the authenticatedPatchsettingPATCHPatches a single setting.
Update account policyupdateAccountPolicyPATCHUpdates the account's Zoom Phone policy.
Update mailbox vacation response settingupdate_mailbox_vacation_response_settingPUTUpdates vacation responder settings.
Update phone account settingsupdatePhoneSettingsPATCHUpdates Zoom Phone account settings.
Update whiteboard share settingUpdateAWhiteboardShareSettingPATCHUpdates the whiteboard share setting.
Setting Template4
Add a setting templateaddSettingTemplatePOSTCreates a Zoom Phone setting template for an account.
Get setting template detailsgetSettingTemplateGETReturns information about an account's phone template.
List setting templateslistSettingTemplatesGETGets a list of all the created phone template settings.
Update a setting templateupdateSettingTemplatePATCHUpdates or modifies a phone template's settings.
Settings Delegate4
Get the specified delegate on the mailboxget_mailbox_delegateGETRetrieves the specified delegate.
Grant a new delegate access on the mailboxgrant_mailbox_delegatePOSTCreates a delegate on the mailbox.
List delegates on the mailboxlist_mailbox_delegatesGETLists the delegates on the mailbox.
Revoke an existing delegate access from the mailboxrevoke_mailbox_delegateDELETERemoves the specified delegate.
Settings Filter4
Create an email filtercreate_email_filterPOSTCreates a message filter.
Delete the specified email filterdelete_email_filterDELETEImmediately and permanently deletes the specified filter.
Get the specified email filterget_email_filterGETRetrieves the specified filter.
List email filterslist_email_filtersGETLists the message filters of a mailbox.
Share1
Create sharescreate_sharesPOSTCreates an endpoint for our Customize Once and Share feature.
Shared Line Appearance1
List shared line appearanceslistSharedLineAppearancesGETReturns a list of shared line appearance instances.
Shared Line Group22
Add a policy setting to a shared line groupaddSLGPolicySubSettingPOSTAdds the policy sub-setting for a specific shared line group according to the policyType.
Add members to a shared line groupaddMembersToSharedLineGroupPOSTAdds members to a shared line group.
Add shared line group settingaddSharedLineGroupSettingPOSTAdds the shared line group setting according to the setting type.
Assign phone numbersassignPhoneNumbersSLGPOSTAssigns phone numbers to a shared line groups.
Create a shared line groupcreateASharedLineGroupPOSTCreates a shared line group.
Delete a shared line groupdeleteASharedLineGroupDELETEDeletes a shared line group.
Delete an SLG policy settingremoveSLGPolicySubSettingDELETERemoves the policy sub-setting for a specific shared line group according to the policyType.
Delete shared line group settingdeleteSharedLineGroupSettingDELETEDeletes the shared line group setting according to the setting type.
Get a shared line groupgetASharedLineGroupGETReturns a list of all the shared line groups.
Get a shared line group policygetSharedLineGroupPolicyGETReturns the policy setting of a specific shared line group.
Get shared line group call handling settinggetSharedLineGroupCallHandlingSettingGETReturns the call handling setting of a shared line group for the specified hour type.
Get shared line group settingsgetSharedLineGroupSettingsGETReturns shared line group settings.
List shared line groupslistSharedLineGroupsGETLists all the shared line groups.
Unassign a member from a shared line groupdeleteAMemberSLGDELETEUnassigns a specific member from a shared line group.
Unassign a phone numberdeleteAPhoneNumberSLGDELETEUnassigns a specific phone number that was assigned to the shared line group.
Unassign all phone numbersdeletePhoneNumbersSLGDELETEUnassigns all the phone numbers that have been assigned to the shared line group.
Unassign members from a shared line groupdeleteMembersOfSLGDELETEUnassigns all existing members from a shared line group.
Update a shared line groupupdateASharedLineGroupPATCHUpdates the information about a shared line group.
Update a shared line group policyupdateSharedLineGroupPolicyPATCHUpdates the policy setting of a specific shared line group.
Update an SLG policy settingupdateSLGPolicySubSettingPATCHUpdates the policy sub-setting for a specific shared line group according to the policyType.
Update shared line group call handling settingupdateSharedLineGroupCallHandlingSettingPATCHUpdate the call handling setting of a shared line group for the specified hour type.
Update shared line group settingupdateSharedLineGroupSettingPATCHUpdate the shared line group setting according to the setting type.
Shared Space13
Add members to a shared spaceaddSpaceMembersPOSTAdds members to a shared space.
Create a shared spacecreateSpacePOSTCreates a shared space.
Delete a shared spacedeleteSpaceDELETEDeletes a shared space.
Demote shared space administrators to membersdemoteSpaceAdminsDELETEDemotes shared space administrators to members.
Get a shared spacegetASharedSpaceGETReturns information about a shared space.
List shared space channelslistSharedSpaceChannelsGETReturns a list of channels for a shared space.
List shared space memberslistSharedSpaceMembersGETReturns a list of members in a shared space.
List shared spaceslistSharedSpacesGETReturns a list shared spaces.
Move shared space channelsupdateSharedSpaceChannelsPATCHMoves one or more channels in or out of a shared space.
Promote shared space members to administratorspromoteSpaceMembersPOSTPromotes shared space members to administrators.
Remove members from a shared spacedeleteSpaceMembersDELETERemoves members from a shared space.
Transfer shared space ownershiptransferSpaceOwnerPATCHTransfers shared space ownership to a member or administrator.
Update shared space settingsupdateSharedSpaceSettingsPATCHUpdates a shared space's settings.
Single7
Create Clip ChapterscreateClipChaptersPOSTCreate or replace all chapters for a clip.
Delete a clip(soft delete)DeleteClipDELETEDeletes a clip.
Duplicate ClipsDuplicateClipsPOSTDuplicate a clip.
Get a clipGetClipByIdGETReturns a clip from the current user, or returns any clips associated with the account.
Get Clip ChaptersGetClipChaptersGETGet the complete chapter list and chapter generation status for a clip.
Update a clip's basic infoUpdateClipByIdPATCHUpdates clips basic info by clip's Id, now support update title/description/tags
Update clips share settingUpdateclipssharesettingPATCHUpdate the clip's share settings.
SIP Phone4
Delete SIP phonedeleteSIPPhonePhonesDELETEDelete a Zoom account's SIP phone.
Enable SIP phoneEnableSIPPhonePhonesPOSTEnable a user to use a SIP phone.
List SIP phonesListSIPPhonePhonesGETList SIP phones on an account.
Update SIP phoneUpdateSIPPhonePhonesPATCHUpdate the information of a specific SIP phone on a Zoom account.
Site12
Add a site settingaddSiteSettingPOSTSites allow you to organize Zoom Phone users in your organization.
Add customized outbound caller ID phone numbersaddSiteOutboundCallerNumbersPOSTUse this API to add the site-level customized outbound caller ID phone numbers.
Create a phone sitecreatePhoneSitePOSTCreates a site that allows you to organize the Zoom Phone users in your organization.
Delete a phone sitedeletePhoneSiteDELETEUse this API to delete a specific site in a Zoom account.
Delete a site settingdeleteSiteSettingDELETESites allow you to organize Zoom Phone users in your organization.
Get a phone site settinggetSiteSettingForTypeGETGets the site setting about a specific site according to the setting type.
Get phone site detailsgetASiteGETReturns information on a specific site.
List customized outbound caller ID phone numberslistSiteCustomizeOutboundCallerNumbersGETUse this API to retrieve phone numbers that can be used as the site-level customized outbound caller ID.
List phone siteslistPhoneSitesGETSites allow you to organize Zoom Phone users in your organization.
Remove customized outbound caller ID phone numbersdeleteSiteOutboundCallerNumbersDELETEUse this API to remove the site-level customized outbound caller ID phone numbers.
Update phone site detailsupdateSiteDetailsPATCHUpdates information about a specific site.
Update the site settingupdateSiteSettingPATCHAllows you to organize Zoom Phone users in your organization.
Skill11
Create a skillskillCreatePOSTCreate a skill for skill-based routing.
Create a skill categorySkillCategoryCreatePOSTCreate a new skill category.
Delete a skillskillDeleteDELETEDelete a skill.
Delete a skill categorySkillCategoryDeleteDELETEDelete an existing skill category.
Get a skillgetSkillGETReturn a skill's information and its usage.
Get a skill categorygetSkillCategoryGETReturn information about a specific skill category.
List skill categorieslistSkillCategoryGETList all available skill categories and their information.
List skill userslistSkillUsersGETRetrieve a list of users assigned to a skill.
List skillslistSkillsGETReturn a list of a skills or a skill category's assigned skills.
Update a skillskillNameUpdatePATCHUse this API to update a skill's name.
Update a skill categorySkillCategoryUpdatePATCHUpdate a skill category.
SMS8
Get account's SMS sessionsaccountSmsSessionGETReturns details about SMS sessions for an account.
Get SMS by message IDsmsByMessageIdGETReturns details about a specific message in an SMS session.
Get SMS session detailssmsSessionDetailsGETReturns details about an SMS session.
Get user's SMS sessionsuserSmsSessionGETReturns details about SMS sessions for a user.
List user's SMS sessions in descending orderGetSmsSessionsGETRetrieves the user's SMS sessions in descending order.
Post SMS messagepostSmsMessagePOSTSends SMS messages to Zoom Phone accounts.
Send an SMScontactCenterSMSPOSTSend an SMS message.
Sync SMS by session IDsmsSessionSyncGETSyncs SMS messages in a session.
SMS Campaign7
Assign a phone number to SMS campaignassignCampaignPhoneNumbersPOSTAssigns a phone number to the SMS campaign.
Get an SMS campaignGetSMSCampaignGETReturns a specific SMS campaign.
List opt statuses of phone numbers assigned to SMS campaigngetNumberCampaignOptStatusGETReturns the opt statuses of phone numbers that are assigned to SMS the campaign.
List SMS campaignslistAccountSMSCampaignsGETReturns a list of all SMS campaigns in a Zoom account.
List user's opt statuses of phone numbersgetUserNumberCampaignOptStatusGETReturns the opt statuses of a user’s phone numbers.
Unassign phone number from SMS campaignunassignCampaignPhoneNumberDELETEUnassigns a phone number from an SMS campaign.
Update opt statuses of phone numbers assigned to SMS campaignupdateNumberCampaignOptStatusPATCHUpdates opt statuses of phone numbers that are assigned to the SMS campaign.
SMS Consent9
Assign phone numbers to SMS consent policyAssignPhoneNumbersToConsentPOSTAssigns one or more phone numbers to an SMS consent policy.
Create an SMS consent policyCreateSMSConsentPOSTCreates a new SMS consent management policy to define opt-in, opt-out, and help message configurations for SMS communications.
Delete SMS consent policiesDeleteSMSConsentsDELETEDeletes one or more SMS consent policies.
Get an SMS consent policyGetSMSConsentGETReturns a specific SMS consent policy by ID.
List opt statuses of phone numbers assigned to SMS consentgetNumberConsentOptStatusGETReturns the opt statuses of phone numbers that are assigned to SMS consent.
List phone numbers assigned to SMS consent policyListConsentPhoneNumbersGETReturns a paginated list of phone numbers assigned to a specific SMS consent policy.
List SMS consent policiesListSMSConsentsGETReturns a paginated list of SMS consent policies for the account.
Unassign phone numbers from SMS consent policyUnassignPhoneNumbersFromConsentDELETEUnassigns one or more phone numbers from an SMS consent policy.
Update an SMS consent policyUpdateSMSConsentPATCHUpdates an existing SMS consent policy.
Speaker5
Create a speakercreateSpeakerPOSTCreates a speaker for an event.
Delete a speakerdeleteSpeakerDELETEDeletes a speaker.
Get a speakergetSpeakerGETReturns information on a specific speaker.
List speakersgetSpeakersGETRetrieves a list of speakers for an event.
Update a speakerupdateSpeakerPATCHUpdates the speaker information.
Subscription5
Get trial details for an end customer by their Zoom accountgetTrialDetailsGETReturns the trial details for an end customer.
Get trial subscriptions for a Zoom partnergetAllTrialSubscriptionsGETReturns trial subscriptions for a distributor or reseller.
Gets paid subscriptions for a Zoom partner.getAllSubscriptionsGETReturns paid subscriptions for a distributor or a reseller.
Gets subscription changes/versions for a given subscriptiongetSubscriptionVersionsGETReturns the subscription changes or versions for a given subscription number.
Gets subscription details for a given subscription numbergetSubscriptionDetailsGETReturns the subscription details for a given subscription number.
Summarizer7
Cancel Batch Summarizer JobcancelBatchSummarizerJobDELETECancel a batch summarization job.
Get Batch Summarizer JobgetBatchSummarizerJobGETRetrieves job-level status, configuration, and progress summary for a batch summarization job.
Get Batch Summarizer Job FilegetBatchSummarizerJobFileGETRetrieves the processing result for a specific file within a batch summarization job.
List Batch Summarizer Job FileslistBatchSummarizerJobFilesGETRetrieves a paginated list of individual file results for a batch summarization job.
List Batch Summarizer JobslistBatchSummarizerJobsGETRetrieves a paginated list of batch summarization jobs for the authenticated tenant.
Submit Batch Summarizer JobsubmitBatchSummarizerPOSTSubmits a batch summarization job for asynchronous processing.
Summarize (Synchronous)summarizePOSTSubmit transcript text and receive a summary inline.
Summary3
Delete a meeting or webinar summaryDeletemeetingorwebinarsummaryDELETEDelete the summary of a meeting or webinar.
Get a meeting or webinar summaryGetameetingsummaryGETRetrieve the summary of a meeting or webinar.
List an account's meeting or webinar summariesListmeetingsummariesGETRetrieve a list of all meeting or webinar summaries available for an account.
Survey3
Delete a meeting surveymeetingSurveyDeleteDELETEDelete a meeting survey.
Get a meeting surveymeetingSurveyGetGETDisplay information about a meeting survey.
Update a meeting surveymeetingSurveyUpdatePATCHUpdate a meeting survey.
Survey Management5
Get survey answersgetSurveyAnswersGETQueries the answers of survey from surveyId.
Get survey infogetSurveyInfoGETQueries the latest version of survey information from surveyId.
Get survey instancesgetSurveyInstancesInfoGETQuery the instances which used the survey, based on surveyId.
Get surveysgetAccountSurveysGETQueries all surveys in the current account.
List channel survey instancesGetsurveyinstancesGETQuery the channel survey instances based on channelId.
Task5
Create a new taskcreateTaskPOSTProvide essential details to create a new task without file attachments.
Delete a taskdeleteTaskDELETEPermanently delete a task and all its associated data including descriptions, attachments, collaborators, and integrations.
Get task detailsgetTaskDetailGETRetrieves detailed information about a specific task by it’s ID
List tasksgetMyTasksGETRetrieves tasks assigned to, or created by, the current user with advanced filtering, sorting, and pagination options.
Update task fieldsupdateTaskPATCHUpdates specific fields of an existing task.
Team32
Assign team agentsassignTeamAgentsPOSTAssign agents to a team.
Assign Team ManagersAssignTeamManagersPOSTAdd team managers.
Assign Team MembersAssignTeamMembersPOSTAdd one or more users to a team.
Assign team supervisorsassignTeamSupervisorsPOSTAssign supervisors to a team.
Create a teamCreateTeamContactCenterPOSTCreate a new team.
Create TeamCreateTeamIqPOSTPlease create team one by one, if your account enable hierarchical structure team.
Delete a teamdeleteTeamDELETEDelete a specified team.
Delete TeamDeleteTeamDELETEPlease delete team one by one, if your account enable hierarchical structure team.
Get a teamgetTeamDetailGETGet information about a team.
Get Team DetailGetTeamDetailGETGet team detail, such as team name, team description, team member size and etc.
Grant additional access to current teamAddSharedFromTeamsPOSTGrants the current team access to view conversation recordings hosted and attended by members of the specified source teams.
Grant additional access to target teamsAddSharedToTeamsPOSTThe current team grants additional access to the target teams.
List a team's child teamsgetTeamChildTeamsGETGet a list of a team's child teams.
List Account TeamsListTeamsGETList account teams.
List teamListteamGETLists teams for the specified user, or for the current user.
List team agentslistTeamAgentsGETRetrieve a list of a team's assigned agents.
List Team ManagersListTeamManagersGETList Team Managers
List Team MembersListTeamMembersGETList team members by page
List team supervisorslistTeamSupervisorsGETLists the supervisors assigned to a specific team.
List team's parent teamsgetTeamParentTeamsGETGet a list of a team's parent teams.
List teamslistTeamsGETRetrieve a list of all teams with details, including supervisors and agents.
List Unassigned Team UsersListUnassignedTeamUsersGETList unassigned team zra users by page
Move a teammoveTeamPATCHMove a team's level.
Move team to new parentMoveTeamPATCHMove current team under a new parent team.
Remove additional access from current teamDeleteSharedFromTeamsDELETEThe target teams stop granting additional access to the current team.
Remove additional access from target teamsDeleteSharedToTeamsDELETEThe current team stops granting additional access to the target teams.
Unassign team agentsunassignTeamAgentsDELETEUnassign agents from a team.
Unassign Team ManagersUnassignTeamManagersDELETEDelete team managers.
Unassign Team MembersUnassignTeamMembersDELETEDelete members of the team.
Unassign team supervisorsunassignTeamSupervisorsDELETEUnassign supervisors from a team.
Update a teamUpdateateamPATCHUpdate a team's details.
Update Team nameUpdateTeamPATCHUpdate the team name.
Template2
Create a meeting template from an existing meetingmeetingTemplateCreatePOSTCreate a meeting template from an existing meeting.
List meeting templateslistMeetingTemplatesGETList available meeting templates for a user.
Thread6
Delete an existing email threaddelete_email_threadDELETEImmediately and permanently deletes the specified thread.
Get the specified email threadget_email_threadGETRetrieves the specified thread.
List email threads from the mailboxlist_email_threadsGETLists the threads in the mailbox.
Move the specified thread out of TRASH folderuntrash_email_threadPOSTMoves the specified thread out of the trash folder.
Move the specified thread to TRASH foldertrash_email_threadPOSTMoves the specified thread to the trash.
Update the specified threadupdate_email_threadPOSTModifies the labels applied to the thread.
Ticket5
Create ticketscreateTicketsPOSTCreates tickets for an event.
Delete a ticketdeleteTicketDELETEDeletes a ticket.
Get a ticketgetTicketDetailsGETRetrieves information on a specific ticket.
List ticketsgetTicketsGETRetrieves the ticket information of an event.
Update ticketUpdateticketPATCHUpdates ticket questions for the given ticket ID and event ID.
Ticket Type8
Create an event ticket typecreateTicketTypePOSTCreates a ticket type for the event ID that is not allowed for single session and recurring event types.
Delete a ticket typedeleteEventTicketTypeDELETEDeletes a ticket type of an event that is not allowed for a single session event type.
List registration questions for an eventgetRegistrationQuestionsForEventGETList registration questions and fields that are to be answered by users while registering for an event.
List registration questions for ticket typegetRegistrationQuestionsForTicketTypeGETList registration questions and fields that are to be answered by users while registering for an event.
List ticket typesgetEventTicketTypesGETLists all ticket types associated with an event.
Update registration questions for an eventupdateRegistrationQuestionsForEventPUTUpdates registration questions and fields that are to be answered by users while registering for an event.
Update registration questions for ticket typeupdateRegistrationQuestionsForTicketTypePUTUpdates registration questions and fields that are to be answered by users while registering for an event.
Update ticket type for an eventupdateTicketTypePATCHUpdates the ticket type for an event ID not allowed for a single session event type.
Tracking Field5
Create a tracking fieldtrackingfieldCreatePOSTUse this API to create a new tracking field.
Delete a tracking fieldtrackingfieldDeleteDELETEDelete a tracking field.
Get a tracking fieldtrackingfieldGetGETUse this API to return information about a tracking field.
List tracking fieldstrackingfieldListGETList all the tracking fields on your Zoom account.
Update a tracking fieldtrackingfieldUpdatePATCHUpdate a tracking field.
Transfer2
Transfer clips ownerTransferclipsownerPOSTTransfers clip ownership to another user.
Transfer task status checkTransfertaskstatuscheckGETTransfers the task status check.
Translator7
Cancel Batch Translator JobcancelBatchTranslatorJobDELETECancels a batch translation job.
Get Batch Translator JobgetBatchTranslatorJobGETRetrieves job-level status, configuration, and progress summary for a batch translation job.
Get Batch Translator Job FilegetBatchTranslatorJobFileGETRetrieves the processing result for a specific file within a batch translation job.
List Batch Translator Job FileslistBatchTranslatorJobFilesGETRetrieves a paginated list of individual file results for a batch translation job.
List Batch Translator JobslistBatchTranslatorJobsGETRetrieves a paginated list of batch translation jobs for the authenticated tenant.
Submit Batch Translator JobsubmitBatchTranslatorPOSTSubmits a batch translation job for asynchronous processing.
Translate (Synchronous)translatePOSTSubmit text and receive translations inline.
TSP8
Add a user's TSP accountuserTSPCreatePOSTAdd a user's TSP account.
Delete a user's TSP accountuserTSPDeleteDELETEDelete a user's TSP account.
Get a user's TSP accountuserTSPGETRetrieve details of a specific TSP account enabled for a specific user.
Get account's TSP informationtspGETGet information on Telephony Service Provider (TSP) on an account level.
List user's TSP accountsuserTSPsGETList all of a user's TSP accounts.
Set global dial-in URL for a TSP usertspUrlUpdatePATCHSet 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 accountuserTSPUpdatePATCHUpdate a user's Telephony Service Provider (TSP) account.
Update an account's TSP informationtspUpdatePATCHUpdate information of the Telephony Service Provider (TSP) set up on an account.
Upload4
Initiate and complete the multipart file upload for a clipInitiateAndCompleteAClipMultipartUploadPOSTInitiates or completes a multipart upload.
Temporary file upload API for ClipsTemporaryfileuploadAPIforClipsPOSTUploads temporary files for Clips.
Upload clip fileUploadClipFilePOSTUploads a video file to create a Zoom Clip.
Upload clip multipart filesUploadIqMultipartClipFilePOSTUploads a multipart file to create a Zoom Clip.
User89
Add a user's profile settingaddUserProfileSettingPOSTAdds the user setting according to the setting type.
Add a user's shared access settingaddUserSettingPOSTAdds the user setting according to the setting type, specifically for delegation, intercom and shared access for voicemail, and call recordings.
Add assistantsuserAssistantCreatePOSTAssign assistants to a user.
Add phone numbers for users' customized outbound caller IDaddUserOutboundCallerNumbersPOSTAdds users' customized outbound caller ID phone numbers.
Add user call forward settingaddUserCallForwardSettingPOSTAdds Zoom Phone call forwarding numbers for a user under a specific hour type.
Assign a user's skillsassignSkillsPOSTAssign skills to a user.
Assign calling plan to a userassignCallingPlanPOSTAssigns a calling plan to a Zoom Phone user.
Batch add usersbatchAddUsersPOSTAdds phone users in batch.
Batch create user profilesBatchCreateUsersPOSTBatch create Contact Center users.
Batch delete user profilesbatchDeleteUsersDELETEBatch delete Contact Center users.
Batch update user profilesBatchUpdateUsersPATCHBatch update Contact Center users.
Batch update user statusBatchupdateuserstatusPATCHBatch update Contact Center users' statuses.
Bulk update features for usersbulkUpdateFeaturePOSTUpdate multiple features for a user.
Check a user emailuserEmailGETVerify if a user's email is registered with Zoom.
Check a user's PM roomuserVanityNameGETA personal meeting room is a virtual meeting room that can be permanently assigned to a user.
Create a useruserScim2CreatePOSTCreates a new user.
Create a user templatecreateAUserTemplatePOSTCreate a user template.
Create a user's profilecreateUserPOSTCreate a Contact Center user.
Create usersuserCreatePOSTAdd a new user to your Zoom account.
Deactivate a useruserADSCIM2DeactivatePATCHActivate or deactivate a user.
Delete a scheduleruserSchedulerDeleteDELETEDelete a scheduler.
Delete a useruserDeleteDELETEDisassociate (unlink) a user or permanently delete a user.
Delete a useruserSCIM2DeleteDELETEDelete a user.
Delete a user assistantuserAssistantDeleteDELETEDelete a specific assistant of a user.
Delete a user templatedeleteAUserTemplateDELETEDelete a user template.
Delete a user's profileuserDeleteContactCenterDELETEDelete a Contact Center user.
Delete a user's profile pictureuserPictureDeleteDELETEDelete a user's profile picture.
Delete a user's profile profile settingdeleteUserProfileSettingDELETEDeletes a user setting based on the setting type.
Delete a user's recordingsdeleteUserRecordingsDELETEDelete all of a user's Contact Center recordings.
Delete a user's shared access settingdeleteUserSettingDELETERemoves the user setting according to the setting type, specifically for delegation, intercom and shared access for voicemail and call recordings.
Delete user assistantsuserAssistantsDeleteDELETEDelete all of the current user's assistants.
Delete user call forward settingdeleteUserCallForwardSettingDELETEDelete Zoom Phone call forwarding numbers for a user under a specific hour type.
Delete user schedulersuserSchedulersDeleteDELETEDelete all of a user's schedulers.
Delete Virtual Background filesdelUserVBDELETEUse this API to delete a user's Virtual Background files.
Get a useruserGETView a user's information on a Zoom account.
Get a useruserSCIM2GetGETReturns information about a specific user.
Get a user presence statusgetUserPresenceStatusGETReturns a user's current status.
Get a user templateGetanusertemplateGETGet a user template.
Get a user's profilegetUserGETRetrieve a Contact Center user.
Get a user's profilephoneUserGETReturns a user's Zoom phone profile.
Get a user's profile settingsphoneUserSettingsGETReturns the Zoom Phone profile settings of a user.
Get a user's tokenuserTokenGETGets a user's Zoom token or Zoom Access Key (ZAK).
Get collaboration device detailgetCollaborationDeviceGETGet collaboration device detail.
Get meeting summary templatesGetmeetingsummarytemplatesGETList meeting summary templates.
Get meeting template detailgetUserMeetingTemplatesGETRetrieve a user's meeting template.
Get the user's ZAKuserZakGETGet the Zoom Access Key (ZAK) for the authenticated user associated with the access token in the API request.
Get userget_userGETReturns information about the user.
Get user call handling settinggetUserCallHandlingSettingGETReturns the call handling setting of a user for the specified hour type.
Get user permissionsuserPermissionGETGet permissions that have been granted to the user.
Get user policy detailsGetUserPolicyDetailsGETReturns the user policy details.
Get user settingsuserSettingsGETRetrieve a user's settings.
Get user summaryuserSummaryGETGets a summary of users, including the number and types of users in the account.
List a user's collaboration deviceslistCollaborationDevicesGETList a user's collaboration devices.
List a user's queueslistUserQueuesGETList the Contact Center queues that a user is assigned to.
List a user's recordingslistUserRecordingsGETList a user's Contact Center recordings.
List a user's skillsListAUserSkillsGETGet a list of skills assigned to a given user.
List phone userslistPhoneUsersGETReturns a list of all of an account's users who are assigned a Zoom Phone license.
List user assistantsuserAssistantsGETList a user's assistants.
List user profilesusersContactCenterGETReturns a list of Contact Center users.
List user schedulersuserSchedulersGETList all of a user's schedulers.
List user templatesListUserTemplatesGETReturn the user template list
List usersListallusersGETGet all the users in the account.
List usersuserSCIM2ListGETLists all users.
List usersusersGETRetrieve a list of your account's users.
List users' phone numbers for a customized outbound caller IDlistUserCustomizeOutboundCallerNumbersGETRetrieves phone numbers that can be the user-level customized outbound caller ID.
Opt-in or opt-out a user's queuesBatchOptInOrOutUserQueuesPATCHChange a Contact Center user's opt-in or opt-out status for queues assigned to the user.
Remove users' customized outbound caller ID phone numbersdeleteUserOutboundCallerNumbersDELETERemoves the users' customized outbound caller ID phone numbers.
Revoke a user's SSO tokenuserSSOTokenDeleteDELETERevokes a user's SSO token.
Unassign a user's skilldeleteASkillDELETERemove a skill from a Contact Center user.
Unassign user's calling planunassignCallingPlanDELETEUnassigns a Zoom Phone user's calling plan.
Update a useruserSCIM2UpdatePUTUpdates a user's information.
Update a useruserUpdatePATCHUpdates a user's Zoom profile information.
Update a user templateupdateAUserTemplatePATCHUpdate a user template.
Update a user's emailuserEmailUpdatePUTChange a user's email address on a Zoom account that has managed domain set up.
Update a user's passworduserPasswordPUTUpdate the password of a user using which the user can login to Zoom.
Update a user's presence statusupdatePresenceStatusPUTUpdate a user's presence status.
Update a user's profileupdateUserPATCHUpdate a Contact Center user.
Update a user's profileupdateUserProfilePATCHUpdates a user's Zoom Phone profile.
Update a user's profile settingsupdateUserSettingsPATCHUpdates the Zoom Phone profile settings of a user.
Update a user's shared access settingupdateUserSettingPATCHUpdates 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_sstatusPATCHUpdate a user's status.
Update multiple users' properties in batchupdateUsersPropertiesInBatchPUTUpdates multiple users' properties in batch.
Update user call handling settingupdateUserCallHandlingSettingPATCHUpdates a user's call handling settings for the specified hour type.
Update user policyupdateUserPolicyPATCHUpdates a user's Zoom Phone policy.
Update user settingsuserSettingsUpdatePATCHUpdate a user's settings.
Update user statususerStatusPUTDeactivate an active user or to reactivate a deactivated user.
Update user's calling planupdateCallingPlanPUTSwitches the calling plans of a Zoom Phone user.
Upload a user's profile pictureuserPicturePOSTUpload a user's profile picture.
Upload Virtual Background filesuploadVBuserPOSTUse this API to upload a Virtual Background files to a user's profile.
Variable13
Create a variablecreateVariablePOSTCreate a new variable.
Create a variable groupcreateVariableGroupPOSTCreate a custom variable group.
Delete a variablevariableDeleteDELETEDelete a variable.
Delete a variable groupDeleteGroupDELETEDelete a specified variable group.
Delete a variable logdeleteVariableLogDELETEDelete a variable log.
Get a variablevariableGetGETRetrieve a variable.
Get a variable groupgetAVariableGroupGETGet information about a variable group.
Get a variable loggetVariableLogGETGet information about a variable log.
List variable groupslistVariableGroupsGETReturn a list of variable groups.
List variable logslistVariableLogsGETReturn a list of variable logs.
List variablesvariablesGETReturns a list of variables for a specific variable group.
Update a variablevariableUpdatePATCHUpdate a variable.
Update a variable groupupdateVariableGroupPATCHUpdate a variable group.
Video11
Add channel videosAddChannelVideosPOSTAdds videos to the channel.
Add playlist videosAddPlaylistVideosPOSTAdds videos to a playlist.
Delete channel videosDeleteChannelVideosDELETERemoves videos from the channel.
Delete playlist videosDeletePlaylistVideosDELETEDeletes videos from a playlist.
Get metadata for a specific videogetVideoMetadataEventsGETRetrieves metadata for a specific video, including title, description, duration, creation time, last updated time, and associated tags.
Get metadata for a specific videogetVideoMetadataVideoManagementGETRetrieves metadata such as the name, description, and notes for a specific video.
List all videosListAllVideosGETRetrieves the list of videos or recordings added by the user.
List channel videosListChannelVideosGETGets a list of the channel's videos.
List playlist videosListPlaylistVideosGETGets the playlist's list of videos.
Update metadata for a specific videoupdateVideoMetadataEventsPATCHUpdates video metadata.
Update metadata for a specific video.updateVideoMetadataVideoManagementPATCHUpdates video metadata.
Video On Demand9
Add VOD channel videosAddVODChannelVideosPOSTAdds videos to the VOD channel.
Create VOD channelcreateVodChannelPOSTCreates a channel for managing hub videos.
Delete VOD ChannelDeleteVODChannelDELETEDeletes a video channel.
Delete VOD channel videoDeleteVODChannelVideoDELETERemoves video from the VOD channel.
Get VOD channel detailsgetVODChannelDetailGETReturns VOD channel details.
List channelsgetVODChannelsGETRetrieves the channel information for a hub.
List VOD channel videosListVODChannelVideosGETLists VOD channel videos.
Update VOD channelUpdateVideoChannelEventsPATCHUpdates a hub video channel.
VOD channel actionsvodChannelActionsPOSTReturns VOD channel action result.
Video On Demand Registration4
Get VOD Registration QuestionsgetRegistrationQuestionsForVODChannelGETList registration questions and fields that are to be answered by users while registering for a vod channel.
List VOD RegistrationListVODRegistrationGETRetrieves the VOD registration information of a channel.
update VOD channel registration questionsupdateRegistrationQuestionsForVODchannelPUTUpdates registration questions and fields that are to be answered by users while registering for a VOD channel.
VOD channel registrationVODTicketRegistrationPOSTCreates registrations for a VOD channel.
Video SDK Report5
Get cloud recording usage reportvsdkReportCloudRecordingGETRetrieve cloud recording usage report for a specified period.
Get daily usage reportvsdkReportDailyGETGet daily report of the account-wide usage of Zoom services for each day in a given month.
Get operation logs reportvsdkReportOperationLogsGETGet operation logs report for a specified period of time.
Get telephone reportvsdkReportTelephoneGETGet the telephone report for a specified period of time.
Get webhook logsgetWebhookLogsVideoSdkGETGet the webhook call logs for the Video SDK app created by the current account.
Video SDK Session1
List session users QoS SummarysessionUsersQOSSummaryGETUse 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 visitorcheckinVisitorPOSTCheck in an invitation.
Delete an InvitationdeleteInvitationDELETEVisitor management is a software system used to manage the lifecycle of visitors.
Get a list of visitors by locationinvitationListGETList the invitations under a Zoom user account.
Invitation details by invitationIDgetInvitationGETVisitor management is a software system used to manage the lifecycle of visitors.
Send an invitationcreateInvitationPOSTSend a invitation to a visitor.
Update an invitationupdateInvitationPATCHUpdate a invitation.
Voicemail7
Delete a voicemaildeleteVoicemailDELETEDeletes an account's voicemail message.
Download a phone voicemailphoneDownloadVoicemailFileGETDownloads the Zoom phone voicemail.
Get a voicemail by call element IDgetVoicemailDetailsByCallElementIdGETReturns the detailed information on a voicemail by the call element's callElementId.
Get account voicemailsaccountVoiceMailsGETGets a user's Zoom Phone voicemails.
Get user's voicemailsphoneUserVoiceMailsGETReturns a user's Zoom Phone voicemails.
Get voicemail detailsgetVoicemailDetailsGETReturns the information about a voicemail message.
Update Voicemail Read StatusupdateVoicemailReadStatusPATCHUpdates the status of voicemail message.
Webinar53
Add a webinar registrantwebinarRegistrantCreatePOSTCreate and submit a user's registration for a webinar.
Add panelistswebinarPanelistCreatePOSTPanelists in a webinar can view and send video, screen share, annotate, and do much more compared to attendees in a webinar.
Create a webinarwebinarCreatePOSTSchedule a webinar for a user who is a webinar host.
Create a webinar templatewebinarTemplateCreatePOSTCreate a webinar template from an existing webinar.
Create a webinar's branding name tagcreateWebinarBrandingNameTagPOSTCreate a webinar's session branding name tag.
Create a webinar's pollwebinarPollCreatePOSTCreates a poll for a webinar.
Create webinar's invite linkswebinarInviteLinksCreatePOSTCreate a batch of invitation links for a webinar.
Delete a live webinar messagedeleteWebinarChatMessageByIdDELETEDeletes a message in a live webinar based on ID.
Delete a webinarwebinarDeleteDELETEDelete a webinar.
Delete a webinar pollwebinarPollDeleteDELETEDelete a webinar's poll.
Delete a webinar registrantdeleteWebinarRegistrantDELETEDelete a webinar registrant.
Delete a webinar surveywebinarSurveyDeleteDELETEDelete a webinar survey.
Delete a webinar's branding name tagdeleteWebinarBrandingNameTagDELETEDelete a webinar's session branding name tag.
Delete a webinar's branding virtual backgroundsdeleteWebinarBrandingVBDELETEDelete a webinar's session branding virtual background.
Delete a webinar's branding wallpaperdeleteWebinarBrandingWallpaperDELETEDelete a webinar's session branding wallpaper file.
Get a webinarwebinarGETGet details for a scheduled Zoom webinar.
Get a webinar pollwebinarPollGetGETReturns a webinar's poll details.
Get a webinar registrantwebinarRegistrantGetGETZoom users with a webinar plan have access to creating and managing webinars.
Get a webinar SIP URI with passcodegetWebinarSipDialingWithPasscodePOSTGet a webinar's SIP URI.
Get a webinar surveywebinarSurveyGetGETReturn information about a webinar survey.
Get a webinar's archive token for local archivingwebinarLocalArchivingArchiveTokenGETUse this API to get a webinar's archive token to allow local archiving.
Get a webinar's join token for live streamingwebinarLiveStreamingJoinTokenGETRetrieve a webinar's archive token to allow live streaming.
Get a webinar's join token for local recordingwebinarLocalRecordingJoinTokenGETRetrieve a webinar's join token to allow for local recording.
Get live stream detailsgetWebinarLiveStreamDetailsGETGet a webinar's live stream configuration details, such as Stream URL, Stream Key and Page URL.
Get webinar absenteeswebinarAbsenteesGETList absentees of a webinar.
Get webinar tracking sourcesgetTrackingSourcesGETWebinar 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 brandinggetWebinarBrandingGETGet the webinar's session branding information.
Get webinar's tokenwebinarTokenGETUse this API to get a webinar's closed caption token (caption URL).
List a webinar's pollswebinarPollsGETLists all the polls of a webinar.
List panelistswebinarPanelistsGETList all of a webinar's panelists.
List past webinar instancespastWebinarsGETList past webinar instances.
List past webinar poll resultslistPastWebinarPollResultsGETThe polling feature for webinar lets you create single-choice or multiple-choice polling questions for your webinars.
List Q&As of a past webinarlistPastWebinarQAGETList the Q&A of a specific past webinar.
List registration questionswebinarRegistrantsQuestionsGetGETList registration questions and fields that are to be answered by users while registering for a webinar.
List webinar participantslistWebinarParticipantsGETRetrieve a list of all the participants who attended a webinar hosted in the past.
List webinar registrantswebinarRegistrantsGETList all users that have registered for a given webinar.
List webinar templateslistWebinarTemplatesGETDisplay a list of a user's webinar templates.
List webinarswebinarsGETList all the webinars scheduled by or on behalf a webinar host.
Perform batch registrationaddBatchWebinarRegistrantsPOSTRegister up to 30 registrants at once for a scheduled webinar that requires registration.
Remove a panelistwebinarPanelistDeleteDELETERemove a single panelist from a webinar.
Remove all panelistswebinarPanelistsDeleteDELETERemove all the panelists from a webinar.
Set webinar's default branding virtual backgroundsetWebinarBrandingVBPATCHSet a webinar's default session branding virtual background.
Update a live streamwebinarLiveStreamUpdatePATCHUpdate a webinar's live stream information.
Update a webinarwebinarUpdatePATCHMake updates to a scheduled webinar.
Update a webinar pollwebinarPollUpdatePUTUpdates a webinar's poll.
Update a webinar surveywebinarSurveyUpdatePATCHUpdate a webinar survey.
Update a webinar's branding name tagupdateWebinarBrandingNameTagPATCHUpdate a webinar's session branding name tag.
Update live stream statuswebinarLiveStreamStatusUpdatePATCHLets users live stream a webinar to a custom platform.
Update registrant's statuswebinarRegistrantStatusPUTUpdate webinar registrants' registration status.
Update registration questionswebinarRegistrantQuestionUpdatePATCHUpdate registration questions and fields of a scheduled webinar for users to answer during webinar registration.
Update webinar statuswebinarStatusPUTUpdate a webinar's status.
Upload a webinar's branding virtual backgrounduploadWebinarBrandingVBPOSTUpload a webinar's session branding virtual background.
Upload a webinar's branding wallpaperuploadWebinarBrandingWallpaperPOSTUpload a webinar's session branding wallpaper file.
Workspace39
Add a workspace photoAddaWorkspacephotoPOSTUse this API to add a workspace photo.
Add or Update a Workspace floor mapAddOrUpdateAWorkspaceFloorMapPOSTUse this API to Add or Update a Workspace floor map.
Check in/out of a reservationreservationEventPOSTUse this API to check in to or out of a reservation.
Create a reservationcreateReservationPOSTCreates a workspace reservation.
Create a workspacecreateWorkspacePOSTCreates workspaces.
Create a workspace assetAddaWorkspaceassetPOSTCreate a new workspace asset.
Delete a desk assignmentDeleteadeskassignmentDELETEDeletes a desk assignment.
Delete a reservationdeleteReservationDELETEDeletes a reservation.
Delete a workspacedeleteWorkspaceDELETEDeletes workspace detail.
Delete a workspace assetDeleteaWorkspaceassetDELETEDelete a workspace asset by asset ID.
Delete neighborhoodsDeleteNeighborhoodsDELETEDelete one or more neighborhoods from a floor.
Delete Workspace floor mapDeleteWorkspaceFloorMapDELETEUse this API to delete a workspace floor map.
Delete workspace photosDeleteaWorkspacephotoDELETEDeletes workspace photos.
Edit a workspace assetPatchWorkspaceassetPATCHEdit the workspace's asset based on asset ID.
Get a desk assignmentGetadeskassignmentGETGet a desk assignment.
Get a floor's reservationsGetafloor_sreservationsGETRetrieves a floor's reservations.
Get a location's hot desk usagegetHotDeskUsageGETCreates a location's hot desk usage information.
Get a neighborhoodGetNeighborhoodGETGet a neighborhood by ID.
Get a user's workspace's reservationsuserListReservationsGETRetrieves a user's workspace's reservations.
Get a workspacegetWorkspaceGETCreates workspace detail.
Get a workspace assetget_workspace_assetGETCreate a workspace asset based on the asset ID.
Get a workspace location floor mapGetlocationfloormapGETGet a location's floor map.
Get a workspace QR codegetWorkspaceQRCodeGETUse this API to get the workspace QR code.
Get a workspace reservation by reservationIdGETGetaworkspacereservationbyreservationIDGETRetrieves a workspace reservation ID.
Get a workspace's reservationslistReservationsGETRetrieves a workspace's reservations.
Get all workspace assetsGetallworkspaceassetsGETList all workspace assets.
Get questionnaire answer summaryGetworkspacequestionnaireresponsesGETRetrieves a summary of questionnaire answers for specified locations within a date range.
Get Workspace Calendar Free/Busy EventGetWorkspaceCalendarFree_BusyEventGETList workspace calendar free or busy event settings.
List neighborhoodsListNeighborhoodsGETList a floor's neighborhoods with optional neighborhood, workspace, user, or group filters.
List released workspaces by timeoutgetWorksapceReservationReleaseInofGETLists workspaces that were released due to missing check-in or checkout information.
List workspace additional information with time rangeGetaworkspaceadditionalenhancementsGETList a location's workspaces' additional information within a specified time range.
List workspace reservation questionnairesListworkspacereservationquestionnairesGETList workspace reservation questionnaires.
List workspace reservations by locationsGetworkspacereservationsinlocationsGETList workspace reservations by location.
List workspaceslistWorkspacesGETList a location's workspaces.
Set a desk assignmentsetADeskAssignmentPUTSet a desk assignment.
Set Workspace Calendar Free/Busy EventSetCalendarFree_BusyEventPOSTSet calendar free or busy event.
Update a reservationupdateReservationPATCHUpdates a reservation.
Update a workspaceupdateWorkspacePATCHUpdates workspace detail.
Update workspace settingsupdateWorkspaceSettingsPATCHUpdates workspace settings.
Zoom Room30
Add a Zoom RoomaddARoomPOSTUse this API to add a Zoom Room to a Zoom account.
Add a Zoom Room to a Zoom PhoneaddZoomRoomPOSTAssociates a Zoom Room with a Zoom Phone license.
Assign calling plans to a Zoom RoomassignCallingPlanToRoomPOSTAssigns calling plans to a Zoom Room with a maximum of 200 numbers at a time.
Assign phone numbers to a Zoom RoomassignPhoneNumberToZoomRoomPOSTAssigns phone numbers to a Zoom Room.
Change a Zoom Room's locationchangeZRLocationPUTAn 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 profilecreateRoomDeviceProfilePOSTCreates a Zoom Room device profile.
Delete a device profiledeleteRoomProfileDELETEDeletes a Zoom Room device profile.
Delete a Zoom RoomdeleteAZoomRoomDELETERemove a specific Zoom Room profile from a Zoom account.
Get a device profilegetRoomProfileGETReturns a Zoom Room device profile.
Get a Zoom Room under Zoom Phone licensegetZoomRoomGETSpecifies Zoom Room in an account with an assigned Zoom Phone license.
Get device informationgetRoomDevicesGETReturns information about a Zoom Room device.
Get Zoom Room profilegetZRProfileGETZoom 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 datagetZRSensorDataGETRetrieves the sensor data from the specified Zoom Room.
Get Zoom Room settingsgetZRSettingsGETGet information on meeting, alert, digital signage or scheduling display settings applied to a specific Zoom Room.
Get Zoom Rooms virtual controller URLgetWebzrcUrlGETGet the Zoom Rooms virtual controller URL.
List device profilesgetRoomProfilesGETReturns a list of Zoom Room device profiles.
List digital signage contentslistDigitalSignageContentGETUse this API to return information about a Zoom account's Zoom Rooms digital signage content.
List Zoom Room deviceslistZRDevicesGETList information about the devices that are being used for a specific Zoom Room in an account.
List Zoom RoomslistZoomRoomsGETZoom 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 licenselistZoomRoomsPhoneGETRetrieves a list of Zoom Rooms under the account that has the Zoom Phone license assigned.
List Zoom Rooms without Zoom Phone assignmentlistUnassignedZoomRoomsGETReturns Zoom Rooms that are not assigned a Zoom Phone.
Remove a calling plan from a Zoom RoomunassignCallingPlanFromRoomDELETEUse this API to unassign a calling plan from a Zoom Room.
Remove a phone number from a Zoom RoomUnassignPhoneNumberFromZoomRoomDELETEUse this API to unassign a phone number from a Zoom Room.
Remove a Zoom Room from a ZP accountRemoveZoomRoomDELETEUse this API to remove Zoom Room from a Zoom Phone account.
Update a device profileupdateDeviceProfilePATCHUpdates a Zoom Room device profile.
Update a Zoom Room profileupdateRoomProfilePATCHUpdate basic information on a specific Zoom Room in a Zoom account.
Update a Zoom Room under Zoom Phone licenseupdateZoomRoomPATCHUse this API to update a Zoom Room in an account that has the Zoom Phone license assigned.
Update E911 digital signagemanageE911signagePATCHDisplay or hide E911 emergency alert text content from Zoom Rooms digital signage.
Update Zoom Room settingsupdateZRSettingsPATCHUpdate meeting, alert, digital signage or scheduling display settings applied to a specific Zoom Room.
Use Zoom Room controlscheckInRoomsPATCHControls Zoom Rooms, including: Room check-in and check-out.
Zoom Rooms Account4
Get Zoom Room account profilegetZRAccountProfileGETGet details on the account profile of a Zoom Room.
Get Zoom Room account settingsgetZRAccountSettingsGETGet details on Account Settings of a Zoom Room.
Update Zoom Room account profileupdateZRAccProfilePATCHUpdate information on the account profile of a Zoom Room.
Update Zoom Room account settingsupdateZoomRoomAccSettingsPATCHUpdate account settings applied for Zoom Rooms in a Zoom account.
Zoom Rooms Calendar7
Add a calendar resource to a calendar serviceaddACalendarResourceToCalendarServicePOSTUse this API to add a calendar resource to a Microsoft Exchange or Office 365 calendar service in a Zoom Room account.
Delete a calendar resourcedeleteACalendarResourceDELETEDeletes a Zoom Room account's calendar resource from a Microsoft Exchange or Office 365 calendar service.
Delete a calendar servicedeleteACalendarServiceDELETEDeletes a Zoom Room account's calendar service.
Get a calendar resource by IDgetCalendarResourceByIdGETList Zoom Room account's calendar resource.
List calendar resources by calendar servicegetCalendarResourcesByServiceIdGETList all of a Zoom Room account's calendar resources.
List calendar servicesgetCalendarServicesGETList all the existing calendar services in a Zoom Room account.
Start calendar service sync processsyncACalendarServicePUTUse this API to kick off the sync process for Zoom Room account's calendar service.
Zoom Rooms Content31
Add a digital signage content folderAddadigitalsignagecontentfolderPOSTUse this API to add a Digital Signage Content folder.
Add a digital signage image or videoAdddigitalsignageimageorvideoPOSTUpload an image or video to the Zoom Rooms Digital Signage Content Library.
Add a Digital Signage library playlistAddaDigitalSignagelibraryplaylistPOSTUse this API to add a content library Digital Signage Playlist.
Add a digital signage URLAddadigitalsignageURLPOSTUse this API to add a URL to the Zoom Rooms digital signage content library.
Add Zoom Rooms background image library contentAddZoomRoomsBackgroundImageLibraryContentPOSTUpload an image to Zoom Room Content Library.
Add Zoom Rooms Background Image Library FolderAddZoomRoomsBackgroundLibraryFolderPOSTUse this API to add a Zoom Rooms background image library content folder.
Delete a Digital Signage content folderDeleteadigitalsignagecontentfolderDELETEUse this API to delete an individual digital signage content folder.
Delete a Digital Signage content itemDeleteadigitalsignagecontentitemDELETEUse this API to delete an individual digital signage content item.
Delete Digital Signage library playlistDeleteDigitalSignagelibraryplaylistDELETEDelete digital signage library playlist.
Delete Zoom Rooms Background Image Library ContentDeleteZoomRoomsBackgroundImageLibraryContentDELETEDeletes a Zoom Rooms background image library content item.
Delete Zoom Rooms Background Image Library FolderDeleteZoomRoomsBackgroundLibraryFolderDELETEDeletes a Zoom Rooms background image library content folder.
Get Digital Signage content folderGetdigitalsignagecontentfolderdetailsGETUse this API to get the details of an individual digital signage content folder.
Get Digital Signage content itemGetdigitalsignagecontentitemGETUse this API to get the details of an individual digital signage content item.
Get Digital Signage library playlistGetDigitalSignagelibraryplaylistGETReturns a Zoom Rooms content library digital signage playlist.
Get Digital Signage library playlist content itemsGetDigitalSignagelibraryplaylistcontentitemsGETReturns a Zoom Rooms content library digital signage playlist content items and their metadata.
Get Zoom Rooms background image library contentGetZoomRoomsBackgroundImageLibraryContentGETReturn a Zoom Rooms background image library content item.
Get Zoom Rooms Background Image Library FolderGetZoomRoomsBackgroundLibraryFolderGETReturns a Zoom Rooms background image library folder.
List default Zoom Rooms background image library contentsListDefaultZoomRoomsBackgroundImageLibrarycontentsGETDisplay a list of Zoom-provided default background images from the background image library.
List Digital Signage content itemsGETListdigitalsignagecontentitemsGETReturns a list of Zoom Rooms digital signage library base folder content items.
List Digital Signage library playlist published roomsListDigitalSignagelibraryplaylistpublishedroomsGETList Digital Signage library playlist published rooms.
List Digital Signage library playlistsListDigitalSignagelibraryplaylistsGETReturns a list of Zoom Rooms content library digital signage playlists.
List Zoom Rooms background image library contentsListZoomRoomsbackgroundimagelibrarycontentsGETReturns a list of Zoom Rooms background image library contents.
List Zoom Rooms Background Image Library FoldersListZoomRoomsBackgroundLibraryFoldersGETReturns a list of Zoom Rooms background image library content folders.
Update a digital signage content folderUpdateadigitalsignagecontentfolderPATCHUpdates a Digital Signage content folder’s attributes.
Update a Digital Signage content item attributesUpdateadigitalsignagecontentitemattributesPATCHUse this API to update a digital signage content item's attributes.
Update a Digital Signage image or video fileUpdateadigitalsignageimageorvideofilePUTUpdate an image or video content item in the Zoom Rooms digital signage content library.
Update a Digital Signage library playlistUpdateaDigitalSignagelibraryplaylistPATCHUpdates a Zoom Rooms content library digital signage playlist.
Update Digital Signage library playlist content itemsUpdateDigitalSignagelibraryplaylistcontentitemsPUTUpdates a Zoom Rooms content library digital signage playlist content items and their metadata.
Update Digital Signage library playlist published roomsUpdateDigitalSignagelibraryplaylistpublishedroomsPUTUpdate Digital Signage library playlist published rooms.
Update Zoom Rooms background image library contentUpdateZoomRoomsBackgroundImageLibraryContentPUTUpdate a Zoom Rooms background image library content.
Update Zoom Rooms Background Image Library FolderUpdateaZoomRoomsBackgroundLibraryFolderNamePATCHUpdates a Zoom Rooms background image library content folder.
Zoom Rooms Device2
Change Zoom Rooms app versionchangeZoomRoomsAppVersionPUTUse 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 devicedeleteDeviceRoomsDELETEDeletes a Zoom Room device.
Zoom Rooms Location10
Add a locationaddAZRLocationPOSTAdd a location to the location hierarchial structure(s) of Zoom Rooms in an account.
Change the assigned parent locationchangeParentLocationPUTAn account owner of a Zoom account can establish a Zoom Rooms Location Hierarchy to better organize Zoom Rooms spread across various locations.
Delete a locationdeleteAZRLocationDELETERemove a location from the location hierarchial structure(s) of Zoom Rooms in an account.
Get location settingsgetZRLocationSettingsGETGet information on meeting, alert, digital signage or scheduling display settings applied to Zoom Rooms located in a specific location.
Get Zoom Room location profilegetZRLocationProfileGETEach 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 structuregetZRLocationStructureGETGet the location hierarchial structure(s) applied on the Zoom Rooms in an account.
List Zoom Room locationslistZRLocationsGETA 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 settingsupdateZRLocationSettingsPATCHUpdate meeting, alert, digital signage or scheduling display settings applied to Zoom Rooms located in a specific location.
Update Zoom Room location profileupdateZRLocationProfilePATCHEach 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 structureupdateZoomRoomsLocationStructurePUTUpdate the location hierarchial structure(s) applied on the Zoom Rooms in an account.
Zoom Rooms Tag7
Assign Tags to a Zoom RoomAssignTagsToAZoomRoomPATCHUse this API to assign Tags to a Zoom Room
Assign Tags to Zoom Rooms By Location IDAssignTagsToZoomRoomsByLocationIDPATCHUse 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 TagcreateZoomRoomTagPOSTCreates a new Zoom Rooms Tag.
Delete TagdeleteZoomRoomTagDELETEDeletes Tag.
Edit TageditZoomRoomTagPATCHEdits Tag.
List all Zoom Room TagslistZoomRoomTagsGETList all Zoom Rooms Tags Prerequisites: A Pro or a higher plan with a Zoom Rooms license.
Un-assign Tags from a Zoom RoomunassignZoomRoomTagDELETEUn-assign Tags from a Zoom Room Prerequisites: A Pro or a higher plan with a Zoom Rooms license.