Integrations - Classic scopes
Existing apps will continue to use the previously available macro scopes, now called classic scopes. You can continue to upgrade your app with these scopes. See the OAuth scopes overview for details.
title: OAuth Scopes description: OAuth Scope List for Zoom API's
Account scopes
The following are the available Account scopes and their associated API calls:
account:master
View and manage sub accounts
Associated API
- Update the account owner
- Get sub account details
- Get account's managed domains
- List upcoming renewal accounts
- Delete virtual background files
- Create a sub account
- Update options
- Get plan usage
- Get account's trusted domains
- List sub accounts
- Disassociate a sub account
- Upload virtual background files
account:read:admin
View account info
Associated API
- Get locked settings
- Get indicators settings
- Get an account's webinar registration settings
- Get account settings
- Get account's managed domains
- Get account's trusted domains
- Get indicators settings [Deprecated]
account:write:admin
View and manage account info
Associated API
- Update locked settings
- Get locked settings
- Get indicators settings
- Update the account owner
- Upload virtual background files
- Update account settings
- Get indicators settings [Deprecated]
- Get an account's webinar registration settings
- Delete virtual background files
- Update an account's webinar registration settings
- Get account settings
Billing scopes
The following are the available Billing scopes and their associated API calls:
billing:master
View and manage sub account's billing info
Associated API
- Subscribe an account to a plan
- Get invoice details
- Cancel additional plans
- Generate sub accounts' billing invoice reports
- Get billing information
- Delete subaccounts' billing invoice report
- Subscribe subaccount to an additional plan
- Update an account's additional plan
- Download an invoice file
- Update a base plan
- List upcoming renewal accounts
- List billing invoices
- List sub accounts' billing invoice reports
- Download subaccounts' billing invoice reports
- Get account plan information
- Download an invoice file (v2)
- Cancel a base plan
- Update billing information
- Get plan usage
Calendar scopes
The following are the available Calendar scopes and their associated API calls:
calendar:read
View calendar
Associated API
- Get the specified user calendar settings of the authenticated user
- Get the color definitions for calendars and events
- Query freebusy information for a set of calendars
- List ACL rules of specified calendar
- List all user calendar settings of the authenticated user
- Get a specified calendar from the user's own calendarList
- Get the specified event on the specified calendar
- List events on the specified calendar
- List the calendars in the user's own calendarList
- Get the specified calendar
- List all instances of the specified recurring event
- Get the specified ACL rule
calendar:read:admin
View calendar
Associated API
- Get the specified calendar
- Get the specified event on the specified calendar
- Query freebusy information for a set of calendars
- List ACL rules of specified calendar
- Get the specified user calendar settings of the authenticated user
- List all user calendar settings of the authenticated user
- List all instances of the specified recurring event
- Get the color definitions for calendars and events
- Get the specified ACL rule
- List events on the specified calendar
- Get a specified calendar from the user's own calendarList
- List the calendars in the user's own calendarList
calendar:write
Manage calendar
Associated API
- Insert an existing calendar to the user's own calendarList
- Insert a new event to the specified calendar
- Quick add an event to the specified calendar
- Delete a calendar owned by a user
- Move the specified event from a calendar to another specified calendar
- Update the specified calendar
- Import event to the specified calendar
- Create a new secondary calendar
- Create a new ACL rule
- Delete an existing ACL rule
- Delete an existing calendar from the user's own calendarList
- Update the specified event on the specified calendar
- Update the specified ACL rule
- Update an existing calendar in the user's own calendarList
- Patch the specified user calendar settings of the authenticated user
- Delete an existing event from the specified calendar
calendar:write:admin
Manage calendar
Associated API
- Delete an existing ACL rule
- Create a new ACL rule
- Delete an existing event from the specified calendar
- Quick add an event to the specified calendar
- Delete an existing calendar from the user's own calendarList
- Update the specified event on the specified calendar
- Insert an existing calendar to the user's own calendarList
- Insert a new event to the specified calendar
- Create a new secondary calendar
- Update an existing calendar in the user's own calendarList
- Patch the specified user calendar settings of the authenticated user
- Import event to the specified calendar
- Update the specified ACL rule
- Update the specified calendar
- Delete a calendar owned by a user
- Move the specified event from a calendar to another specified calendar
Chat scopes
The following are the available Chat scopes and their associated API calls:
chat:read
View Chat Message Info
Associated API
- List shared space members
- List shared spaces
- List custom emojis
- Get file info
- List pinned history messages of channel
- Get a shared space
- List shared space channels
chat:read:admin
View Chat Message Info
Associated API
- List custom emojis
- List shared space channels
- Get a shared space
- List shared space members
- List pinned history messages of channel
- List shared spaces
chat:write
Manage Chat Message Info
Associated API
- Delete a shared space
- Create a shared space
- List shared space members
- Add a custom emoji
- Demote shared space administrators to members
- List custom emojis
- Promote shared space members to administrators
- Remove members from a shared space
- Delete a chat file
- Update shared space settings
- Transfer shared space ownership
- Move shared space channels
- List pinned history messages of channel
- Delete a custom emoji
- Get a shared space
- List shared space channels
- Perform operations on the message of channel
- Add members to a shared space
- List shared spaces
chat:write:admin
Manage Chat Message Info
Associated API
- List custom emojis
- Create a shared space
- Demote shared space administrators to members
- Add a custom emoji
- List shared spaces
- Promote shared space members to administrators
- Update shared space settings
- Remove members from a shared space
- Delete a custom emoji
- Add members to a shared space
- Get a shared space
- List shared space channels
- Delete a shared space
- List shared space members
- Transfer shared space ownership
chat_channel:read
View current user's team chat channels
Associated API
- Get a channel
- List channel members
- List channel members
- List channel administrators
- List the members of a mention group
- Search user's or account's channels
- Get a channel
- List channel mention groups
- List user's channels
chat_channel:read:admin
View all users' team chat channels
Associated API
- List channel activity logs
- List user's channels
- List channel members (Groups)
- Get a channel
- List channel mention groups
- Get a channel
- List channel members
- List channel administrators
- List account's public channels
- List channel activity logs
- Search user's or account's channels
- List channel members
- Get retention policy of a channel
chat_channel:read:member
View team chat channels as a member
Associated API
chat_channel:write
View and manage current user's team chat channels
Associated API
- List user's channels
- Batch demote channel administrators
- Leave a channel
- Perform operations on channels
- Join a channel
- Search user's or account's channels
- Add channel members to a mention group
- Update a channel
- Delete a channel mention group
- List channel members
- Invite channel members
- Batch delete channels
- Update a channel mention group information
- Create a channel mention group
- Promote channel members to administrators
- List channel members
- Batch remove members from a user's channel
- Invite channel members
- Get a channel
- Get a channel
- Delete a channel
- Batch remove members from a channel
- Update a channel
- Remove a member
- Remove a member
- Create a channel
- Delete a channel
- Remove channel mention group members
chat_channel:write:admin
View and manage all users' team chat channels
Associated API
- Get a channel
- Update a channel
- Batch remove members from a channel
- Delete a channel
- List channel members
- Get retention policy of a channel
- Remove a member
- Delete a channel
- List the members of a mention group
- Update retention policy of a channel
- Create a channel
- Join a channel
- Remove channel mention group members
- Search user's or account's channels
- Invite channel members (Groups)
- Invite channel members
- Batch demote channel administrators
- List channel members (Groups)
- Leave a channel
- List channel members
- Remove a member (group)
- Perform operations on channels
- Update a channel
- Add channel members to a mention group
- List user's channels
- Delete a channel mention group
- List account's public channels
- Batch delete channels
- Update a channel mention group information
- Promote channel members to administrators
- Remove a member
- Create a channel mention group
- Get a channel
- Batch remove members from a user's channel
- Invite channel members
chat_contact:read
View current user's team chat contact information
Associated API
chat_contact:write
Send Contact Invitation
Associated API
chat_contact:write:admin
Send contact invitation
Associated API
chat_event:write
Manage your chat event info
Associated API
chat_event:write:admin
Manage account's chat event info
Associated API
chat_history_legal_hold:read:admin
View Chat History Legal Hold Info
Associated API
- List legal hold files by given matter
- Download legal hold files for given matter
- List legal hold matters
chat_history_legal_hold:write:admin
Manage Chat History Legal Hold Info
Associated API
- Update legal hold matter
- List legal hold files by given matter
- Download legal hold files for given matter
- List legal hold matters
- Delete legal hold matters
- Add a legal hold matter
chat_message:read
View current user's team chat messages
Associated API
- Get a forwarded message
- Retrieve a thread
- Get a message
- List reminders
- List bookmarks
- List a user's chat sessions
- List scheduled messages
- List user's chat messages
chat_message:read:admin
View all users' team chat messages
Associated API
- Get a message
- Retrieve a thread
- List user's chat messages
- Get a forwarded message
- List a user's chat sessions
chat_message:write
View and manage current user's team chat messages
Associated API
- Mark message read or unread
- Create a reminder message
- Send a chat file
- Send a chat message
- React to a chat message
- Get a message
- List bookmarks
- Add or remove a bookmark
- Update a message
- Delete a reminder for a message
- Delete a scheduled message
- Delete a message
- Upload a chat file
- List scheduled messages
- List user's chat messages
- Get a forwarded message
chat_message:write:admin
View and manage all users' team chat messages
Associated API
- Get a forwarded message
- Mark message read or unread
- React to a chat message
- Delete a message
- Send a chat message
- Update a message
- Get a message
- Send a chat file
- List user's chat messages
- Upload a chat file
chat_migration:read:admin
View information about a chat history migration
Associated API
chat_migration:write:admin
Migrate chat history from another vendor
Associated API
- Migrate channel members
- Migrate 1:1 conversation or channel operations
- Migrate a chat channel
- Migrate chat message reactions
- Migrate chat messages
imchat:bot
Enable Chatbot within Zoom Team Chat Client
Associated API
imchat:read:admin
View all users history and channels
Associated API
imchat:write
Send a team chat message to a Zoom Team Chat user or channel
Associated API
Clips scopes
The following are the available Clips scopes and their associated API calls:
clips:read
View your clips information
Associated API
clips:read:admin
View your clips information
Associated API
- List clip comments
- Get collaborators of a clip
- Download a clip
- Transfer task status check
- Get a clip
- List all clips
clips:write
Manage your clips information
Associated API
- Delete a clip(soft delete)
- Remove the collaborator from a clip
- Initiate and complete the multipart file upload for a clip
- Upload clip multipart files
- Delete a comment
- Upload clip file
clips:write:admin
Manage your clips information
Associated API
- Transfer clips owner
- Remove the collaborator from a clip
- Initiate and complete the multipart file upload for a clip
- Upload clip file
- Delete a clip(soft delete)
- Delete a comment
- Upload clip multipart files
Conference Room Connector (CRC) scopes
The following are the available Conference Room Connector (CRC) scopes and their associated API calls:
apiconnector:master
This scope allows an app to view and manage sub account’s API Connector information
Associated API
- List API Connectors
- Get an API Connector
- Update an API Connector
- Create an API Connector
- Update an API Connector's private key
- Get an API Connector's private key
- Delete an API Connector
apiconnector:read:admin
This scope allow an app to view all API Connector information
Associated API
apiconnector:write:admin
This scope allow an app to view and manage all API Connector information
Associated API
- Update an API Connector
- Delete an API Connector
- Update an API Connector's private key
- Create an API Connector
crc:master
View and manage sub account's CRC configuration
Associated API
crc:read:admin
View and manage CRC configuration
Associated API
crc_account:master
View and manage all sub account's Cisco/Polycom room account setting
Associated API
crc_account:read:admin
View Cisco/Polycom rooms account setting
Associated API
crc_account:write:admin
View and manage Cisco/Polycom rooms account setting
Associated API
crc_rooms:master
View and manage sub account’s managed Cisco and Polycom rooms information
Associated API
- Delete a room template
- Update a Managed Room
- Update a Room Template
- Create a Managed Room
- Get a Managed Room
- Get a Room Template
- List Room Templates
- Delete a managed room
- List Managed Rooms
- Create a Room Template
crc_rooms:read:admin
View all managed Cisco and Polycom rooms information
Associated API
crc_rooms:write:admin
View and manage all managed Cisco and Polycom rooms information
Associated API
- Delete a room template
- Update a Room Template
- Create a Room Template
- Create a Managed Room
- Delete a managed room
- Update a Managed Room
Contact Center scopes
The following are the available Contact Center scopes and their associated API calls:
contact_center_attachment:read:admin
View your contact center attachment information
Associated API
contact_center_block_list_rules:write:admin
Edit Block List Rules
Associated API
- Delete phone numbers' block list rules
- Delete IP addresses' block list rules
- Create block list rules for IP addresses
- Create block list rules for phone numbers
contact_center_flow:write:admin
flow write
Associated API
- Delete a flow
- Edit a flow
- Publish a flow
- Remove flow entry points
- Import a flow
- Add flow entry points
contact_center_messaging:read:admin
Get message
Associated API
contact_center_messaging:write:admin
send message
Associated API
contact_center_outbound_campaign_dnc_list_phones:read:admin
Get campaign dnc list phone
Associated API
contact_center_outbound_campaign_dnc_list_phones:write:admin
Write campaign dnc list phone
Associated API
contact_center_routing_profile:write:admin
Edit agent routing profile.
Associated API
- Update an agent routing profile's details
- Update a consumer routing profile's details
- Delete an agent routing profile
- Delete a consumer routing profile
- Create an agent routing profile
- Create a consumer routing profile
contact_center_rtms:write:admin
Scope to control RTMS
Associated API
contact_center_team:read:admin
View your contact center team information
Associated API
- List teams
- List team's parent teams
- Get a team
- List team agents
- List a team's child teams
- List team supervisors
contact_center_team:write:admin
Manage your contact center team information
Associated API
- Create a team
- Assign team agents
- Delete a team
- Unassign team agents
- Assign team supervisors
- Update a team
- Move a team
- Unassign team supervisors
contact_center_user_template:read:admin
View all contact center user template’s details.
Associated API
contact_center_user_template:write:admin
View and manage all contact center user template's details.
Associated API
ContactCenter scopes
The following are the available ContactCenter scopes and their associated API calls:
contact_center_asset_library:read:admin
View your contact center asset library information
Associated API
contact_center_asset_library:write:admin
Manage your contact center asset library information
Associated API
- Create an asset
- Delete an asset
- Update an asset
- Delete an asset category
- Create an asset category
- Update an asset category
- Delete asset items
- Duplicate an asset
contact_center_contact:read:admin
View address book information
Associated API
- List address books
- Get an address book unit
- List address book units
- List a contact's custom fields
- List an address book's custom fields
- Get an address book
- Get an address book contact
- List address book contacts
- Get an address book's custom field
contact_center_contact:write:admin
Update address book information
Associated API
- Update an address book unit
- Update an address book contact
- Update an address book custom field
- Create an address book contact
- Create an address book unit
- Create an address book custom field
- Delete an address book contact
- Delete an address book custom field
- Delete an address book unit
- Delete an address book
- Create an address book
- Update an address book
contact_center_disposition:read:admin
View your contact center disposition information
Associated API
contact_center_disposition:write:admin
Manage your contact center disposition information
Associated API
- Create a disposition set
- Delete a disposition
- Update a disposition
- Delete a disposition set
- Update a disposition set
- Create a disposition
contact_center_engagement:read:admin
View all contact center engagement information
Associated API
contact_center_engagement:write:admin
Manage all contact center engagement information
Associated API
contact_center_flow:read:admin
View all contact center flow information
Associated API
- List the closures' flows
- Get available transfer flows
- List flows
- Export a flow
- List entry points
- List flow's entry points
- Get a flow
- List the business hours' flows
contact_center_inbox:read:admin
View all contact center inbox information
Associated API
- List an inbox's messages
- Get an inbox
- List inboxes
- List an account's inbox messages
- Get inbox email notification list
contact_center_inbox:write:admin
Manage all contact center inbox information
Associated API
- Update an inbox's email notification setting
- Update an inbox
- Delete an inbox's messages
- Delete inboxes
- Create an inbox
- Delete inbox messages
- Delete an inbox message
contact_center_note:read:admin
View all contact center note information
Associated API
contact_center_note:write
Manage all contact center note information
Associated API
contact_center_operating_hours:read:admin
View all contact center operating hours information
Associated API
contact_center_operating_hours:write:admin
Manage all contact center operating hours information
Associated API
- Create business hours
- Delete business hours
- Update business hours
- Create a closure set
- Delete a closure set
- Update a closure set
contact_center_operation_logs:read:admin
Read permission for Operation logs
Associated API
contact_center_outbound_campaign:delete:admin
Delete an Outbound Campaign.
Associated API
contact_center_outbound_campaign:read:admin
View an Outbound Campaign.
Associated API
contact_center_outbound_campaign:update:admin
Update an Outbound Campaign
Associated API
contact_center_outbound_campaign:write:admin
Create an Outbound Campaign
Associated API
contact_center_outbound_campaign_contactlist:read:admin
Get campaign contact list
Associated API
contact_center_outbound_campaign_contactlist:write:admin
Create campaign contact list
Associated API
- Create a campaign contact list
- Update a campaign contact list
- Batch update campaign contact lists
- Remove a campaign contact list
contact_center_outbound_campaign_contacts:read:admin
Get campaign contact list contact
Associated API
contact_center_outbound_campaign_contacts:write:admin
Create campaign contact list contact
Associated API
- Update contact on a campaign contact list
- Remove campaign contact list's contact
- Create a campaign contact list's contact
- Update a batch of contacts on a campaign contact list
contact_center_preference:read:admin
View your contact center preference information
Associated API
contact_center_preference:write:admin
Manage your contact center preference information
Associated API
contact_center_queue:read:admin
View your contact center queue information
Associated API
- Get available transfer queues
- List a queue's scheduled callbacks availability
- List queue templates
- List queue disposition sets
- Get a closure set
- Get a queue template
- List closures
- List queue dispositions
- Get a queue's interrupt settings
- List business hours
- List queue agents
- Get inbox access queues
- List the business hours' queues
- Get a queue
- List the closures' queues
- Get a queue's operating hours
- List queue supervisors
- Get business hours
- List queues
contact_center_queue:write:admin
Manage your contact center queue information
Associated API
- Opt-in or opt-out a user's queues
- Assign a queue menu based interrupt
- Assign queue supervisors
- Assign queue dispositions
- Update a queue
- Batch create queues with a template
- Unassign a queue team
- Update a queue's operating hours
- Create business hours
- Batch delete queues
- Assign queue teams
- Unassign a queue disposition set
- Remove inbox access queues
- Assign inbox access queues
- Unassign a queue agent
- Delete an attendee from a scheduled callback event
- Update a queue's interrupt settings
- Delete a queue's interrupt menu configuration
- Unassign queue teams
- Assign queue agents
- Unassign a queue disposition
- Unassign a queue supervisor
- Delete a queue
- Create a closure set
- Update a queue agent's opt-in/opt-out status
- Create a queue
- Assign queue disposition sets
- Schedule a callback on a queue
contact_center_recording:read
View your contact center recording information.
Associated API
contact_center_recording:read:admin
View all contact center recording information
Associated API
contact_center_recording:write:admin
Manage all contact center recording information
Associated API
contact_center_region:read:admin
View all contact center region information
Associated API
contact_center_region:write:admin
Manage all contact center region information
Associated API
contact_center_report:read:admin
View all contact center report information
Associated API
- List historical queue's agents reports
- List agent's status history reports
- List historical queue performance dataset data
- List historical engagement log data
- Get an engagement
- List historical queue reports
- Get an engagement's events
- List historical flow performance dataset data
- List historical expert assist dataset data
- List historical agent timecard dataset data
- List historical agent performance dataset data
- List historical detail reports
- List historical engagement dataset data
- List historical outbound dialer performance dataset data
- List historical disposition dataset data
- List agent leg reports
- List agent's time sheet reports
- List historical agent reports by queue
- List engagements
- List historical Zoom Phone to Contact Center call journey data
contact_center_role:read:admin
View your contact center role information
Associated API
contact_center_role:write:admin
Manage your contact center role information
Associated API
- Delete a role
- Assign a role
- Delete role privileges
- Update a role
- Unassign a user from a role
- Create a role
- Duplicate a role
contact_center_routing_profile:read:admin
View routing profile information.
Associated API
- List agent routing profiles
- Get an agent routing profile
- Get a consumer routing profile
- List consumer routing profiles
contact_center_skill:read:admin
View all contact center skill information
Associated API
contact_center_skill:write:admin
Manage all contact center skill information
Associated API
- Delete a skill category
- Update a skill
- Update a skill category
- Unassign a user's skill
- Assign a user's skills
- Create a skill
- Create a skill category
- Delete a skill
contact_center_sms:master
View sub account’s SMS log information
Associated API
contact_center_sms:read:admin
View all contact center SMS log information
Associated API
contact_center_user:read:admin
View all contact center user’s details
Associated API
- List users of a skill
- Get a user's profile
- List user's devices
- List a user's queues
- List user templates
- List user profiles
- Get available transfer users
- Get an inbox's users
contact_center_user:write:admin
View and manage all contact center user's details
Associated API
- Update a user's status
- Assign inbox access users
- Batch update user status
- Batch delete user profiles
- Batch create user profiles
- Batch update user profiles
- Update a user's profile
- Delete a user's profile
- Create a user's profile
- Command control of a user
- Unassign inbox access users
contact_center_variable:read:admin
View all contact center variable information
Associated API
contact_center_variable:write:admin
Manage all contact center variable information
Associated API
- Create a variable
- Create a variable group
- Update a variable
- Update a variable group
- Delete a variable
- Delete a variable group
contact_center_variable_log:read:admin
View variable log information
Associated API
contact_center_variable_log:write:admin
Manage variable log information
Associated API
contact_center_voice_call:master
View sub account’s voice call information
Associated API
contact_center_voice_call:read:admin
view voice call information
Associated API
Contacts scopes
The following are the available Contacts scopes and their associated API calls:
contact:read
View current user's contacts
Associated API
contact:read:admin
View all users' contacts
Associated API
Dashboard scopes
The following are the available Dashboard scopes and their associated API calls:
dashboard:master
View sub account's Dashboard data
Associated API
- Get issues of Zoom Rooms
- List webinars
- Get meeting sharing/recording details
- Get meeting quality scores
- List client meeting satisfaction
- Get CRC port usage
- Get post meeting feedback
- List meeting participants QoS Summary
- Get chat metrics
- Get Zoom Rooms details
- Get webinar sharing/recording details
- Get zoom meetings client feedback
- List the client versions
- Get webinar details
- Get webinar participants
- List Zoom meetings client feedback
- List webinar participants QoS Summary
- Get meeting participant QoS
- List Zoom Rooms
- Get webinar participant QoS
- Get meeting details
- Get post webinar feedback
- List meeting participants QoS
- Get top 25 issues of Zoom Rooms
- List meeting participants
- List webinar participant QoS
- Get top 25 Zoom Rooms with issues
dashboard:read:admin
View Dashboard data
Associated API
- Get issues of Zoom Rooms
- List webinars
- Get meeting sharing/recording details
- Get meeting quality scores
- Get chat metrics
- Get top 25 issues of Zoom Rooms
- List Zoom Rooms
- List meeting participants QoS Summary
- Get webinar participant QoS
- Get CRC port usage
- List Zoom meetings client feedback
- List webinar participants QoS Summary
- List webinar participant QoS
- List the client versions
- Get meeting participant QoS
- Get webinar details
- Get webinar participants
- List meetings
- List meeting participants QoS
- Get post webinar feedback
- Get meeting details
- Get Zoom Rooms details
- Get webinar sharing/recording details
- List meeting participants
- Get zoom meetings client feedback
- Get top 25 Zoom Rooms with issues
- Get post meeting feedback
- List client meeting satisfaction
dashboard_crc:read:admin
View all users' usage statistics of CRC
Associated API
dashboard_home:read:admin
View overview of usage statistics for Meetings and Zoom Rooms
Associated API
- Get issues of Zoom Rooms
- Get top 25 Zoom Rooms with issues
- List client meeting satisfaction
- List Zoom meetings client feedback
- Get zoom meetings client feedback
- Get meeting quality scores
- List the client versions
dashboard_im:read:admin
View all users' usage statistics of team chat messages and message types
Associated API
dashboard_meetings:read:admin
View all users' meetings information on Dashboard
Associated API
- List meeting participants QoS Summary
- List meeting participants QoS
- Get post meeting feedback
- Get meeting participant QoS
- Get meeting sharing/recording details
- List meeting participants
- List meetings
- Get meeting details
dashboard_webinars:read:admin
View all users' webinar information on Dashboard
Associated API
- Get webinar participants
- Get webinar sharing/recording details
- List webinars
- Get webinar participant QoS
- List webinar participant QoS
- Get post webinar feedback
- List webinar participants QoS Summary
- Get webinar details
dashboard_zr:read:admin
View all users' Zoom Room usage statistics and information
Associated API
Device scopes
The following are the available Device scopes and their associated API calls:
device:read:admin
Manage device
Associated API
- Get Zoom Phone Appliance settings by user ID
- Get device detail
- Get ZPA version info
- Get ZDM group info
- List devices
device:write:admin
View and manage device
Associated API
- Get device detail
- Assign a device to a user or commonarea
- List devices
- Delete device
- Add new device
- Assign a device to a group
- Change device
- Upgrade ZPA firmware or app
- Delete ZPA device by vendor and mac address
- Change device association
Devices (H323) scopes
The following are the available Devices (H323) scopes and their associated API calls:
h323:master
View and manage sub account's H.323 devices
Associated API
- Delete a H.323/SIP device
- Update a H.323/SIP device
- List all H.323/SIP devices
- Create a H.323/SIP device
h323:read:admin
View all users' H.323 devices
Associated API
h323:write:admin
View and manage all users' H.323 devices
Associated API
Docs scopes
The following are the available Docs scopes and their associated API calls:
docs:delete
Delete a file
Associated API
docs:delete:admin
Delete a file
Associated API
docs:read:admin
Get basic info of the file
Associated API
docs:write:admin
Edit basic info of a file
Associated API
docs_collaborator:delete
Remove collaborators of a file
Associated API
docs_collaborator:delete:admin
Remove collaborators of a file
Associated API
docs_collaborator:read
Get collaborators of a file
Associated API
docs_collaborator:read:admin
Get collaborator of a file
Associated API
docs_collaborator:write
scope to manage collaborator in Docs
Associated API
docs_collaborator:write:admin
scope for admin to manage collaborators
Associated API
docs_export:read
Get file export status
Associated API
docs_export:write
Create a file export
Associated API
docs_file_uploads:write
Create a file upload
Associated API
docs_file_uploads:write:admin
Create a file upload
Associated API
docs_general_access:read
Get general access of a file
Associated API
docs_general_access:read:admin
Get general access of a file
Associated API
docs_general_access:write
Update general access of a file
Associated API
docs_general_access:write:admin
Update general access of a file
Associated API
docs_import:read
Get import task status
Associated API
docs_import:read:admin
Get import task status
Associated API
docs_import:write
Create new file by import
Associated API
docs_import:write:admin
Create new file by import
Associated API
Group scopes
The following are the available Group scopes and their associated API calls:
group:master
View and manage sub account's groups
Associated API
- Get locked settings
- Get a group's webinar registration settings
- Update a group's webinar registration settings
- Update locked settings
- List group members
- Upload Virtual Background files
- Delete a group admin
- Get a group
- List group channels
- Update a group member
- List groups
- Create a group
- List group admins
- Update a group's settings
- Add group members
- Get a group's settings
- Delete Virtual Background files
- Add group admins
- Delete a group member
- Delete a group
- Update a group
group:read:admin
View groups
Associated API
- List group members
- Get a group's settings
- List groups
- List group admins
- Get a group's webinar registration settings
- List group channels
- Get locked settings
- Get a group
group:write:admin
View and manage groups
Associated API
- Get a group
- Update a group
- List group members
- Update a group's webinar registration settings
- Add group members
- Delete a group admin
- Get locked settings
- List group admins
- Create a group
- Update a group's settings
- List groups
- Delete a group
- Delete Virtual Background files
- Add group admins
- Upload Virtual Background files
- Get a group's settings
- Get a group's webinar registration settings
- Delete a group member
- List group channels
- Update a group member
- Update locked settings
IM Group scopes
The following are the available IM Group scopes and their associated API calls:
contact_group:read:admin
View all contact group information
Associated API
contact_group:write:admin
Manage all contact group information
Associated API
- Add contact group members
- Remove members in a contact group
- Get a contact group
- Update a contact group
- Delete a contact group
- Create a contact group
imgroup:master
View and manage sub account's Zoom Team Chat Groups
Associated API
- Retrieve an IM directory group
- List IM directory groups
- Add IM directory group members
- Delete an IM directory group
- Update an IM directory group
- Delete IM directory group member
- List IM directory group members
- Create an IM directory group
imgroup:read:admin
View Zoom Team Chat Group information
Associated API
imgroup:write:admin
View and manage Zoom Team Chat Groups
Associated API
- Delete an IM directory group
- Create an IM directory group
- Update an IM directory group
- List IM directory group members
- List IM directory groups
- Retrieve an IM directory group
- Add IM directory group members
- Delete IM directory group member
Integration Healthcare scopes
The following are the available Integration Healthcare scopes and their associated API calls:
clinical_note:read:admin
Read Clinical Notes
Associated API
- [Get a Clinical Note](/docs/api/rest/reference/Integration Healthcare/methods/#operation/GetaClinicalNote)
- [List clinical notes](/docs/api/rest/reference/Integration Healthcare/methods/#operation/GetClinicalNote)
clinical_note:update:admin
Update Clinical Notes
Associated API
- [Update a Clinical Note](/docs/api/rest/reference/Integration Healthcare/methods/#operation/UpdateClinicalNote)
Mail scopes
The following are the available Mail scopes and their associated API calls:
mail:read
Read user’s own mailbox content.
Associated API
- Get the specified attachment for an email
- List labels in the mailbox
- Get the specified email thread
- Get the mailbox profile
- List email threads from the mailbox
- Get the specified draft email
- List delegates on the mailbox
- Get the specified email
- List history of events for mailbox
- List email filters
- Get the specified email filter
- Get the specified delegate on the mailbox
- Get mailbox vacation response setting
- List emails from draft folder
- Get the specified label in mailbox
- List emails from the mailbox
mail:read:admin
Read all mailboxes' content under the account, and account level settings.
Associated API
- Get the mailbox profile
- Get the specified attachment for an email
- Get the specified email filter
- Get the specified email
- Get the specified draft email
- Get mailbox vacation response setting
- Get the specified label in mailbox
- List emails from draft folder
- Get the specified delegate on the mailbox
- List emails from the mailbox
- List labels in the mailbox
- Get the specified email thread
- List history of events for mailbox
- List email filters
- List email threads from the mailbox
- List delegates on the mailbox
mail:write
Read and write user’s own mailbox content.
Associated API
- Delete an existing email thread
- Create a new draft email
- Create a new email
- Delete an existing label from mailbox
- Grant a new delegate access on the mailbox
- Send out a draft email
- Update mailbox vacation response setting
- Batch modify the specified emails
- Delete an existing draft email
- Revoke an existing delegate access from the mailbox
- Update the specified draft email
- Create a new label in mailbox
- Patch the specified label in mailbox
- Send out an email
- Move the specified thread out of TRASH folder
- Delete an existing email
- Move the specified thread to TRASH folder
- Update the specified label in mailbox
- Update the specified email
- Update the specified thread
- Batch delete the specified emails
- Move the specified email to TRASH folder
- Move the specified email out of TRASH folder
- Create an email filter
- Delete the specified email filter
mail:write:admin
Read and write all mailboxes' content under the account, and account level settings.
Associated API
- Update mailbox vacation response setting
- Delete an existing label from mailbox
- Move the specified thread to TRASH folder
- Update the specified thread
- Revoke an existing delegate access from the mailbox
- Move the specified email out of TRASH folder
- Delete an existing email thread
- Batch modify the specified emails
- Create a new draft email
- Update the specified draft email
- Patch the specified label in mailbox
- Move the specified email to TRASH folder
- Update the specified label in mailbox
- Delete an existing draft email
- Send out a draft email
- Update the specified email
- Send out an email
- Create a new email
- Create an email filter
- Move the specified thread out of TRASH folder
- Delete an existing email
- Delete the specified email filter
- Create a new label in mailbox
- Grant a new delegate access on the mailbox
- Batch delete the specified emails
Marketplace scopes
The following are the available Marketplace scopes and their associated API calls:
marketplace_app:master
View and manage sub accounts' marketplace app info
Associated API
marketplace_app:read
View your marketplace app information
Associated API
- Get information about an app
- Get a user's app requests
- Validate an app manifest
- Export an app manifest from an existing app
- Get webhook logs
marketplace_app:read:admin
View marketplace app information for the account
Associated API
- Export an app manifest from an existing app
- Get a user's app requests
- Get an app's user requests
- Get webhook logs
- Validate an app manifest
- Get information about an app
- List apps
marketplace_app:write
Edit marketplace app
Associated API
marketplace_app:write:admin
View and Manage marketplace app information for the account
Associated API
- Enable or disable user app subscription
- Update app pre approval setting
- Add app allow requests for users
- Generate Zoom App Deeplink
- Update an app by manifest
- Create apps
- Update app's request status
- Deletes an app
marketplace_custom_fields:read
Read custom field values
Associated API
marketplace_custom_fields:read:admin
Read custom field values
Associated API
marketplace_entitlement:read
View entitlements
Associated API
marketplace_entitlement:read:admin
View entitlements
Associated API
Meeting scopes
The following are the available Meeting scopes and their associated API calls:
information_barriers:read:admin
View information barriers
Associated API
information_barriers:read:master
View information barriers
Associated API
information_barriers:write:admin
View and manage information barriers
Associated API
- Remove an Information Barrier policy
- Create an Information Barrier policy
- Update an Information Barriers policy
information_barriers:write:master
View and manage information barriers
Associated API
- Remove an Information Barrier policy
- Create an Information Barrier policy
- Update an Information Barriers policy
meeting:master
View and manage sub account's user meetings
Associated API
- List meeting registrants
- List meeting templates
- Update livestream status
- List registration questions
- Add a meeting registrant
- Create a meeting template from an existing meeting
- List past meeting instances
- Get a meeting
- In-meeting controls
- List meetings
- Get a meeting survey
- Update a meeting survey
- Delete a meeting registrant
- List meeting polls
- Create a meeting's invite links
- Get livestream details
- Update registration questions
- Get a meeting registrant
- Update registrant's status
- Get meeting invitation
- Perform batch registration
- Update a meeting poll
- Get a meeting poll
- Delete a meeting survey
- Delete a meeting poll
- Update a meeting
- Delete a meeting
- Update meeting status
- Create a meeting
- Update a livestream
- Get meeting's token
- Create a meeting poll
- Perform batch poll creation
meeting:read
View your meetings
Associated API
- Get livestream details
- List past meeting instances
- Get a meeting survey
- Get a meeting registrant
- Get a meeting
- List past meeting's poll results
- Get past meeting details
- List past meetings' Q&A
- List meeting templates
- Get past meeting participants
- List registration questions
- Get meeting invitation
- List meeting registrants
- Get a meeting poll
- List meeting polls
- List upcoming meetings
- Get meeting's token
- List meetings
meeting:read:admin
View all user meetings
Associated API
- List meetings
- Get livestream details
- List past meeting's poll results
- List meeting polls
- Get a meeting survey
- List past meetings' Q&A
- List past meeting instances
- Get past meeting participants
- Get a meeting
- Get past meeting details
- List meeting templates
- List meeting registrants
- List upcoming meetings
- List registration questions
- Get meeting's token
- Get meeting invitation
- Get a meeting registrant
- Get a meeting poll
meeting:write
View and manage your meetings
Associated API
- Update registrant's status
- Add a meeting app
- Update livestream status
- Add a meeting registrant
- Delete a meeting poll
- Update a meeting poll
- Delete a meeting survey
- Delete a meeting registrant
- Delete a live meeting message
- Update registration questions
- Create a meeting poll
- Perform batch poll creation
- Create a meeting
- Perform batch registration
- In-meeting controls
- Delete a meeting app
- Create a meeting's invite links
- Update a livestream
- Update a meeting survey
- Update meeting status
- Delete a meeting
- Create a meeting template from an existing meeting
- Update participant Real-Time Media Streams (RTMS) app status
- Update a live meeting message
- Update a meeting
meeting:write:admin
View and manage all user meetings
Associated API
- Update a livestream
- Perform batch registration
- Create a meeting template from an existing meeting
- Delete a meeting app
- Create a meeting's invite links
- Update a meeting survey
- Update meeting status
- Delete a live meeting message
- Update a live meeting message
- Update participant Real-Time Media Streams (RTMS) app status
- Delete a meeting
- Update a meeting
- Create a meeting poll
- Delete a meeting survey
- Add a meeting app
- Update livestream status
- Add a meeting registrant
- Delete a meeting registrant
- Delete a meeting poll
- Perform batch poll creation
- Create a meeting
- In-meeting controls
- Update registrant's status
- Update a meeting poll
- Update registration questions
meeting:write:admin:sip_dialing
Get CRC dial string with passcode
Associated API
meeting:write:sip_dialing
Get CRC dial string with passcode
Associated API
meeting_summary:master
View and manage sub account's user meeting summaries
Associated API
- Get a meeting or webinar summary
- List an account's meeting or webinar summaries
- Delete a meeting or webinar summary
meeting_summary:read
View your meeting summaries
Associated API
meeting_summary:read:admin
View all user meeting summaries
Associated API
meeting_token:read:admin:live_streaming
View live streaming meeting token information
Associated API
meeting_token:read:admin:local_archiving
View local archiving meeting token information
Associated API
meeting_token:read:admin:local_recording
This scope allows an app to view an account's users' local recording meeting token information
Associated API
meeting_token:read:live_streaming
View live streaming meeting token information
Associated API
meeting_token:read:local_recording
This scope allows an app to view a user's local recording meeting token information
Associated API
NumberManagement scopes
The following are the available NumberManagement scopes and their associated API calls:
number_management_numbers:read:admin
View all phone number detail in "Number Management".
Associated API
- [List peering phone numbers for provider](/docs/api/rest/reference/Number Management/methods/#operation/Listpeeringphonenumbersforprovider)
- [Get an SMS campaign](/docs/api/rest/reference/Number Management/methods/#operation/GetSMSCampaign)
- [List SMS consent policies](/docs/api/rest/reference/Number Management/methods/#operation/ListSMSConsents)
- [Get an SMS consent policy](/docs/api/rest/reference/Number Management/methods/#operation/GetSMSConsent)
- [List phone number plan information](/docs/api/rest/reference/Number Management/methods/#operation/Listphonenumberplaninformation)
- [List SMS campaigns](/docs/api/rest/reference/Number Management/methods/#operation/listAccountSMSCampaigns)
- [List peering phone numbers](/docs/api/rest/reference/Number Management/methods/#operation/listPeeringPhoneNumbers)
- [List phone numbers](/docs/api/rest/reference/Number Management/methods/#operation/listPhoneNumbers)
- [Get ported numbers details](/docs/api/rest/reference/Number Management/methods/#operation/Getportednumbersdetails)
- [List ported numbers](/docs/api/rest/reference/Number Management/methods/#operation/Listportednumbers)
- [List SIP groups](/docs/api/rest/reference/Number Management/methods/#operation/ListSIPgroups)
- [List BYOC SIP trunks](/docs/api/rest/reference/Number Management/methods/#operation/ListBYOCSIPtrunks)
- [Get a phone number](/docs/api/rest/reference/Number Management/methods/#operation/getPhoneNumber)
- [List phone numbers assigned to SMS consent policy](/docs/api/rest/reference/Number Management/methods/#operation/ListConsentPhoneNumbers)
number_management_numbers:read:master
View and manage sub account's phone number detail in "Number Management".
Associated API
- [List SMS campaigns](/docs/api/rest/reference/Number Management/ma/#operation/listAccountSMSCampaigns)
- [List phone number plan information](/docs/api/rest/reference/Number Management/ma/#operation/Listphonenumberplaninformation)
- [List peering phone numbers for provider](/docs/api/rest/reference/Number Management/ma/#operation/Listpeeringphonenumbersforprovider)
- [List peering phone numbers](/docs/api/rest/reference/Number Management/ma/#operation/listPeeringPhoneNumbers)
- [Get an SMS consent policy](/docs/api/rest/reference/Number Management/ma/#operation/GetSMSConsent)
- [List SMS consent policies](/docs/api/rest/reference/Number Management/ma/#operation/ListSMSConsents)
- [List phone numbers](/docs/api/rest/reference/Number Management/ma/#operation/listPhoneNumbers)
- [Get an SMS campaign](/docs/api/rest/reference/Number Management/ma/#operation/GetSMSCampaign)
- [List SIP groups](/docs/api/rest/reference/Number Management/ma/#operation/ListSIPgroups)
- [List phone numbers assigned to SMS consent policy](/docs/api/rest/reference/Number Management/ma/#operation/ListConsentPhoneNumbers)
- [Get ported numbers details](/docs/api/rest/reference/Number Management/ma/#operation/Getportednumbersdetails)
- [List ported numbers](/docs/api/rest/reference/Number Management/ma/#operation/Listportednumbers)
- [List BYOC SIP trunks](/docs/api/rest/reference/Number Management/ma/#operation/ListBYOCSIPtrunks)
- [Get a phone number](/docs/api/rest/reference/Number Management/ma/#operation/getPhoneNumber)
number_management_numbers:write:admin
Manage phone number detail in "Number Management".
Associated API
- [Unassign phone numbers from SMS consent policy](/docs/api/rest/reference/Number Management/methods/#operation/UnassignPhoneNumbersFromConsent)
- [Remove peering phone numbers](/docs/api/rest/reference/Number Management/methods/#operation/deletePeeringPhoneNumbers)
- [Unassign phone number from SMS campaign](/docs/api/rest/reference/Number Management/methods/#operation/unassignCampaignPhoneNumber)
- [Update an SMS consent policy](/docs/api/rest/reference/Number Management/methods/#operation/UpdateSMSConsent)
- [Allocate/Unallocate phone numbers](/docs/api/rest/reference/Number Management/methods/#operation/AllocateNumber)
- [Add peering phone numbers](/docs/api/rest/reference/Number Management/methods/#operation/addPeeringPhoneNumbers)
- [Assign phone numbers to SMS consent policy](/docs/api/rest/reference/Number Management/methods/#operation/AssignPhoneNumbersToConsent)
- [Update a phone number](/docs/api/rest/reference/Number Management/methods/#operation/updatePhoneNumberDetail)
- [Create an SMS consent policy](/docs/api/rest/reference/Number Management/methods/#operation/CreateSMSConsent)
- [Add BYOC phone numbers](/docs/api/rest/reference/Number Management/methods/#operation/AddBYOCPhoneNumber)
- [Delete SMS consent policies](/docs/api/rest/reference/Number Management/methods/#operation/DeleteSMSConsents)
- [Assign a phone number to SMS campaign](/docs/api/rest/reference/Number Management/methods/#operation/assignCampaignPhoneNumbers)
- [Update peering phone numbers](/docs/api/rest/reference/Number Management/methods/#operation/updatePeeringPhoneNumbers)
number_management_numbers:write:master
Manage sub account's phone number detail in "Number Management".
Associated API
- [Add BYOC phone numbers](/docs/api/rest/reference/Number Management/ma/#operation/AddBYOCPhoneNumber)
- [Assign phone numbers to SMS consent policy](/docs/api/rest/reference/Number Management/ma/#operation/AssignPhoneNumbersToConsent)
- [Create an SMS consent policy](/docs/api/rest/reference/Number Management/ma/#operation/CreateSMSConsent)
- [Delete phone numbers](/docs/api/rest/reference/Number Management/ma/#operation/DeleteNumbers)
- [Unassign phone numbers from SMS consent policy](/docs/api/rest/reference/Number Management/ma/#operation/UnassignPhoneNumbersFromConsent)
- [Delete SMS consent policies](/docs/api/rest/reference/Number Management/ma/#operation/DeleteSMSConsents)
- [Update a phone number](/docs/api/rest/reference/Number Management/ma/#operation/updatePhoneNumberDetail)
- [Allocate/Unallocate phone numbers](/docs/api/rest/reference/Number Management/ma/#operation/AllocateNumber)
- [Assign a phone number to SMS campaign](/docs/api/rest/reference/Number Management/ma/#operation/assignCampaignPhoneNumbers)
- [Remove peering phone numbers](/docs/api/rest/reference/Number Management/ma/#operation/deletePeeringPhoneNumbers)
- [Update peering phone numbers](/docs/api/rest/reference/Number Management/ma/#operation/updatePeeringPhoneNumbers)
- [Update an SMS consent policy](/docs/api/rest/reference/Number Management/ma/#operation/UpdateSMSConsent)
- [Add peering phone numbers](/docs/api/rest/reference/Number Management/ma/#operation/addPeeringPhoneNumbers)
- [Unassign phone number from SMS campaign](/docs/api/rest/reference/Number Management/ma/#operation/unassignCampaignPhoneNumber)
PAC scopes
The following are the available PAC scopes and their associated API calls:
pac:master
Associated API
pac:read
View your audio conference info
Associated API
pac:read:admin
View all users' audio conference info
Associated API
Phone scopes
The following are the available Phone scopes and their associated API calls:
phone:master
View and manage all sub accounts' Zoom Phone information
Associated API
- Delete an extension's inbound block rule
- Delete users from a directory
- Get device details
- Get a list of monitoring groups on an account
- Update a user's profile
- Unassign a member
- Add audio items
- Update user policy
- Add a Zoom Room to a Zoom Phone
- Update user level outbound calling exception rule
- Update an emergency address
- Get call log details
- Update an SLG policy setting
- List call logs
- Get an auto receptionist
- Delete a blocked list
- List auto receptionists
- Assign a phone number to a user
- Download a phone recording transcript
- Add a policy subsetting to a call queue
- Update account level outbound calling countries or regions
- Add a client code to a call history
- Assign phone numbers to a common area
- Get extension's fax logs
- Unassign a calling plan from the common area
- Get blocked list details
- Remove a member from a private directory
- Add phone numbers for users' customized outbound caller ID
- Delete a call queue
- List real time location for IP phones
- Delete a shared line group
- Create a call queue
- List opt statuses of phone numbers assigned to SMS campaign
- Update the group call pickup information
- Add members to roles
- Get common area settings
- Sync user's call history
- List setting templates
- Get call QoS
- Update a user's shared access setting
- List customized outbound caller ID phone numbers
- List users' phone numbers for a customized outbound caller ID
- Get user voicemail details from a call log
- Get group policy details
- Delete an audio item
- Get user level outbound calling countries and regions
- Update an alert setting
- Delete a device
- Create a blocked list
- Assign an entity to a device
- Update Recording Status
- Remove a Zoom Room from a ZP account
- Get account's call logs
- Delete an account's inbound blocked statistics
- Get fax charges usage report
- List phone users
- Update Voicemail Read Status
- Update a shared line group policy
- Update a provision template
- Delete common area level outbound calling exception rule
- Delete directory backup routing rule
- Assign numbers to a call queue
- List call queues
- Add a site setting
- Add a setting template
- Get emergency address details
- List audio items
- Update an audio item
- Get call queue recordings
- List Zoom Rooms without Zoom Phone assignment
- Add peering phone numbers
- Delete fax log
- Apply template to common areas
- Update phone account settings
- Generate activation codes for common areas
- Update a shared line group
- Delete an emergency location
- List an extension's inbound block rules
- Remove a calling plan from a Zoom Room
- Get phone account settings
- List plan information
- Remove members from call pickup group
- Update common area level outbound calling exception rule
- Get a phone number
- Add BYOC phone numbers
- Update account policy
- Update Auto Delete Field
- List nomadic emergency services users
- Get alert setting details
- Add members to a monitoring group
- Add an external contact
- Delete a user's call log
- Unassign all phone numbers
- Get a Zoom Room under Zoom Phone license
- Delete site level outbound calling exception rule
- The list of shared line groups
- Delete an emergency address
- List activation codes
- Batch add emergency service locations
- List phone numbers
- Send fax
- List emergency addresses
- List firmware update rules
- Get call recordings
- Update a phone number
- Update user level outbound calling countries or regions
- Unassign all phone numbers
- Update a device
- Unassign a member from a shared line group
- Update an auto receptionist policy
- Sync user's call logs
- Add an emergency address
- Add a policy setting to a shared line group
- Get account policy details
- List common areas
- Delete an external contact
- List shared line appearances
- List ported numbers
- Unassign members from a shared line group
- Get a provision template
- Get user's recordings
- Upload fax file
- Delete a monitoring group
- Get account's fax logs
- Update a phone role
- Delete a common area
- Sync SMS by session ID
- Add common area level outbound calling exception rule
- Get members of a monitoring group
- Get call details from call log
- Add members to a call queue
- List blocked lists
- List tracked locations
- Update common area pin code
- Get a phone site setting
- Add phone numbers for an account's customized outbound caller ID
- List BYOC SIP trunks
- Get SMS session details
- Get call queue details
- List users in directory
- Reboot a desk phone
- Update opt statuses of phone numbers assigned to SMS campaign
- Get monitoring group by ID
- Get user's SMS sessions
- Batch update device line key position
- Delete a user's shared access setting
- Unassign an entity from the device
- Assign phone numbers
- Update emergency service location
- Assign a phone number to SMS campaign
- List an account's inbound blocked statistics
- Update common area
- Download a phone voicemail
- Delete firmware update rule
- Get account's SMS sessions
- Add directory backup routing rule
- List devices
- Get a user's profile settings
- Get ported numbers details
- Unassign a phone number
- Delete a call recording
- Get account voicemails
- Add a device
- List real time location for users
- Add an audio item for text-to-speech conversion
- Activate phone numbers
- Add a user's shared access setting
- Update peering phone numbers
- Add members to a shared line group
- Unassign a phone number
- Update group policy
- Get operation logs report
- List phone sites
- Unassign phone numbers from common area
- Add a client code to a call log
- Get directory backup routing rule
- Add a call handling setting
- List phone roles
- Update fax log read status
- List billing accounts
- Get account level outbound calling countries and regions
- Delete account level outbound calling exception rule
- Delete phone numbers for an account's customized outbound caller ID
- Delete a phone role
- Delete a voicemail
- Batch add users
- Get line key position and settings information
- Sync deskphones
- Update an auto receptionist
- Update user's calling plan
- List account level outbound calling exception rules
- Get role information
- Update phone site details
- List emergency service locations
- List an account's customized outbound caller ID phone numbers
- Delete group call pickup objects
- Get voicemail details
- Get emergency service location details
- Add an emergency service location
- Update auto receptionist IVR
- Update a user's profile settings
- Get auto receptionist IVR
- List site level outbound calling exception rules
- Update a setting template
- Get group phone settings
- Add members to a private directory
- Unassign a phone number
- List updatable firmwares
- Add a group call pickup object
- Download a phone recording
- Get site level outbound calling countries and regions
- Mark a phone number as blocked for all extensions
- Delete a call handling setting
- List common area level outbound calling exception rules
- Delete a line key setting.
- List opt statuses of phone numbers assigned to SMS consent
- Create a monitoring group
- Remove all monitors or monitored members from a monitoring group
- Get setting template details
- Delete a non-primary auto receptionist
- Update a call handling setting
- Create a phone site
- Update common area level outbound calling countries or regions
- Get User AI Call Summary Detail
- Get common area details
- List directory backup routing rules
- Update the site setting
- Delete a site setting
- Assign phone numbers
- Delete unassigned phone numbers
- Delete a phone site
- List an account's Zoom Phone settings
- Get a shared line group policy
- Add customized outbound caller ID phone numbers
- Get a user's profile
- Download fax file
- Get call pickup group by ID
- List call queue members
- List call pickup group members
- Duplicate a phone role
- Update a blocked list
- Get fax log details
- List members in a role
- List group call pickup objects
- Add a provision template
- Update a policy subsetting
- List carrier peering phone numbers.
- Assign calling plan to a user
- Remove users' customized outbound caller ID phone numbers
- Delete a user's call history
- List SMS campaigns
- Delete common area setting
- Add members to a call pickup group
- Update a monitoring group
- List private directory members
- List user's SMS sessions in descending order
- Remove a phone number from a Zoom Room
- Add users to a directory
- Remove customized outbound caller ID phone numbers
- Unassign a phone number
- Delete a phone number
- Add an account's inbound block rule
- Add common area setting
- Remove a member from a monitoring group
- Delete an account's inbound block rule
- List alert settings with paging query
- Get external contact details
- Update an account's inbound block rule
- Assign phone numbers to a Zoom Room
- List past call metrics
- Unassign a phone number
- List Smartphones
- Update external contact
- Add a common area
- Create a shared line group
- Get an audio item
- List an account's inbound block rules
- Add an alert setting
- Delete user level outbound calling exception rule
- Update site level outbound calling exception rule
- Remove peering phone numbers
- Add account level outbound calling exception rule
- Delete members in a role
- Update a call queue's policy subsetting
- Update common area setting
- List user's opt statuses of phone numbers
- Update a Zoom Room under Zoom Phone license
- Unassign all phone numbers
- Update multiple users' properties in batch
- Update a private directory member
- Add users to a directory of a site
- Create phone numbers
- Update directory backup routing rule
- List SIP groups
- List users permission for location sharing
- Get device line keys information
- Update account level outbound calling exception rule
- Update a site's unassigned phone numbers
- List peering phone numbers
- Get call charges usage report
- Add a firmware update rule
- Update site level outbound calling countries or regions
- Get user policy details
- List calling plans
- Add an extension's inbound block rule
- Get firmware update rule information
- Batch update line key position and settings information
- Unassign all members
- Get user's call logs
- Update provision template of a device
- Delete an alert setting
- Unassign user's calling plan
- Get SMS by message ID
- Delete a policy subsetting
- Get recording by call ID
- List detectable personal location users
- List Zoom Rooms under Zoom Phone license
- Assign calling plans to a common area
- Get common area level outbound calling countries and regions
- List default emergency address users
- List provision templates
- Get SMS/MMS charges usage report
- List external contacts
- Get an SMS campaign
- Delete an SLG policy setting
- Add an auto receptionist
- List users in a directory by site
- List phone numbers
- Get a shared line group
- Get phone site details
- Delete a CQ policy setting
- Assign calling plans to a Zoom Room
- Post SMS message
- Get call handling settings
- Add a policy subsetting
- Get billing account details
- Delete users from a directory of a site
- List user level outbound calling exception rules
- Add site level outbound calling exception rule
- Get user's voicemails
- Update firmware update rule
- Delete a provision template
- Get an auto receptionist policy
- Add user level outbound calling exception rule
phone:read
View your phone information
Associated API
- List user's opt statuses of phone numbers
- Download a phone recording transcript
- Get call element
- Get extension's fax logs
- Get a user's profile settings
- Sync user's call logs
- List user's SMS sessions in descending order
- List an extension's inbound block rules
- Download a phone recording
- Get user's recordings
- Get device line keys information
- Sync user's call history
- Get user's voicemails
- Get User AI Call Summary Detail
- Get call history detail
- List users' phone numbers for a customized outbound caller ID
- Get user voicemail details from a call log
- Update fax log read status
- List audio items
- Get user's call logs
- Sync SMS by session ID
- Get SMS session details
- Get voicemail details
- Get a user's profile
- Download fax file
- Get call log details
- Get line key position and settings information
- Get an audio item
- Get user's SMS sessions
- Get SMS by message ID
- Download a phone voicemail
phone:read:admin
View all users' phone information
Associated API
- Get directory backup routing rule
- List emergency addresses
- Get call history detail
- Get a phone number
- Get a provision template
- Get call charges usage report
- List user's SMS sessions in descending order
- Get an audio item
- List alert settings with paging query
- List phone numbers
- List an account's inbound block rules
- List phone role targets
- List ported numbers
- Get external contact details
- List firmware update rules
- List default emergency address users
- Get account's fax logs
- Get device line keys information
- List shared line appearances
- Get SMS by message ID
- List common areas
- Get user's SMS sessions
- Get emergency address details
- List BYOC SIP trunks
- Get call recordings
- List users permission for location sharing
- List past call metrics
- Get account policy details
- Get a shared line group policy
- Get user's call logs
- Get a Zoom Room under Zoom Phone license
- The list of shared line groups
- List user's opt statuses of phone numbers
- Sync user's call logs
- List calling plans
- List blocked lists
- Get call details from call log
- Get firmware update rule information
- Get members of a monitoring group
- List users in directory
- List peering phone numbers
- Get user's recordings
- List detectable personal location users
- Get ported numbers details
- Get common area settings
- List SIP groups
- Get recording by call ID
- Get SMS session details
- Get extension's fax logs
- Get call queue details
- Download a phone recording transcript
- Get an SMS campaign
- List tracked locations
- List provision templates
- Get common area level outbound calling countries and regions
- Get SMS/MMS charges usage report
- List Zoom Rooms under Zoom Phone license
- List an account's inbound blocked statistics
- List external contacts
- Get user's voicemails
- Get call history
- Download a phone voicemail
- List an account's customized outbound caller ID phone numbers
- Get account voicemails
- Get call handling settings
- List real time location for users
- Get monitoring group by ID
- Get account's SMS sessions
- List user level outbound calling exception rules
- List devices
- Get an auto receptionist policy
- List phone numbers
- Get billing account details
- List phone sites
- List users in a directory by site
- Get a shared line group
- Get a user's profile settings
- Get a phone site setting
- Get operation logs report
- Get role information
- Get voicemail details
- List setting templates
- Get an auto receptionist
- Get call QoS
- List opt statuses of phone numbers assigned to SMS campaign
- List emergency service locations
- Get line key position and settings information
- List updatable firmwares
- Get call log details
- List account level outbound calling exception rules
- Update fax log read status
- List real time location for IP phones
- Get blocked list details
- List call logs
- Get call element
- Get group phone settings
- List auto receptionists
- Get phone site details
- List an extension's inbound block rules
- Get a list of monitoring groups on an account
- List phone roles
- Get group policy details
- List call pickup group members
- List common area level outbound calling exception rules
- Get common area details
- Download a phone recording
- Get site level outbound calling countries and regions
- Download fax file
- Get User AI Call Summary Detail
- Get auto receptionist IVR
- Get account level outbound calling countries and regions
- List billing accounts
- Get account's call history
- List site level outbound calling exception rules
- List users' phone numbers for a customized outbound caller ID
- Get setting template details
- Get device details
- List customized outbound caller ID phone numbers
- Get user level outbound calling countries and regions
- Get user voicemail details from a call log
- List opt statuses of phone numbers assigned to SMS consent
- List directory backup routing rules
- Get user policy details
- List carrier peering phone numbers.
- Sync SMS by session ID
- List members in a role
- Sync user's call history
- Get user's call history
- Get fax charges usage report
- List call queue members
- Get a user's profile
- List private directory members
- List an account's Zoom Phone settings
- List audio items
- List call queue analytics
- Get fax log details
- List call queues
- List group call pickup objects
- Get emergency service location details
- Get call pickup group by ID
- List activation codes
- List phone users
- Get call queue recordings
- List Zoom Rooms without Zoom Phone assignment
- List Smartphones
- List nomadic emergency services users
- Get phone account settings
- List SMS campaigns
- Get account's call logs
- List plan information
- Get alert setting details
phone:write
View and manage your phone information
Associated API
- Add an audio item for text-to-speech conversion
- Update user's calling plan
- Unassign user's calling plan
- Update a user's shared access setting
- Delete a line key setting.
- Batch update device line key position
- Update Voicemail Read Status
- Delete a user's shared access setting
- Post SMS message
- Add audio items
- Upload fax file
- Add phone numbers for users' customized outbound caller ID
- Delete fax log
- Remove users' customized outbound caller ID phone numbers
- Delete a user's call history
- Update Recording Status
- Delete a user's call log
- Update Auto Delete Field
- Delete an audio item
- Add an extension's inbound block rule
- Send fax
- Add a user's shared access setting
- Unassign a phone number
- Delete a call recording
- Delete a voicemail
- Update a user's profile settings
- Delete an extension's inbound block rule
- Batch update line key position and settings information
- Update an audio item
- Update a user's profile
- Assign calling plan to a user
- Assign a phone number to a user
phone:write:admin
View and manage all users' phone information
Associated API
- Unassign a phone number
- Create a shared line group
- Send fax
- Update site level outbound calling exception rule
- Delete an emergency address
- Batch add emergency service locations
- Update site level outbound calling countries or regions
- Delete a phone number
- Update Auto Delete Field
- Remove users' customized outbound caller ID phone numbers
- Update a Zoom Room under Zoom Phone license
- Delete a monitoring group
- Delete common area setting
- Generate activation codes for common areas
- Batch update device line key position
- Add an account's inbound block rule
- Unassign an entity from the device
- Remove peering phone numbers
- Add a setting template
- Delete members in a role
- Delete a user's shared access setting
- Assign calling plans to a Zoom Room
- Batch update line key position and settings information
- Add a provision template
- Delete a device
- Remove customized outbound caller ID phone numbers
- Update an alert setting
- Delete a policy subsetting
- Delete phone role targets
- Update opt statuses of phone numbers assigned to SMS campaign
- Update a provision template
- Add BYOC phone numbers
- Update the site setting
- Add members to a monitoring group
- Add common area level outbound calling exception rule
- Update common area level outbound calling countries or regions
- Update Recording Status
- Assign phone numbers
- Add members to a call pickup group
- Remove a member from a monitoring group
- Delete an audio item
- Add members to a call queue
- Delete an emergency location
- Update a setting template
- Add peering phone numbers
- Update common area level outbound calling exception rule
- Delete an external contact
- Remove a phone number from a Zoom Room
- Upload fax file
- Update user level outbound calling countries or regions
- Update Voicemail Read Status
- Create a call queue
- Unassign a member
- Update user level outbound calling exception rule
- Update a user's profile
- Create a monitoring group
- Add a user's shared access setting
- Delete users from a directory
- Add members to a shared line group
- Add a call handling setting
- Delete a voicemail
- Update user policy
- Unassign a calling plan from the common area
- Mark a phone number as blocked for all extensions
- Update the group call pickup information
- Add an audio item for text-to-speech conversion
- Delete a site setting
- Update a shared line group
- Update phone account settings
- Update account level outbound calling countries or regions
- Update phone site details
- Update peering phone numbers
- Delete a shared line group
- Update a blocked list
- Batch add users
- Add a policy subsetting to a call queue
- Update a policy subsetting
- Delete firmware update rule
- Update an audio item
- Reboot a desk phone
- Add phone numbers for an account's customized outbound caller ID
- Delete a call recording
- Remove a Zoom Room from a ZP account
- Activate phone numbers
- Add members to roles
- Delete a common area
- Unassign a phone number
- Add phone role targets
- Add a client code to a call log
- Unassign phone numbers from common area
- Update group policy
- Unassign a member from a shared line group
- Update a phone number
- Assign phone numbers
- Add a device
- Unassign members from a shared line group
- Add audio items
- Remove a member from a private directory
- Delete phone numbers for an account's customized outbound caller ID
- Assign a phone number to SMS campaign
- Add an emergency address
- Add directory backup routing rule
- Unassign all phone numbers
- Update common area
- Update account level outbound calling exception rule
- Unassign a phone number
- Delete site level outbound calling exception rule
- Update a site's unassigned phone numbers
- Update an account's inbound block rule
- Delete a user's call log
- Delete a provision template
- Update directory backup routing rule
- Add account level outbound calling exception rule
- Add an external contact
- Update an auto receptionist policy
- Create phone numbers
- Assign numbers to a call queue
- Update a shared line group policy
- Add a policy setting to a shared line group
- Update emergency service location
- Add a common area
- Unassign user's calling plan
- Assign calling plan to a user
- Delete an account's inbound blocked statistics
- Assign an entity to a device
- Create a blocked list
- Update a phone role
- Delete a phone site
- Delete an alert setting
- Add customized outbound caller ID phone numbers
- Delete an account's inbound block rule
- Update a call handling setting
- Create a phone site
- Remove all monitors or monitored members from a monitoring group
- Remove members from call pickup group
- Unassign a phone number
- Update a device
- Add a client code to a call history
- Update common area pin code
- Add an extension's inbound block rule
- Add common area setting
- Add a site setting
- Add users to a directory
- Remove a calling plan from a Zoom Room
- Update multiple users' properties in batch
- Update a monitoring group
- Delete a blocked list
- Add an alert setting
- Assign phone numbers to a Zoom Room
- Delete unassigned phone numbers
- Update a private directory member
- Unassign all phone numbers
- Delete directory backup routing rule
- Assign a phone number to a user
- Delete a phone role
- Delete an extension's inbound block rule
- Delete a non-primary auto receptionist
- Sync deskphones
- Update an emergency address
- Update an auto receptionist
- Update an SLG policy setting
- Update account policy
- Add a policy subsetting
- Delete a line key setting.
- Delete account level outbound calling exception rule
- Add site level outbound calling exception rule
- Delete a user's call history
- Unassign a phone number
- Update a user's shared access setting
- Apply template to common areas
- Delete group call pickup objects
- Add an auto receptionist
- Duplicate a phone role
- Delete fax log
- Add phone numbers for users' customized outbound caller ID
- Delete a call handling setting
- Update provision template of a device
- Delete common area level outbound calling exception rule
- Assign calling plans to a common area
- Delete users from a directory of a site
- Add a group call pickup object
- Add members to a private directory
- Unassign all members
- Add users to a directory of a site
- Update firmware update rule
- Add user level outbound calling exception rule
- Delete user level outbound calling exception rule
- Post SMS message
- Assign phone numbers to a common area
- Add a firmware update rule
- Update common area setting
- Update call queue details
- Add a Zoom Room to a Zoom Phone
- Update external contact
- Add an emergency service location
- Delete a call queue
- Delete a CQ policy setting
- Unassign all phone numbers
- Update user's calling plan
- Update a user's profile settings
- Update auto receptionist IVR
- Delete an SLG policy setting
- Update a call queue's policy subsetting
phone_call_log:master
View and manage all subaccounts' call logs
Associated API
- Get user's call logs
- Get account's call logs
- Get call log details
- Delete a user's call log
- Delete a user's call history
phone_call_log:read
View your call history information
Associated API
- Get user's call history
- Get user's call logs
- Get call element
- Get call history detail
- Get call log details
phone_call_log:read:admin
View all users' call history information
Associated API
- Get account's call history
- Get call log details
- Get call history detail
- Get user's call logs
- Get call element
- Get account's call logs
- Get call history
phone_call_log:write
View and manage your call log information
Associated API
phone_call_log:write:admin
View and manage all users' call log information
Associated API
phone_peering:master
View and manage subaccounts' E164 numbers sent via peering API
Associated API
- List peering phone numbers
- Add peering phone numbers
- Remove peering phone numbers
- Update peering phone numbers
- List carrier peering phone numbers.
phone_peering:read:admin
View the E164 numbers sent via peering API
Associated API
- List ported numbers
- Get ported numbers details
- List peering phone numbers
- List carrier peering phone numbers.
phone_peering:write:admin
View and manage the E164 numbers sent via peering API
Associated API
phone_recording:master
View and manage subaccounts' call recording information
Associated API
- Get user's recordings
- Download a phone recording transcript
- Get call recordings
- Get recording by call ID
- Download a phone recording
phone_recording:read
View your call recording information
Associated API
- Get user's recordings
- Download a phone recording
- Get recording by call ID
- Download a phone recording transcript
phone_recording:read:admin
View all users' recording information
Associated API
- Download a phone recording transcript
- Get call recordings
- Get meeting recordings
- Download a phone recording
- Get recording by call ID
- Get user's recordings
phone_recording:write
View and manage your call recording information
Associated API
phone_recording:write:admin
View and manage all users' call recording information
Associated API
phone_sms:master
View and manage all sub accounts' Zoom Phone SMS information
Associated API
phone_sms:read
View your Zoom Phone SMS information
Associated API
- Get SMS by message ID
- Get user's SMS sessions
- List user's SMS sessions in descending order
- Sync SMS by session ID
- Get account's SMS sessions
- Get SMS session details
phone_sms:read:admin
View all users' Zoom Phone SMS information
Associated API
- Get user's SMS sessions
- Get account's SMS sessions
- Get SMS session details
- Get SMS by message ID
- List user's SMS sessions in descending order
- Sync SMS by session ID
phone_sms:write
View and manage your Zoom Phone SMS information
Associated API
phone_sms:write:admin
View and manage all users' Zoom Phone SMS information
Associated API
phone_voicemail:master
View and manage subaccounts' call voicemails
Associated API
- Download a phone voicemail
- Delete a voicemail
- Get user voicemail details from a call log
- Get voicemail details
- Get account voicemails
- Get user's voicemails
phone_voicemail:read
View your call voicemail information
Associated API
- Get voicemail details
- Get user voicemail details from a call log
- Get user's voicemails
- Download a phone voicemail
phone_voicemail:read:admin
View all users' call voicemail information
Associated API
- Get account voicemails
- Download a phone voicemail
- Get voicemail details
- Get user's voicemails
- Get user voicemail details from a call log
phone_voicemail:write
View and manage your call voicemail information
Associated API
phone_voicemail:write:admin
View and manage all users' call voicemail information
Associated API
QualityManagement scopes
The following are the available QualityManagement scopes and their associated API calls:
qm_evaluations:read
Read evaluations
Associated API
- [List evaluations](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/Listevaluations)
- [List automated evaluations](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/ListAutomatedEvaluations)
- [View evaluation detail](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/EvaluationDetail)
qm_evaluations:read:admin
Read evaluations
Associated API
- [View evaluation detail](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/EvaluationDetail)
- [List evaluations](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/Listevaluations)
- [List automated evaluations](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/ListAutomatedEvaluations)
qm_interactions:read
View interactions
Associated API
- [View interaction detail](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/InteractionDetail)
- [List interactions](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/ListInteractions)
qm_interactions:read:admin
View interactions
Associated API
- [List interactions](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/ListInteractions)
- [View interaction detail](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/InteractionDetail)
Recording scopes
The following are the available Recording scopes and their associated API calls:
recording:master
View and manage sub account's user recordings
Associated API
- List all recordings
- List archived files
- List an account's recordings
- Delete a recording file for a meeting or webinar
- Recover meeting recordings
- Update registration questions
- Create a recording registrant
- Recover a single recording
- Get meeting recording settings
- Delete meeting or webinar recordings
- Update a registrant's status
- Update meeting recording settings
- Get meeting recordings
- List recording registrants
- Get registration questions
recording:read
View your recordings
Associated API
- Get a meeting transcript
- Get meeting recordings
- Get registration questions
- List recording registrants
- List all recordings
- Get a meeting's archived files
- Get meeting recording settings
recording:read:admin
View all user recordings
Associated API
- Get a meeting transcript
- List recording registrants
- Get meeting recording settings
- List all recordings
- List archived files
- Get registration questions
- Get archived file statistics
recording:write
View and manage your recordings
Associated API
- Create a recording registrant
- Update a registrant's status
- Delete a recording file for a meeting or webinar
- Update an archived file's auto-delete status
- Recover meeting recordings
- Update meeting recording settings
- Delete a meeting or webinar transcript
- Recover a single recording
- Get a meeting transcript
- Delete meeting or webinar recordings
- Update registration questions
recording:write:admin
View and manage all user recordings
Associated API
- Recover a single recording
- Delete meeting or webinar recordings
- Update an archived file's auto-delete status
- Update registration questions
- Create a recording registrant
- Update meeting recording settings
- Delete a meeting's archived files
- Update a registrant's status
- Delete a recording file for a meeting or webinar
- Recover meeting recordings
- Get a meeting transcript
- Delete a meeting or webinar transcript
Report scopes
The following are the available Report scopes and their associated API calls:
report:master
View sub account's report data
Associated API
- Get webinar participant reports
- Get meeting reports
- Get webinar Q&A report
- Get disclaimer report
- Get telephone reports
- Get operation logs report
- Get remote support report
- Get sign In / sign out activity report
- Get webinar poll reports
- Get upcoming events reports
- Get a meeting activities report
- Get cloud recording usage report
- Get meeting Q&A report
- Get daily usage report
- Get webinar detail reports
- Get billing invoice reports
- Get meeting poll reports
- Get meeting participant reports
- Get history meeting and webinar list
- Get billing reports
- Get meeting survey report
- Get meeting detail reports
- Get active or inactive host reports
report:read:admin
View report data
Associated API
- Get upcoming events reports
- Get meeting detail reports
- Get sign In / sign out activity report
- Get remote support report
- Get billing reports
- Get meeting survey report
- Get daily usage report
- Get billing invoice reports
- Get disclaimer report
- Get webinar Q&A report
- Get active or inactive host reports
- Get meeting participant reports
- Get meeting poll reports
- Get webinar survey report
- Get webinar detail reports
- Get telephone reports
- Get history meeting and webinar list
- Get meeting Q&A report
- Get webinar participant reports
- Get cloud recording usage report
- Get meeting reports
- Get webinar poll reports
- Get a meeting activities report
- Get operation logs report
report_chat:read:admin
View your team chat history report
Associated API
zva_report:read:admin
View zva engagements
Associated API
- Get ZVA transcripts
- Get ZVA variable details
- Get ZVA query details
- Get ZVA Surveys
- Get ZVA engagements
Role scopes
The following are the available Role scopes and their associated API calls:
role:master
View and manage sub account user roles
Associated API
- Assign a role
- Get role information
- Create a role
- Update role information
- List members in a role
- List roles
- Unassign a role
- Delete a role
role:read:admin
View all user roles
Associated API
role:write:admin
View and manage all user roles
Associated API
- List roles
- Update role information
- Delete a role
- Create a role
- Unassign a role
- Assign a role
- Get role information
- List members in a role
Room scopes
The following are the available Room scopes and their associated API calls:
room:master
View and manage sub account's Zoom Rooms information
Associated API
- Get Digital Signage content folder
- Get device information
- Change a Zoom Room's location
- List Digital Signage library playlists
- Create a device profile
- Get Digital Signage library playlist content items
- Get Digital Signage library playlist
- Get Zoom Room location profile
- Update Zoom Room location profile
- Get Zoom Room account profile
- Delete a location
- Get Digital Signage content item
- Delete a device profile
- List digital signage contents
- Get Zoom Rooms virtual controller URL
- Add a digital signage URL
- Get location settings
- List Zoom Rooms
- List Digital Signage content items
- Update Zoom Room account profile
- Use Zoom Room controls
- List device profiles
- Update Zoom Room account settings
- Update Digital Signage library playlist content items
- Get Zoom Room location structure
- Update location settings
- Change Zoom Rooms app version
- Delete a Digital Signage content folder
- Change the assigned parent location
- Add a location
- Get Zoom Room settings
- Update a digital signage content folder
- Update E911 digital signage
- Add a digital signage content folder
- Add a Zoom Room
- Add a Digital Signage library playlist
- Config Zoom Room Controller Apps
- Delete Digital Signage library playlist
- Delete a Digital Signage content item
- Delete a Zoom Room
- Update Zoom Room settings
- Update Zoom Rooms location structure
- List Zoom Room locations
- Get Zoom Room account settings
- Update a device profile
- Update a Digital Signage content item attributes
- Get a device profile
- Update a Digital Signage library playlist
- List Zoom Room devices
room:read:admin
View all users' Zoom Rooms information
Associated API
- Get Digital Signage content folder
- Get device information
- List released workspaces by timeout
- Get Zoom Rooms virtual controller URL
- List digital signage contents
- Get Digital Signage library playlist
- List Digital Signage library playlists
- Get Zoom Room account profile
- Get Digital Signage content item
- List Zoom Rooms background image library contents
- Get Digital Signage library playlist content items
- List Zoom Room devices
- Get Zoom Room account settings
- Get Zoom Room sensor data
- Get Zoom Rooms background image library content
- Get a device profile
- Get a calendar resource by ID
- List Digital Signage library playlist published rooms
- Get Zoom Room settings
- List all Zoom Room Tags
- List device profiles
- List default Zoom Rooms background image library contents
- Get Zoom Room profile
- List Zoom Room locations
- List calendar services
- Get Zoom Rooms Background Image Library Folder
- List Zoom Rooms Background Image Library Folders
- List Zoom Rooms
- List Digital Signage content items
- List calendar resources by calendar service
- Get Zoom Room location structure
- Get Zoom Room location profile
- Get location settings
room:write:admin
View and manage all users' Zoom Rooms information
Associated API
- Delete a Digital Signage content item
- Delete a Zoom Room
- Update Zoom Room account profile
- Delete a calendar service
- Update location settings
- Change Zoom Rooms app version
- Update a Zoom Room profile
- Add a calendar resource to a calendar service
- Update Digital Signage library playlist published rooms
- Add a digital signage content folder
- Add a Digital Signage library playlist
- Delete Zoom Rooms Background Image Library Content
- Un-assign Tags from a Zoom Room
- Config Zoom Room Controller Apps
- Delete Digital Signage library playlist
- Add a digital signage URL
- Update Zoom Room settings
- Update Zoom Rooms location structure
- Update Digital Signage library playlist content items
- Start calendar service sync process
- Create a new Zoom Rooms Tag
- Create a device profile
- Delete Zoom Rooms Background Image Library Folder
- Delete a Digital Signage content folder
- Change a Zoom Room's location
- Update Zoom Room account settings
- Delete a calendar resource
- Update a Digital Signage image or video file
- Add a Zoom Room
- Add a digital signage image or video
- Use Zoom Room controls
- Update a digital signage content folder
- Update a Digital Signage content item attributes
- Add a location
- Update E911 digital signage
- Delete a Zoom Room user device
- Assign Tags to Zoom Rooms By Location ID
- Delete a device profile
- Delete a location
- Delete Tag
- Update a device profile
- Get a device profile
- Update Zoom Rooms background image library content
- Update a Digital Signage library playlist
- Edit Tag
- Update Zoom Room location profile
- Add Zoom Rooms Background Image Library Folder
- Change the assigned parent location
- Assign Tags to a Zoom Room
- Update Zoom Rooms Background Image Library Folder
- Add Zoom Rooms background image library content
Rooms Web scopes
The following are the available Rooms Web scopes and their associated API calls:
room:read:master
View sub account's Zoom Rooms information
Associated API
room:write:master
Manage sub account's Zoom Rooms information
Associated API
- Update Digital Signage library playlist published rooms
- Add a digital signage image or video
- Delete a Digital Signage content item
- Update a Digital Signage image or video file
SCIM2 scopes
The following are the available SCIM2 scopes and their associated API calls:
scim2
Call Zoom SCIM2 API
Associated API
- Create a user
- List groups
- Delete a group
- Deactivate a user
- Create a group
- Update a group
- Get a user
- Get a group
- List users
- Update a user
- Delete a user
SIP scopes
The following are the available SIP scopes and their associated API calls:
sip_phone:master
View and manage sub account's SIP phone information
Associated API
sip_phone:read:admin
View all users' SIP phone information
Associated API
sip_phone:write:admin
View and manage all users' SIP phone information
Associated API
sip_trunk:master
View and manage sub account's SIP trunk information
Associated API
- Delete a SIP trunk
- Delete all numbers
- Update an internal number
- Assign SIP trunk configuration
- Get SIP trunk configuration
- Assign numbers
- Delete internal call-out country
- Add internal numbers
- Delete an internal number
- List SIP trunks
- Add internal call-out countries
- Assign SIP trunks
- List SIP trunk numbers
- List internal numbers
- List internal call-out countries
SMS scopes
The following are the available SMS scopes and their associated API calls:
contact_center_sms:write:admin
send sms
Associated API
Scheduler scopes
The following are the available Scheduler scopes and their associated API calls:
scheduler:read
View scheduler
Associated API
- List schedules
- get routing response
- List scheduled events
- List availability
- Get scheduled event attendee
- List team
- list account routing response
- Report analytics
- Get user
- Get availability
- Get schedules
- Get scheduled events
scheduler:read:admin
View scheduler
Associated API
- list account routing response
- Get availability
- Get scheduled event attendee
- Get schedules
- Get user
- Get scheduled events
- List scheduled events
- List schedules
- Report analytics
- get routing response
- List team
- List availability
scheduler:write
Manage scheduler
Associated API
- Create shares
- Delete scheduled events
- Patch schedules
- Insert schedules
- Patch scheduled events
- Patch availability
- Insert availability
- Delete schedules
- Delete availability
- Single use link
scheduler:write:admin
Manage scheduler
Associated API
- Insert availability
- Patch availability
- Delete availability
- Delete scheduled events
- Single use link
- Delete schedules
- Create shares
- Insert schedules
- Patch scheduled events
- Patch schedules
Special scopes
The following are the available Special scopes and their associated API calls:
app:deeplink:write
Generate an app deeplink
Associated API
app:deeplink:write:admin
Generate an app deeplink
Associated API
Special&ChatBot scopes
The following are the available Special&ChatBot scopes and their associated API calls:
app:notification:read
View chat app notification
Associated API
app:notification:write
View and Manage chat app notification
Associated API
Survey Management scopes
The following are the available Survey Management scopes and their associated API calls:
survey:master
View survey information
Associated API
survey:read:admin
View survey information
Associated API
TSP scopes
The following are the available TSP scopes and their associated API calls:
tsp:master
View and manage sub account's TSP account info
Associated API
- Set global dial-in URL for a TSP user
- Update a TSP account
- Delete a user's TSP account
- Get account's TSP information
- Get a user's TSP account
- List user's TSP accounts
- Update an account's TSP information
- Add a user's TSP account
tsp:read
View your TSP account info
Associated API
tsp:read:admin
View TSP info
Associated API
tsp:write
View and manage your TSP account info
Associated API
- Delete a user's TSP account
- Update a TSP account
- Add a user's TSP account
- Set global dial-in URL for a TSP user
tsp:write:admin
View and manage TSP info
Associated API
- Set global dial-in URL for a TSP user
- Update an account's TSP information
- Delete a user's TSP account
- Add a user's TSP account
- Update a TSP account
Tasks scopes
The following are the available Tasks scopes and their associated API calls:
tasks:delete
Delete user's task(s)
Associated API
tasks:delete:admin
Delete account's task(s)
Associated API
tasks:read
Get user’s task(s)
Associated API
tasks:read:admin
Get account's task(s)
Associated API
tasks:write
Update or trash tasks
Associated API
tasks:write:admin
Management the account's task
Associated API
tasks_assignee:read
View task's assignee(s)
Associated API
tasks_assignee:read:admin
View account's task assignees
Associated API
tasks_assignee:write
Add or remove task's assignee
Associated API
tasks_assignee:write:admin
Add or update task's assignees
Associated API
tasks_collaborator:read
View user's task collaborator information
Associated API
tasks_collaborator:read:admin
View account's task collaborators
Associated API
tasks_collaborator:write
Add or update task's collaborator
Associated API
tasks_collaborator:write:admin
View and update account's task collaborator information
Associated API
tasks_comment:read
Read user's task comment
Associated API
tasks_comment:read:admin
View account's task comment
Associated API
tasks_comment:write
Manage and view the user's task comments
Associated API
tasks_comment:write:admin
View and manage account's task comment.
Associated API
TrackingField scopes
The following are the available TrackingField scopes and their associated API calls:
tracking_fields:master
View and manage sub account user tracking fields
Associated API
- Update a tracking field
- Get a tracking field
- Create a tracking field
- List tracking fields
- Delete a tracking field
tracking_fields:read:admin
View all users' tracking fields
Associated API
tracking_fields:write:admin
View and manage all users' tracking fields
Associated API
User scopes
The following are the available User scopes and their associated API calls:
user:master
View and manage sub account's user information
Associated API
- Update user settings
- Delete user assistants
- Get user permissions
- Get user settings
- Get a user
- Revoke a user's SSO token
- Delete a user assistant
- Get user summary
- List users
- Update a user's email
- Delete a user
- Delete a user's profile picture
- List user schedulers
- Delete a scheduler
- Upload Virtual Background files
- Add assistants
- Bulk update features for users
- Upload a user's profile picture
- Delete user schedulers
- Get a user's token
- Update user status
- Update a user
- Delete Virtual Background files
- Create users
- Update a user's password
- List user assistants
- Switch a user's account
user:read
View your user information
Associated API
- Check a user's PM room
- Get user summary
- List users
- Get a user presence status
- List user schedulers
- List a user's collaboration devices
- Get meeting summary templates
- Get a user
- Check a user email
- Get user permissions
- Get user settings
- Get collaboration device detail
- Get Meeting Template detail
- List user assistants
- Get a user's token
user:read:admin
View all user information
Associated API
- Get a user's token
- Get a user presence status
- List users
- Get collaboration device detail
- Get user settings
- Get a user
- List a user's collaboration devices
- List user assistants
- List user schedulers
- Get user summary
- Get user permissions
- Get Meeting Template detail
- Check a user's PM room
- Get meeting summary templates
- Check a user email
user:write
View and manage your user information
Associated API
- Update a user's presence status
- List user assistants
- Add assistants
- Get collaboration device detail
- Delete a user assistant
- Get a user
- Delete user assistants
- Update a user's password
- Check a user's PM room
- Create users
- Get a user's token
- Bulk update features for users
- Delete Virtual Background files
- Delete user schedulers
- List users
- Get user summary
- Update a user
- Update user status
- List a user's collaboration devices
- Upload a user's profile picture
- Get user permissions
- Get user settings
- List user schedulers
- Update user settings
- Delete a user's profile picture
- Check a user email
- Upload Virtual Background files
- Delete a user
- Delete a scheduler
- Revoke a user's SSO token
- Update a user's email
user:write:admin
View users information and manage users
Associated API
- List user assistants
- Update a user's presence status
- Delete a user's profile picture
- Check a user email
- Create users
- Delete Virtual Background files
- Get a user's token
- Delete a user
- Delete a user assistant
- Check a user's PM room
- Get user settings
- Update user settings
- Delete user schedulers
- Get user summary
- Update a user
- Update user status
- Update a user's email
- Update a user's password
- Bulk update features for users
- Revoke a user's SSO token
- Upload Virtual Background files
- Get user permissions
- Get collaboration device detail
- Delete a scheduler
- Delete user assistants
- Add assistants
- List a user's collaboration devices
- Get a user
- List users
- List user schedulers
- Upload a user's profile picture
user_info:read
View user info
Associated API
user_profile
View your profile information
Associated API
user_zak:read
View user’s zak token
Associated API
Visitor Management scopes
The following are the available Visitor Management scopes and their associated API calls:
visitor_management:read
View visitor management information
Associated API
visitor_management:write
Update visitor management information
Associated API
visitor_management:write:admin
Update visitor management information
Associated API
Webinar scopes
The following are the available Webinar scopes and their associated API calls:
webinar:master
View and manage sub account's user webinars
Associated API
- Get webinar tracking sources
- Delete a webinar survey
- List past webinar instances
- Remove all panelists
- Get a webinar poll
- Update a webinar's branding name tag
- Delete a webinar's branding wallpaper
- Set webinar's default branding virtual background
- Delete a webinar registrant
- Get a webinar
- List webinar templates
- Update a webinar
- Delete a webinar poll
- Get webinar's session branding
- Upload a webinar's branding wallpaper
- Delete a webinar
- Get webinar's token
- Update a webinar survey
- List webinars
- Add a webinar registrant
- Update registrant's status
- Update a live stream
- List a webinar's polls
- Delete a webinar's branding name tag
- Get a webinar survey
- Create a webinar
- List webinar registrants
- Upload a webinar's branding virtual background
- Update registration questions
- Perform batch registration
- Get a webinar registrant
- Add panelists
- Remove a panelist
- Update a webinar poll
- Create a webinar template
- List registration questions
- Create a webinar's branding name tag
- Create webinar's invite links
- Update live stream status
- Get webinar absentees
- List panelists
- Create a webinar's poll
- Delete a webinar's branding virtual backgrounds
- Get live stream details
- Update webinar status
webinar:read
View your webinars
Associated API
- Get webinar's token
- Get a webinar registrant
- List webinars
- Get a webinar poll
- Get a webinar
- Get webinar's session branding
- Get a webinar survey
- Get webinar tracking sources
- Get live stream details
- List webinar registrants
- List a webinar's polls
- List webinar templates
- List registration questions
- List past webinar poll results
- List webinar participants
- List past webinar instances
- List panelists
- Get webinar absentees
- List Q&As of a past webinar
webinar:read:admin
View all user Webinars
Associated API
- Get webinar's session branding
- List panelists
- List Q&As of a past webinar
- Get webinar absentees
- List webinar participants
- List registration questions
- List webinar templates
- List past webinar instances
- List a webinar's polls
- Get a webinar survey
- List webinar registrants
- Get a webinar poll
- Get a webinar registrant
- Get a webinar
- Get webinar tracking sources
- List webinars
- List past webinar poll results
- Get live stream details
- Get webinar's token
webinar:write
View and manage your webinars
Associated API
- Delete a webinar's branding wallpaper
- Update a webinar's branding name tag
- Set webinar's default branding virtual background
- Update a webinar poll
- Create a webinar's branding name tag
- Add a webinar registrant
- Upload a webinar's branding virtual background
- Remove all panelists
- Delete a webinar's branding name tag
- Create webinar's invite links
- Update a webinar
- Delete a webinar poll
- Delete a webinar survey
- Add panelists
- Update registration questions
- Delete a webinar
- Update a webinar survey
- Update a live stream
- Remove a panelist
- Create a webinar template
- Create a webinar's poll
- Create a webinar
- Update registrant's status
- Upload a webinar's branding wallpaper
- Update webinar status
- Delete a webinar's branding virtual backgrounds
- Delete a live webinar message
- Delete a webinar registrant
- Update live stream status
- Perform batch registration
webinar:write:admin
View and manage all user Webinars
Associated API
- Remove all panelists
- Delete a webinar registrant
- Delete a webinar poll
- Delete a webinar's branding wallpaper
- Set webinar's default branding virtual background
- Update live stream status
- Delete a webinar survey
- Update a webinar
- Delete a webinar's branding virtual backgrounds
- Create a webinar's poll
- Update webinar status
- Update registrant's status
- Upload a webinar's branding virtual background
- Delete a webinar's branding name tag
- Create a webinar
- Create a webinar's branding name tag
- Delete a live webinar message
- Create webinar's invite links
- Update registration questions
- Perform batch registration
- Add panelists
- Update a webinar poll
- Remove a panelist
- Delete a webinar
- Update a webinar survey
- Upload a webinar's branding wallpaper
- Create a webinar template
- Add a webinar registrant
- Update a webinar's branding name tag
- Update a live stream
webinar:write:admin:sip_dialing
Get CRC dial string with passcode
Associated API
webinar:write:sip_dialing
Get CRC dial string with passcode
Associated API
webinar_token:read:admin:live_streaming
View live streaming webinar token information
Associated API
webinar_token:read:admin:local_archiving
View local archiving webinar token information
Associated API
webinar_token:read:admin:local_recording
This scope allows an app to view an account's users' local recording webinar token information
Associated API
webinar_token:read:live_streaming
View live streaming webinar token information
Associated API
webinar_token:read:local_recording
This scope allows an app to view a user's local recording webinar token information
Associated API
Whiteboard scopes
The following are the available Whiteboard scopes and their associated API calls:
whiteboard:read
Get my whiteboard(s)
Associated API
whiteboard:read:admin
Get account’s whiteboard(s)
Associated API
whiteboard:write
Update or trash my whiteboard
Associated API
- Remove classification from whiteboard
- Delete a whiteboard
- Create a new whiteboard
- Apply classification to whiteboard
whiteboard:write:admin
Update or trash my whiteboard
Associated API
- Update whiteboard basic information
- Apply classification to whiteboard
- Delete a whiteboard
- Remove classification from whiteboard
whiteboard_classification_labels:read
Read whiteboard classification labels
Associated API
whiteboard_classification_labels:read:admin
View account classification labels
Associated API
whiteboard_classification_labels:write:admin
View and manage account classification labels
Associated API
whiteboard_collaborator:read
View user's whiteboard collaborator information
Associated API
whiteboard_collaborator:read:admin
View account's whiteboard collaborator information
Associated API
whiteboard_collaborator:write
View and add collaborator information to the whiteboard
Associated API
- Update whiteboard collaborators
- Remove the collaborator from a whiteboard
- Share a whiteboard to new users or team chat channels.
whiteboard_collaborator:write:admin
View and manage account's whiteboard collaborator information
Associated API
- Share a whiteboard to new users or team chat channels.
- Remove the collaborator from a whiteboard
- Update whiteboard collaborators
whiteboard_content:read
View and export whiteboard content
Associated API
- Download Whiteboards activity file
- Get whiteboard export generation status
- List whiteboards sessions
- Download whiteboard export
- List whiteboard sessions activities
whiteboard_content:read:admin
View and export account’s whiteboard(s) content
Associated API
- List whiteboards sessions
- Download Whiteboards activity file
- Download whiteboard export
- List whiteboard sessions activities
- Get whiteboard export generation status
whiteboard_export:write
Create my whiteboard export data
Associated API
whiteboard_export:write:admin
Create account's whiteboard export data
Associated API
whiteboard_file:read
View whiteboard file information
Associated API
whiteboard_file:read:admin
View whiteboard file information
Associated API
whiteboard_file:write
View and manage whiteboard file informanation
Associated API
whiteboard_file:write:admin
View and manage account's whiteboard file information
Associated API
whiteboard_import:read
View user's whiteboard import information
Associated API
whiteboard_import:read:admin
View account's whiteboard import information
Associated API
whiteboard_import:write
View and manage user's whiteboard import information
Associated API
whiteboard_import:write:admin
view and manage account's whiteboard import information
Associated API
whiteboard_project:read
View user's project information
Associated API
whiteboard_project:read:admin
View account's project information
Associated API
whiteboard_project:write
View and manage user's project information
Associated API
- Update project basic information
- Create a new project
- Move whiteboards to a project
- Remove whiteboards from a project
- Create a subproject
- Delete a project
whiteboard_project:write:admin
View and manage account's project information
Associated API
- Create a subproject
- Update project basic information
- Remove whiteboards from a project
- Delete a project
- Create a new project
- Move whiteboards to a project
whiteboard_project_collaborator:read
View user's project collaborator information
Associated API
whiteboard_project_collaborator:read:admin
View account's project collaborator information
Associated API
whiteboard_project_collaborator:write
View and update user's project collaborator information
Associated API
whiteboard_project_collaborator:write:admin
View and update account's project collaborator information
Associated API
whiteboard_share_setting:write
View and manage your whiteboard sharing settings
Associated API
whiteboard_share_setting:write:admin
View and manage account's whiteboard sharing settings
Associated API
Workspace scopes
The following are the available Workspace scopes and their associated API calls:
workspace:read
View workspace reservation information
Associated API
- Get a location's hot desk usage
- Get a workspace reservation by reservationId
- List workspace additional information with time range
- Get a desk assignment
- Get a workspace's reservations
- List workspaces
- Get a workspace location floor map
workspace:read:admin
View workspace reservation information for the account
Associated API
- Get a user's workspace's reservations
- List workspaces
- Get Workspace Calendar Free/Busy Event
- Get a workspace
- Get a workspace QR code
- Get a workspace asset
- Get a workspace reservation by reservationId
- Get a desk assignment
- List workspace additional information with time range
- List released workspaces by timeout
- Get questionnaire answer summary
- Get a workspace location floor map
- Get a workspace's reservations
- Get all workspace assets
- Get a location's hot desk usage
- List workspace reservation questionnaires
workspace:write
Edit workspace reservation information
Associated API
workspace:write:admin
Edit workspace reservation information for the account
Associated API
- Delete Workspace floor map
- Update a workspace
- Update a reservation
- Create a workspace asset
- Delete a workspace asset
- Delete a reservation
- Set Workspace Calendar Free/Busy Event
- Create a workspace
- Update workspace settings
- Add a workspace photo
- Add or Update a Workspace floor map
- Edit a workspace asset
- Delete a workspace
- Delete a desk assignment
- Create a reservation
- Delete workspace photos
- Check in/out of a reservation
- Set a desk assignment
Zoom AIC scopes
The following are the available Zoom AIC scopes and their associated API calls:
aic_archive:read:admin
View all user's AIC archive files
Associated API
- [Get AI Companion conversation archives](/docs/api/rest/reference/AI Companion/methods/#operation/GetAICconversationarchives)
Zoom Account scopes
The following are the available Zoom Account scopes and their associated API calls:
data_request:read:admin
Allows viewing and downloading data request information
Associated API
- Get download link for data access request file
- List data request history
- List downloadable files for export data request
data_request:write:admin
Allows creation and modification of data requests
Associated API
- Create data (export/deletion) request
- List downloadable files for export data request
- Get download link for data access request file
- List data request history
- Cancel data deletion request
Zoom Auto Dialer scopes
The following are the available Zoom Auto Dialer scopes and their associated API calls:
dialer:read:admin
View Dialer
Associated API
- [Get Call History](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/GetCallHistory)
- [List Call Lists](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/ListCallLists)
- [Get Prospect by ID](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/GetProspectbyID)
- [List All Prospects in Call List](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/ListAllProspectsInCallList)
- [Get Call List by ID](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/GetCallListbyID)
- [Get Call History by ID](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/GetCallDetailsbyCallID)
dialer:write:admin
Manage Dialer
Associated API
- [Delete Call List](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/DeleteCallList)
- [Create Prospects batch](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/CreateProspects)
- [Update Prospect](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/UpdateProspect)
- [Update Prospects batch](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/UpdateProspects)
- [Create Call List](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/CreateCallList)
- [Delete Prospect](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/DeleteProspect)
- [Update Call List](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/UpdateCallList)
- [Create Prospect](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/CreateProspect)
Zoom Clips scopes
The following are the available Zoom Clips scopes and their associated API calls:
clips:read:master
view your subAccount clips info
Associated API
Zoom Docs scopes
The following are the available Zoom Docs scopes and their associated API calls:
docs:read
Get basic info of the file
Associated API
docs:write
Edit basic info of a file
Associated API
Zoom Events scopes
The following are the available Zoom Events scopes and their associated API calls:
zoom_events_access_links:read
View event's Access Link
Associated API
zoom_events_access_links:read:admin
View event's Access Link
Associated API
zoom_events_access_links:write
View and Manage Zoom Event's access links
Associated API
zoom_events_access_links:write:admin
View and Manage Zoom Event's access links
Associated API
zoom_events_attendee_actions:read
View attendee actions performed by host for an event/session
Associated API
zoom_events_attendee_actions:read:admin
View attendee actions performed by host for an event/session
Associated API
zoom_events_attendee_actions:write
View and manage attendee actions performed by host for an event/session
Associated API
zoom_events_attendee_actions:write:admin
View and manage attendee actions performed by host for an event/session
Associated API
zoom_events_basic:read
View your Zoom events
Associated API
zoom_events_basic:read:admin
View all events information
Associated API
zoom_events_basic:write
Manage your Zoom events
Associated API
zoom_events_basic:write:admin
View and manage events information
Associated API
zoom_events_coeditor:write
View and manage coeditor information
Associated API
zoom_events_coeditor:write:admin
View and manage coeditor information
Associated API
zoom_events_coeditors:read
View Zoom event coeditors information
Associated API
zoom_events_coeditors:read:admin
View Zoom events coeditor information
Associated API
zoom_events_email:read
View emails for an event
Associated API
zoom_events_email:read:admin
View emails for an event
Associated API
zoom_events_exhibitors:read
View exhibitor information for an event
Associated API
zoom_events_exhibitors:read:admin
View exhibitor information for an event
Associated API
zoom_events_exhibitors:write
View and manage exhibitor information for an event
Associated API
zoom_events_exhibitors:write:admin
View and manage exhibitor information for an event
Associated API
zoom_events_file:write
zoom events file upload
Associated API
zoom_events_file:write:admin
zoom events file upload account level
Associated API
zoom_events_hub:write
Update Zoom Events hub configuration
Associated API
zoom_events_hub:write:admin
Update Zoom Events hub information
Associated API
zoom_events_hubs:read
View all hubs information
Associated API
zoom_events_hubs:read:admin
View all hubs information
Associated API
zoom_events_registrants:read
View event registrants information
Associated API
zoom_events_registrants:read:admin
View event registrants information
Associated API
zoom_events_reports:read
View Zoom events report
Associated API
- Get session attendance report
- Get custom report
- Get chat transcripts report
- Get event survey report
- Get event attendance (Live or Lobby) report
- Get event registrations report
zoom_events_reports:read:admin
View Zoom events reports
Associated API
- Get event registrations report
- Get chat transcripts report
- Get event survey report
- Get custom report
- Get event attendance (Live or Lobby) report
- Get session attendance report
zoom_events_sessions:read
View event session information
Associated API
- List session reservations
- Get ticket session join token by Event ID and Session ID
- List session interpreters
- Get the session information
- List sessions
- List session polls
- Get session livestream configuration
zoom_events_sessions:read:admin
View event session information
Associated API
- Get session livestream configuration
- Get ticket session join token by Event ID and Session ID
- List session interpreters
- List session polls
- Get the session information
- List session reservations
- List sessions
zoom_events_sessions:write
View and manage event session information
Associated API
- Create or update session polls
- Update a session
- Add session reservations
- Delete session reservations
- Update session livestream configuration
- Delete a session
- Create a session
- Create or update session interpreters
zoom_events_sessions:write:admin
View and manage event session information
Associated API
- Create or update session polls
- Add session reservations
- Delete a session
- Create a session
- Update session livestream configuration
- Delete session reservations
- Update a session
- Create or update session interpreters
zoom_events_speakers:read
View event speaker information
Associated API
zoom_events_speakers:read:admin
View event speaker information
Associated API
zoom_events_speakers:write
Manage event speaker information
Associated API
zoom_events_speakers:write:admin
Manage event speaker information
Associated API
zoom_events_ticket_types:read
View all event ticket types
Associated API
- List ticket types
- List registration questions for ticket type
- List registration questions for an event
zoom_events_ticket_types:read:admin
View all event ticket types
Associated API
- List ticket types
- List registration questions for an event
- List registration questions for ticket type
zoom_events_ticket_types:write
View and manage event ticket types
Associated API
- Create an event ticket type
- Update registration questions for an event
- Update ticket type for an event
- Delete a ticket type
- Update registration questions for ticket type
zoom_events_ticket_types:write:admin
View and manage event ticket types
Associated API
- Update ticket type for an event
- Update registration questions for an event
- Create an event ticket type
- Update registration questions for ticket type
- Delete a ticket type
zoom_events_tickets:read
View event tickets and event ticket details
Associated API
zoom_events_tickets:read:admin
View event tickets information
Associated API
zoom_events_tickets:write
Create event tickets
Associated API
zoom_events_tickets:write:admin
View and manage event tickets information
Associated API
zoom_events_videos:read
View video details
Associated API
zoom_events_videos:read:admin
View video information
Associated API
zoom_events_videos:write
Manage video information
Associated API
zoom_events_videos:write:admin
Manage video information
Associated API
zoom_events_vod_channels:read
View on-demand video channels
Associated API
zoom_events_vod_channels:read:admin
View on-demand video channels
Associated API
zoom_events_vod_channels:write
View and manage on-demand video channels
Associated API
- Add VOD channel videos
- Create VOD channel
- Delete VOD channel video
- VOD channel actions
- Update VOD channel
- Delete VOD Channel
zoom_events_vod_channels:write:admin
View and manage on-demand video channels
Associated API
- Update VOD channel
- Add VOD channel videos
- Create VOD channel
- Delete VOD channel video
- VOD channel actions
- Delete VOD Channel
zoom_events_vod_registration:read
Read VOD channel registrations
Associated API
zoom_events_vod_registration:read:admin
Read VOD channel registration settings
Associated API
zoom_events_vod_registration:write
Update VOD channel registrations
Associated API
zoom_events_vod_registration:write:admin
Update VOD channel registrations
Associated API
zoom_events_vod_reports:read
Zoom Events VOD reports
Associated API
zoom_events_vod_reports:read:admin
Zoom events VOD reports
Associated API
Zoom IQ scopes
The following are the available Zoom IQ scopes and their associated API calls:
iq_account:read:admin
View all account settings information
Associated API
iq_coaching:read
View your coaching information
Associated API
iq_coaching:read:admin
View all coaching information
Associated API
iq_comment:read
View your comments information
Associated API
iq_comment:read:admin
Manage all comments information
Associated API
iq_comment:write
Mangage your comments information
Associated API
- Get conversation comments [Deprecated]
- Get conversation comments
- Add new comments to the conversation
- Add new comments to the conversation [Deprecated]
- Delete conversation's comment
- Edit conversation comment
- Delete conversation's comment [Deprecated]
- Edit conversation comment [Deprecated]
iq_comment:write:admin
Manage all comments information
Associated API
- Add new comments to the conversation [Deprecated]
- Edit conversation comment
- Delete conversation's comment [Deprecated]
- Delete conversation's comment
- Edit conversation comment [Deprecated]
- Add new comments to the conversation
- Get conversation comments [Deprecated]
- Get conversation comments
iq_conversation:read
View your conversations information
Associated API
- Get conversation content analysis
- Get conversation content analysis [Deprecated]
- Get conversation interactions [Deprecated]
- List conversations
- Get conversation information [Deprecated]
- Get conversation interactions
- List scheduled meetings
- Get conversation information
- List conversations [Deprecated]
iq_conversation:read:admin
View all conversations information
Associated API
- Get conversation content analysis
- List conversations
- Get conversation interactions [Deprecated]
- Get conversation content analysis [Deprecated]
- Get conversation information [Deprecated]
- List conversations [Deprecated]
- Get conversation interactions
- List scheduled meetings
- Get conversation information
iq_conversation:write
Manage your conversations information
Associated API
- Update conversation host id to new host id by conversation id [Deprecated]
- Get conversation information [Deprecated]
- Get conversation interactions [Deprecated]
- Delete conversation by conversation ID [Deprecated]
- Add conversation by file id or download url.
- Add conversation by meeting record url or meeting UUID.
- Upload IQ file [Deprecated]
- Get conversation interactions
- List scheduled meetings
- Initiate and complete a multipart upload.
- Get conversation information
- [Initiate and complete a multipart upload. [Deprecated]](/docs/api/rest/reference/iq/methods/#operation/InitiateAndCompleteAMultipartUpload. [Deprecated])
- Add conversation by file id or download url. [Deprecated]
- Add conversation by meeting record url or meeting UUID. [Deprecated]
- Upload iq multipart file.
- Get conversation content analysis [Deprecated]
- Upload IQ file
- Update conversation host id to new host id by conversation id
- Delete conversation by conversation ID
- Get conversation content analysis
- List conversations
- List conversations [Deprecated]
- Upload iq multipart file. [Deprecated]
iq_conversation:write:admin
Manage all conversations information
Associated API
- Get conversation interactions
- List conversations [Deprecated]
- Upload iq multipart file. [Deprecated]
- Delete conversation by conversation ID [Deprecated]
- Update conversation host id to new host id by conversation id [Deprecated]
- List conversations
- Upload IQ file [Deprecated]
- Get conversation interactions [Deprecated]
- Upload iq multipart file.
- Add conversation by meeting record url or meeting UUID. [Deprecated]
- List scheduled meetings
- [Initiate and complete a multipart upload. [Deprecated]](/docs/api/rest/reference/iq/methods/#operation/InitiateAndCompleteAMultipartUpload. [Deprecated])
- Get conversation information
- Add conversation by meeting record url or meeting UUID.
- Update conversation host id to new host id by conversation id
- Get conversation content analysis
- Add conversation by file id or download url. [Deprecated]
- Get conversation content analysis [Deprecated]
- Upload IQ file
- Initiate and complete a multipart upload.
- Get conversation information [Deprecated]
- Add conversation by file id or download url.
- Delete conversation by conversation ID
iq_deal:read
Retrieve ZoomIQ Deal information with activity
Associated API
- List deals [Deprecated]
- Get deal information
- List deals
- Get deal activities
- Get deal information [Deprecated]
- Get deal activities [Deprecated]
iq_deal:read:admin
Retrieve ZoomIQ Deal information with activity
Associated API
- Get deal information
- List deals [Deprecated]
- Get deal information [Deprecated]
- Get deal activities [Deprecated]
- Get deal activities
- List deals
iq_deal:write
View and manage deal activities
Associated API
- List deals [Deprecated]
- Get deal information
- Get deal activities [Deprecated]
- Delete activity from the deal
- Get deal information [Deprecated]
- Get deal activities
- Delete activity from the deal [Deprecated]
- List deals
iq_deal:write:admin
View and manage deal activities
Associated API
- Delete activity from the deal [Deprecated]
- Get deal activities [Deprecated]
- Delete activity from the deal
- List deals [Deprecated]
- Get deal information [Deprecated]
- Get deal information
- List deals
- Get deal activities
iq_playlist:read
View all playlists information
Associated API
iq_playlist:read:admin
View all playlists information
Associated API
iq_team:read
Get team info in User level
Associated API
iq_team:read:admin
Get team info
Associated API
- List Account Teams [Deprecated]
- List Unassigned Team Users
- Get Team Detail
- List Team Managers
- List Account Teams
- List Team Members
iq_team:write:admin
team resource read&edit
Associated API
- Remove additional access from current team
- Assign Team Members
- Move team to new parent
- Assign Team Managers
- Unassign Team Managers
- Create Team
- Delete Team
- Update Team name
- Remove additional access from target teams
- Grant additional access to current team
- Unassign Team Members
- Grant additional access to target teams
Zoom Meeting scopes
The following are the available Zoom Meeting scopes and their associated API calls:
meeting_summary:write
View and manage your meeting summaries
Associated API
meeting_summary:write:admin
View and manage all user meeting summaries
Associated API
Zoom Quality Management scopes
The following are the available Zoom Quality Management scopes and their associated API calls:
qm_interactions:write
Manage the interactions.
Associated API
- [Add an interaction](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/Addinteraction)
qm_interactions:write:admin
Manage the interactions.
Associated API
- [Add an interaction](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/Addinteraction)
Zoom Revenue Accelerator scopes
The following are the available Zoom Revenue Accelerator scopes and their associated API calls:
iq_crm:read:admin
View CRM objects and metadata
Associated API
- Get CRM leads
- Get CRM deals
- Get CRM accounts
- Get CRM contacts
- Get current CRM API registration
- Poll async task result
iq_crm:write:admin
Edit CRM objects and metadata
Associated API
- Unregister CRM API connection
- Bulk import CRM leads
- Bulk import CRM accounts
- Bulk import CRM contacts
- Register CRM API connection
- Bulk import CRM deals
Zoom User scopes
The following are the available Zoom User scopes and their associated API calls:
division:read:admin
View divisions
Associated API
division:wirte:admin
View and manage divisions
Associated API
Zoom Video Management scopes
The following are the available Zoom Video Management scopes and their associated API calls:
video_mgmt_channels:read
View video channels information
Associated API
- List channels
- List channel permissions
- List channel videos
- List channel playlists
- Get channel details
video_mgmt_channels:read:admin
View video channels information
Associated API
- List channel permissions
- Get channel details
- List channel playlists
- List channel videos
- List channels
video_mgmt_channels:write
Manage video channels
Associated API
- Add channel playlists
- Delete channel videos
- Delete channel
- Add channel videos
- Channel actions
- Create a channel
- Create channel permissions
- Delete channel permissions
- Delete channel playlists
- Update channel permissions
- Update channel
video_mgmt_channels:write:admin
Manage video channels
Associated API
- Update channel
- Add channel playlists
- Channel actions
- Delete channel permissions
- Delete channel videos
- Update channel permissions
- Create a channel
- Create channel permissions
- Delete channel playlists
- Add channel videos
- Delete channel
video_mgmt_file:write
Upload file to video management
Associated API
video_mgmt_file:write:admin
upload a file to video management
Associated API
video_mgmt_playlists:read
View playlists
Associated API
video_mgmt_playlists:read:admin
View playlists
Associated API
video_mgmt_playlists:write
Manage playlists
Associated API
video_mgmt_playlists:write:admin
Manage playlists
Associated API
video_mgmt_videos:read
View videos information
Associated API
video_mgmt_videos:read:admin
View videos information
Associated API
ZoomCommerce scopes
The following are the available ZoomCommerce scopes and their associated API calls:
zoom_commerce:read:admin
Zoom commerce API read access for account admin
Associated API
- Get quote details by quote reference ID
- Gets all orders for a Zoom partner.
- Gets details of all files associated with a quote or deal registration
- Get detailed information about a specific invoice for a distributor or a reseller
- Gets the PDF document for the billing document ID
- Retrieves all valid Zoom Campaigns which a deal registration can be associated with.
- Gets subscription details for a given subscription number
- Gets the details for a Zoom product or offer.
- Download a file associated with a quote or deal registration.
- Gets all valid Deal Registrations for a partner
- Gets Zoom Product Catalog for a Zoom Partner
- Get trial details for an end customer by their Zoom account number or the trial ID
- Get trial subscriptions for a Zoom partner
- Gets all quotes for a Zoom partner
- Gets paid subscriptions for a Zoom partner.
- Get the account details for a Zoom Partner/Subreseller/End Customer
- Get order details by order reference ID
- Gets subscription changes/versions for a given subscription number.
- Get details of a deal registration by registration number
- Get the list of all accounts associated with a Zoom Partner/Sub-Reseller, by the account type
- Gets the pricebook in a downloadable file
- Gets all billing documents for a distributor or a reseller
zoom_commerce:write:admin
Zoom Commerce API write access for account admin
Associated API
- Update a subscription quote for a Zoom partner
- Preview delta quote metrics and subscriptions in a quote
- Preview delta order metrics and subscriptions in an order
- Upload an attachment pdf file in context of a deal registration or quote
- Updates an existing deal registration
- Create a subscription order for a Zoom partner
- Create an end customer account
- Add contacts to an existing end customer or your own account.
- Creates a new deal registration for a partner
- Create a subscription quote for a Zoom Partner
- Submits a subscription quote for provisioning
ZoomVirtualAgent scopes
The following are the available ZoomVirtualAgent scopes and their associated API calls:
zva:read:km_kbs
View your knowledge bases and articles
Associated API
zva:write:km_kbs
View and manage your knowledge bases and articles
Associated API
zva_report:read
View zva engagements
Associated API
- Get ZVA query details
- Get ZVA transcripts
- Get ZVA variable details
- Get ZVA engagements
- Get ZVA Surveys
default scopes
The following are the available default scopes and their associated API calls:
contact_center_block_list_rules:read:admin
Read Block List Rules
Associated API
- List block list rules of phone numbers
- List block list rules for IP addresses
- Get a block list rule of IP addresses
- Get a block list rule of phone numbers
workforce_management:write:admin
Create workforce management information
Associated API
- [Upload historical queue metrics](/docs/api/rest/reference/Workforce Management/methods/#operation/Uploadhistoricalqueuemetrics)
- [Create an organizational group](/docs/api/rest/reference/Workforce Management/methods/#operation/createOrganizationalGroup)
- [Delete organizational group](/docs/api/rest/reference/Workforce Management/methods/#operation/deleteOrganizationalGroup)
- [Update an organizational group](/docs/api/rest/reference/Workforce Management/methods/#operation/updateOrganizationalGroup)
workforce_management scopes
The following are the available workforce_management scopes and their associated API calls:
workforce_management:read:admin
View workforce management information
Associated API
- [Get multiple organizational groups](/docs/api/rest/reference/Workforce Management/methods/#operation/getMultipleOrganizationalGroups)
- [Get a single organizational group](/docs/api/rest/reference/Workforce Management/methods/#operation/getOrganizationalGroup)
- [Get a forecast for a scheduling group](/docs/api/rest/reference/Workforce Management/methods/#operation/Getforecastofschedulinggroup)
- [List forecasts](/docs/api/rest/reference/Workforce Management/methods/#operation/Listforecasts)
- [Get historical queue metrics import metadata](/docs/api/rest/reference/Workforce Management/methods/#operation/Viewhistoricalqueuemetricimoprtmeta)