Granular scopes

This reference lists the available Zoom OAuth API endpoints and granular scopes.


title: Granular Scopes description: Granular Scope List for Zoom API's


Zoom Meeting

The following are the available Zoom Meeting APIs and their associated granular scopes.

Archiving

API endpointgranular scope
Get a meeting's archived filesarchiving:read:archived_files:admin archiving:read:archived_files
List archived filesarchiving:read:list_archived_files:admin archiving:read:list_archived_files:master
List archived filesarchiving:read:list_archived_files:master
Get archived file statisticsarchiving:read:archived_file_statistics:admin
Get a meeting's archive token for local archivingmeeting:read:local_archiving_token:admin
Update an archived file's auto-delete statusarchiving:update:archived_file_auto_delete_status archiving:update:archived_file_auto_delete_status:admin
Delete a meeting's archived filesarchiving:delete:archived_files:admin

Cloud Recording

API endpointgranular scope
Get a meeting or webinar recording's analytics detailscloud_recording:read:recording_analytics_details cloud_recording:read:recording_analytics_details:master cloud_recording:read:recording_analytics_details:admin
Get a meeting or webinar recording's analytics detailscloud_recording:read:recording_analytics_details:master
Get a meeting transcriptcloud_recording:read:meeting_transcript cloud_recording:read:meeting_transcript:admin
Recover meeting recordingscloud_recording:update:recover_meeting_recordings cloud_recording:update:recover_meeting_recordings:master cloud_recording:update:recover_meeting_recordings:admin
Recover meeting recordingscloud_recording:update:recover_meeting_recordings:master
Get meeting recording settingscloud_recording:read:recording_settings cloud_recording:read:recording_settings:admin cloud_recording:read:recording_settings:master
Get meeting recording settingscloud_recording:read:recording_settings:master
Get registration questionscloud_recording:read:registration_questions cloud_recording:read:registration_questions:master cloud_recording:read:registration_questions:admin
Get registration questionscloud_recording:read:registration_questions:master
Create a recording registrantcloud_recording:write:recording_registrant cloud_recording:write:recording_registrant:master cloud_recording:write:recording_registrant:admin
Create a recording registrantcloud_recording:write:recording_registrant:master
List an account's recordingscloud_recording:read:list_account_recordings:master cloud_recording:read:list_account_recordings:admin
List all recordingscloud_recording:read:list_user_recordings cloud_recording:read:list_user_recordings:master cloud_recording:read:list_user_recordings:admin
List all recordingscloud_recording:read:list_user_recordings:master
Update a registrant's statuscloud_recording:update:registrant_status cloud_recording:update:registrant_status:master cloud_recording:update:registrant_status:admin
Update a registrant's statuscloud_recording:update:registrant_status:master
Get a meeting or webinar recording's analytics summarycloud_recording:read:recording_analytics_summary cloud_recording:read:recording_analytics_summary:master cloud_recording:read:recording_analytics_summary:admin
Get a meeting or webinar recording's analytics summarycloud_recording:read:recording_analytics_summary:master
Recover a single recordingcloud_recording:update:recover_single_recording cloud_recording:update:recover_single_recording:master cloud_recording:update:recover_single_recording:admin
Recover a single recordingcloud_recording:update:recover_single_recording:master
List recording registrantscloud_recording:read:list_recording_registrants cloud_recording:read:list_recording_registrants:admin cloud_recording:read:list_recording_registrants:master
List recording registrantscloud_recording:read:list_recording_registrants:master
Delete a recording file for a meeting or webinarcloud_recording:delete:recording_file cloud_recording:delete:recording_file:admin cloud_recording:delete:recording_file:master
Delete a recording file for a meeting or webinarcloud_recording:delete:recording_file:master
Delete meeting or webinar recordingscloud_recording:delete:meeting_recording cloud_recording:delete:meeting_recording:admin cloud_recording:delete:meeting_recording:master
Delete meeting or webinar recordingscloud_recording:delete:meeting_recording:master
Update meeting recording settingscloud_recording:update:recording_settings cloud_recording:update:recording_settings:master cloud_recording:update:recording_settings:admin
Update meeting recording settingscloud_recording:update:recording_settings:master
Get meeting recordingscloud_recording:read:list_recording_files:admin cloud_recording:read:list_recording_files cloud_recording:read:list_recording_files:master
Get meeting recordingscloud_recording:read:list_recording_files:master
Update registration questionscloud_recording:update:registration_questions:admin cloud_recording:update:registration_questions cloud_recording:update:registration_questions:master
Update registration questionscloud_recording:update:registration_questions:master
Delete a meeting or webinar transcriptcloud_recording:delete:meeting_transcript cloud_recording:delete:meeting_transcript:admin

Devices

API endpointgranular scope
Upgrade ZPA firmware or appdevice:write:zpa_os_app:admin device:write:zpa_os_app:master
Get ZPA version infodevice:read:list_zpa_versions:admin device:read:list_zpa_versions:master
Assign a device to a user or commonareadevice:write:zpa_device:admin device:write:zpa_device:master
Delete ZPA device by vendor and mac addressdevice:delete:zpa_device:admin device:delete:zpa_device:master
Get ZDM group infodevice:read:list_groups:admin device:read:list_groups:master
Assign a device to a groupdevice:write:group:admin device:write:group:master
Get Zoom Phone Appliance settings by user IDdevice:read:user_setting:admin device:read:user_setting:master
Change device associationdevice:update:zdm_device_assignment:admin

H323 Devices

API endpointgranular scope
Create a H.323/SIP deviceh323_device:write:device:admin
Delete a H.323/SIP deviceh323_device:delete:device:admin
Update a H.323/SIP deviceh323_device:update:device:admin
List all H.323/SIP devicesh323_device:read:list_devices:admin

In-Meeting Apps

API endpointgranular scope
Add a meeting appmeeting:write:open_app meeting:write:open_app:admin
Delete a meeting appmeeting:delete:open_app meeting:delete:open_app:admin

In-Meeting Features

API endpointgranular scope
Get a meeting's join token for local recordingmeeting:read:local_recording_token meeting:read:local_recording_token:admin
In-meeting controlsmeeting:update:in_meeting_controls meeting:update:in_meeting_controls:admin
In-meeting controlsmeeting:update:in_meeting_controls:master
Update a live meeting messagemeeting:update:live_meeting_chat_message meeting:update:live_meeting_chat_message:admin
Get meeting's tokenmeeting:read:token meeting:read:token:admin
Get meeting's tokenmeeting:read:token:master
Delete a live meeting messagemeeting:delete:live_meeting_chat_message meeting:delete:live_meeting_chat_message:admin

Invitation & Registration

API endpointgranular scope
Delete a meeting registrantmeeting:delete:registrant meeting:delete:registrant:admin
Delete a meeting registrantmeeting:delete:registrant:master
Perform batch registrationmeeting:write:batch_registrants meeting:write:batch_registrants:admin
Perform batch registrationmeeting:write:batch_registrants:master
Get meeting invitationmeeting:read:invitation meeting:read:invitation:admin
Get meeting invitationmeeting:read:invitation:master
Add a meeting registrantmeeting:write:registrant meeting:write:registrant:admin
Add a meeting registrantmeeting:write:registrant:master
Update registration questionsmeeting:update:registration_question meeting:update:registration_question:admin
Update registration questionsmeeting:update:registration_question:master
Update registrant's statusmeeting:update:registrant_status meeting:update:registrant_status:admin
Update registrant's statusmeeting:update:registrant_status:master
Create a meeting's invite linksmeeting:write:invite_links meeting:write:invite_links:admin
Create a meeting's invite linksmeeting:write:invite_links:master
List meeting registrantsmeeting:read:list_registrants meeting:read:list_registrants:admin
List meeting registrantsmeeting:read:list_registrants:master
List registration questions meeting:read:list_registration_questions meeting:read:list_registration_questions:admin
Get a meeting registrantmeeting:read:registrant meeting:read:registrant:admin
Get a meeting registrantmeeting:read:registrant:master

Live streaming

API endpointgranular scope
Update a livestreammeeting:update:livestream meeting:update:livestream:admin
Update a livestreammeeting:update:livestream:master
Update livestream statusmeeting:update:livestream_status meeting:update:livestream_status:admin
Update livestream statusmeeting:update:livestream_status:master
Get livestream detailsmeeting:read:livestream meeting:read:livestream:admin
Get livestream detailsmeeting:read:livestream:master
Get a meeting's join token for live streamingmeeting:read:live_streaming_token meeting:read:live_streaming_token:admin

Meetings

API endpointgranular scope
List past meeting instancesmeeting:read:list_past_instances meeting:read:list_past_instances:admin
List past meeting instancesmeeting:read:list_past_instances:master
Get past meeting participantsmeeting:read:list_past_participants meeting:read:list_past_participants:admin
Get a meeting SIP URI with passcodemeeting:write:sip_dialing meeting:write:sip_dialing:admin
Update meeting statusmeeting:update:status meeting:update:status:admin
Update meeting statusmeeting:update:status:master
Get past meeting detailsmeeting:read:past_meeting meeting:read:past_meeting:admin
Create a meetingmeeting:write:meeting meeting:write:meeting:admin
Create a meetingmeeting:write:meeting:master
Delete a meetingmeeting:delete:meeting meeting:delete:meeting:admin
Delete a meetingmeeting:delete:meeting:master
List meetingsmeeting:read:list_meetings meeting:read:list_meetings:admin
List meetingsmeeting:read:list_meetings:master
Update participant Real-Time Media Streams (RTMS) app statusmeeting:update:participant_rtms_app_status meeting:update:participant_rtms_app_status:admin
Get a meetingmeeting:read:meeting meeting:read:meeting:admin
Get a meetingmeeting:read:meeting:master
Update a meetingmeeting:update:meeting:admin meeting:update:meeting
Update a meetingmeeting:update:meeting:master
List upcoming meetingsmeeting:read:list_upcoming_meetings meeting:read:list_upcoming_meetings:admin
List past meetings' Q&Ameeting:read:past_qa meeting:read:past_qa:admin

PAC

API endpointgranular scope
List a user's PAC accountspac:read:list_pac_accounts pac:read:list_pac_accounts:admin
List a user's PAC accountspac:read:list_pac_accounts:master

Polls

API endpointgranular scope
Delete a meeting pollmeeting:delete:poll meeting:delete:poll:admin
Delete a meeting pollmeeting:delete:poll:master
List meeting pollsmeeting:read:list_polls meeting:read:list_polls:admin
List meeting pollsmeeting:read:list_polls:master
List past meeting's poll resultsmeeting:read:list_poll_results meeting:read:list_poll_results:admin
Perform batch poll creationmeeting:write:batch_polls meeting:write:batch_polls:admin
Perform batch poll creationmeeting:write:batch_polls:master
Create a meeting pollmeeting:write:poll meeting:write:poll:admin
Create a meeting pollmeeting:write:poll:master
Get a meeting pollmeeting:read:poll meeting:read:poll:admin
Get a meeting pollmeeting:read:poll:master
Update a meeting pollmeeting:update:poll meeting:update:poll:admin
Update a meeting pollmeeting:update:poll:master

Reports

API endpointgranular scope
Get disclaimer reportreport:read:disclaimer:admin
Get disclaimer reportreport:read:disclaimer:master
Get a meeting activities reportreport:read:meeting_activity_log:admin
Get a meeting activities reportreport:read:meeting_activity_log:master
Get telephone reportsreport:read:telephone:admin
Get telephone reportsreport:read:telephone:master
Get meeting detail reportsreport:read:meeting:admin
Get meeting detail reportsreport:read:meeting:master
Get operation logs reportreport:read:operation_logs:admin
Get operation logs reportreport:read:operation_logs:master
Get meeting Q&A reportreport:read:meeting_qna:admin
Get meeting Q&A reportreport:read:meeting_qna:master
Get history meeting and webinar listreport:read:list_history_meetings:admin
Get history meeting and webinar listreport:read:list_history_meetings:master
Get remote support reportreport:read:remote_support:admin
Get remote support reportreport:read:remote_support:master
Get webinar poll reportsreport:read:list_webinar_polls:admin
Get webinar poll reportsreport:read:list_webinar_polls:master
Get webinar Q&A reportreport:read:webinar_qna:admin
Get webinar Q&A reportreport:read:webinar_qna:master
Get sign In / sign out activity reportreport:read:user_activities:admin
Get sign In / sign out activity reportreport:read:user_activities:master
Get meeting poll reportsreport:read:list_meeting_polls:admin
Get meeting poll reportsreport:read:list_meeting_polls:master
Get meeting reportsreport:read:user:admin
Get meeting reportsreport:read:user:master
Get active or inactive host reportsreport:read:list_users:admin
Get active or inactive host reportsreport:read:list_users:master
Get webinar participant reportsreport:read:list_webinar_participants:admin
Get webinar participant reportsreport:read:list_webinar_participants:master
Get upcoming events reportsreport:read:upcoming_meetings_webinars:admin
Get upcoming events reportsreport:read:upcoming_meetings_webinars:master
Get webinar survey reportreport:read:webinar_survey:admin
Get webinar survey reportreport:read:webinar_survey:master
Get meeting participant reportsreport:read:list_meeting_participants:admin
Get meeting participant reportsreport:read:list_meeting_participants:master
Get billing reportsreport:read:billing:admin
Get billing reportsreport:read:billing:master
Get webinar detail reportsreport:read:webinar:admin
Get webinar detail reportsreport:read:webinar:master
Get billing invoice reportsreport:read:billing_invoice:admin
Get billing invoice reportsreport:read:billing_invoice:master
Get meeting survey reportreport:read:meeting_survey:admin
Get meeting survey reportreport:read:meeting_survey:master

SIP Connected Audio

API endpointgranular scope
List internal call-out countriessip_connected_audio:read:callout_countries:master sip_connected_audio:read:callout_countries:admin
List internal numberssip_connected_audio:read:internal_numbers:master sip_connected_audio:read:internal_numbers:admin
Add internal call-out countriessip_connected_audio:write:callout_countries:admin sip_connected_audio:write:callout_countries:master
Assign SIP trunk configurationsip_connected_audio:update:settings:master sip_connected_audio:update:settings:admin
Add internal numberssip_connected_audio:write:internal_numbers:admin sip_connected_audio:write:internal_numbers:master
Get SIP trunk configurationsip_connected_audio:read:settings:master sip_connected_audio:read:settings:admin
List SIP trunkssip_connected_audio:read:trunks:master sip_connected_audio:read:trunks:admin
Assign SIP trunkssip_connected_audio:write:trunks:master
Delete a SIP trunksip_connected_audio:delete:trunks:master
Delete all numberssip_connected_audio:delete:numbers:master
Assign numberssip_connected_audio:write:numbers:master
Delete an internal numbersip_connected_audio:delete:internal_numbers:admin sip_connected_audio:delete:internal_numbers:master
List SIP trunk numberssip_connected_audio:read:numbers:master
Update an internal numbersip_connected_audio:update:internal_numbers:master sip_connected_audio:update:internal_numbers:admin
Delete internal call-out countrysip_connected_audio:delete:callout_countries:master sip_connected_audio:delete:callout_countries:admin

SIP Phone

API endpointgranular scope
Enable SIP phonesip_phone:write:sip_phone:admin
Enable SIP phonesip_phone:write:sip_phone:master
Update SIP phonesip_phone:update:sip_phone:admin
Update SIP phonesip_phone:update:sip_phone:master
List SIP phonessip_phone:read:list_sip_phones:admin
List SIP phonessip_phone:read:list_sip_phones:master
Delete SIP phonesip_phone:delete:sip_phone:admin
Delete SIP phonesip_phone:delete:sip_phone:master

Summaries

API endpointgranular scope
List an account's meeting or webinar summariesmeeting:read:list_summaries:admin
List an account's meeting or webinar summariesmeeting:read:list_summaries:master
Delete a meeting or webinar summarymeeting:delete:summary meeting:delete:summary:admin
Delete a meeting or webinar summarymeeting:delete:summary:master
Get a meeting or webinar summarymeeting:read:summary meeting:read:summary:admin
Get a meeting or webinar summarymeeting:read:summary:master

Surveys

API endpointgranular scope
Update a meeting surveymeeting:update:survey meeting:update:survey:admin
Update a meeting surveymeeting:update:survey:master
Get a meeting surveymeeting:read:survey meeting:read:survey:admin
Get a meeting surveymeeting:read:survey:master
Delete a meeting surveymeeting:delete:survey meeting:delete:survey:admin
Delete a meeting surveymeeting:delete:survey:master

TSP

API endpointgranular scope
Add a user's TSP accounttsp:write:tsp_account tsp:write:tsp_account:admin
Add a user's TSP accounttsp:write:tsp_account:master
Get account's TSP informationtsp:read:tsp:admin
Get account's TSP informationtsp:read:tsp:master
Update a TSP accounttsp:update:tsp_account tsp:update:tsp_account:admin
Update a TSP accounttsp:update:tsp_account:master
Delete a user's TSP accounttsp:delete:tsp_account tsp:delete:tsp_account:admin
Delete a user's TSP accounttsp:delete:tsp_account:master
Set global dial-in URL for a TSP usertsp:update:tsp_settings tsp:update:tsp_settings:admin
Set global dial-in URL for a TSP usertsp:update:tsp_settings:master
Get a user's TSP accounttsp:read:tsp_account tsp:read:tsp_account:admin
Get a user's TSP accounttsp:read:tsp_account:master
Update an account's TSP informationtsp:update:tsp:admin
Update an account's TSP informationtsp:update:tsp:master
List user's TSP accountstsp:read:list_tsp_accounts tsp:read:list_tsp_accounts:admin
List user's TSP accountstsp:read:list_tsp_accounts:master

Templates

API endpointgranular scope
List meeting templatesmeeting:read:list_templates meeting:read:list_templates:admin
List meeting templatesmeeting:read:list_templates:master
Create a meeting template from an existing meetingmeeting:write:template meeting:write:template:admin
Create a meeting template from an existing meetingmeeting:write:template:master

Tracking Field

API endpointgranular scope
Get a tracking fieldtracking_field:read:tracking_field:admin
Get a tracking fieldtracking_field:read:tracking_field:master
Delete a tracking fieldtracking_field:delete:tracking_field:admin
Delete a tracking fieldtracking_field:delete:tracking_field:master
List tracking fieldstracking_field:read:list_tracking_fields:admin
List tracking fieldstracking_field:read:list_tracking_fields:master
Create a tracking fieldtracking_field:write:tracking_field:admin
Create a tracking fieldtracking_field:write:tracking_field:master
Update a tracking fieldtracking_field:update:tracking_field:admin
Update a tracking fieldtracking_field:update:tracking_field:master

Webinars

API endpointgranular scope
Delete a webinarwebinar:delete:webinar webinar:delete:webinar:admin
Delete a webinarwebinar:delete:webinar:master
List registration questionswebinar:read:list_registration_questions webinar:read:list_registration_questions:admin
List registration questionswebinar:read:list_registration_questions:master
Get a webinar's join token for local recordingwebinar:read:local_recording_token webinar:read:local_recording_token:admin
Create a webinar's pollwebinar:write:poll webinar:write:poll:admin
Create a webinar's pollwebinar:write:poll:master
Upload a webinar's branding virtual backgroundwebinar:write:branding_virtual_background webinar:write:branding_virtual_background:admin
Upload a webinar's branding virtual backgroundwebinar:write:branding_virtual_background:master
List a webinar's polls webinar:read:list_polls webinar:read:list_polls:admin
List a webinar's polls webinar:read:list_polls:master
Update registrant's statuswebinar:update:registrant_status webinar:update:registrant_status:admin
Update registrant's statuswebinar:update:registrant_status:master
Update a live streamwebinar:update:livestream webinar:update:livestream:admin
Update a live streamwebinar:update:livestream:master
Remove all panelistswebinar:delete:panelist webinar:delete:panelist:admin
Remove all panelistswebinar:delete:panelist:master
Update registration questionswebinar:update:registration_question webinar:update:registration_question:admin
Update registration questionswebinar:update:registration_question:master
Delete a webinar surveywebinar:delete:survey webinar:delete:survey:admin
Delete a webinar surveywebinar:delete:survey:master
Create a webinar templatewebinar:write:template webinar:write:template:admin
Create a webinar templatewebinar:write:template:master
List webinar templateswebinar:read:list_templates webinar:read:list_templates:admin
List webinar templateswebinar:read:list_templates:master
Get a webinarwebinar:read:webinar webinar:read:webinar:admin
Get a webinarwebinar:read:webinar:master
Get live stream detailswebinar:read:livestream webinar:read:livestream:admin
Get live stream detailswebinar:read:livestream:master
Upload a webinar's branding wallpaperwebinar:write:branding_wallpaper webinar:write:branding_wallpaper:admin
Upload a webinar's branding wallpaperwebinar:write:branding_wallpaper:master
Get a webinar pollwebinar:read:poll webinar:read:poll:admin
Get a webinar pollwebinar:read:poll:master
Get a webinar surveywebinar:read:survey webinar:read:survey:admin
Get a webinar surveywebinar:read:survey:master
Update a webinar pollwebinar:update:poll webinar:update:poll:admin
Update a webinar pollwebinar:update:poll:master
List past webinar poll resultswebinar:read:list_past_polls webinar:read:list_past_polls:admin
Get a webinar's archive token for local archivingwebinar:read:local_archiving_token:admin
Create a webinarwebinar:write:webinar webinar:write:webinar:admin
Create a webinarwebinar:write:webinar:master
List webinarswebinar:read:list_webinars webinar:read:list_webinars:admin
List webinarswebinar:read:list_webinars:master
Set webinar's default branding virtual backgroundwebinar:update:branding_virtual_background webinar:update:branding_virtual_background:admin
Set webinar's default branding virtual backgroundwebinar:update:branding_virtual_background:master
Get webinar's session brandingwebinar:read:branding webinar:read:branding:admin
Get webinar's session brandingwebinar:read:branding:master
Get a webinar's join token for live streamingwebinar:read:live_streaming_token webinar:read:live_streaming_token:admin
Delete a webinar's branding wallpaperwebinar:delete:branding_wallpaper webinar:delete:branding_wallpaper:admin
Delete a webinar's branding wallpaperwebinar:delete:branding_wallpaper:master
Get a webinar SIP URI with passcodewebinar:write:sip_dialing webinar:write:sip_dialing:admin
Perform batch registrationwebinar:write:batch_registrants webinar:write:batch_registrants:admin
Perform batch registrationwebinar:write:batch_registrants:master
Update a webinarwebinar:update:webinar webinar:update:webinar:admin
Update a webinarwebinar:update:webinar:master
Update webinar statuswebinar:update:status webinar:update:status:admin
Update webinar statuswebinar:update:status:master
Delete a webinar's branding virtual backgroundswebinar:delete:branding_virtual_background webinar:delete:branding_virtual_background:admin
Delete a webinar's branding virtual backgroundswebinar:delete:branding_virtual_background:master
List panelistswebinar:read:list_panelists webinar:read:list_panelists:admin
List panelistswebinar:read:list_panelists:master
Get webinar absenteeswebinar:read:list_absentees webinar:read:list_absentees:admin
Get webinar absenteeswebinar:read:list_absentees:master
Add a webinar registrantwebinar:write:registrant webinar:write:registrant:admin
Add a webinar registrantwebinar:write:registrant:master
Get webinar tracking sourceswebinar:read:list_tracking_sources webinar:read:list_tracking_sources:admin
Get webinar tracking sourceswebinar:read:list_tracking_sources:master
Delete a webinar pollwebinar:delete:poll webinar:delete:poll:admin
Delete a webinar pollwebinar:delete:poll:master
Get webinar's tokenwebinar:read:token webinar:read:token:admin
Get webinar's tokenwebinar:read:token:master
Get a webinar registrantwebinar:read:registrant webinar:read:registrant:admin
Get a webinar registrantwebinar:read:registrant:master
Remove a panelistwebinar:delete:panelist webinar:delete:panelist:admin
Remove a panelistwebinar:delete:panelist:master
Delete a webinar's branding name tagwebinar:delete:branding_name_tag webinar:delete:branding_name_tag:admin
Delete a webinar's branding name tagwebinar:delete:branding_name_tag:master
Update a webinar's branding name tagwebinar:update:branding_name_tag webinar:update:branding_name_tag:admin
Update a webinar's branding name tagwebinar:update:branding_name_tag:master
List Q&As of a past webinarwebinar:read:past_qa webinar:read:past_qa:admin
Add panelistswebinar:write:panelist webinar:write:panelist:admin
Add panelistswebinar:write:panelist:master
List past webinar instanceswebinar:read:list_past_instances webinar:read:list_past_instances:admin
List past webinar instanceswebinar:read:list_past_instances:master
Create webinar's invite linkswebinar:write:invite_links webinar:write:invite_links:admin
Create webinar's invite linkswebinar:write:invite_links:master
Update live stream statuswebinar:update:livestream_status webinar:update:livestream_status:admin
Update live stream statuswebinar:update:livestream_status:master
Update a webinar surveywebinar:update:survey webinar:update:survey:admin
Update a webinar surveywebinar:update:survey:master
Delete a webinar registrantwebinar:delete:registrant webinar:delete:registrant:admin
Delete a webinar registrantwebinar:delete:registrant:master
List webinar participantswebinar:read:list_past_participants:admin webinar:read:list_past_participants
Create a webinar's branding name tagwebinar:write:branding_name_tag webinar:write:branding_name_tag:admin
Create a webinar's branding name tagwebinar:write:branding_name_tag:master
List webinar registrantswebinar:read:list_registrants webinar:read:list_registrants:admin
List webinar registrantswebinar:read:list_registrants:master
Delete a live webinar messagewebinar:delete:live_webinar_chat_message webinar:delete:live_webinar_chat_message:admin

Zoom Mail

The following are the available Zoom Mail APIs and their associated granular scopes.

Drafts

API endpointgranular scope
Update the specified draft emailemail:update:draft email:update:draft:admin
List emails from draft folderemail:read:list_drafts email:read:list_drafts:admin
Get the specified draft emailemail:read:draft email:read:draft:admin
Send out a draft emailemail:write:send_draft email:write:send_draft:admin
Delete an existing draft emailemail:delete:draft email:delete:draft:admin
Create a new draft emailemail:write:draft email:write:draft:admin

History

API endpointgranular scope
List history of events for mailboxemail:read:history email:read:history:admin

Labels

API endpointgranular scope
Get the specified label in mailboxemail:read:label email:read:label:admin
Update the specified label in mailboxemail:update:label email:update:label:admin
List labels in the mailboxemail:read:list_labels email:read:list_labels:admin
Create a new label in mailboxemail:write:label email:write:label:admin
Delete an existing label from mailboxemail:delete:label email:delete:label:admin
Patch the specified label in mailboxemail:update:label email:update:label:admin

Mailbox

API endpointgranular scope
Get the mailbox profileemail:read:profile email:read:profile:admin

Messages

API endpointgranular scope
Delete an existing emailemail:delete:msg email:delete:msg:admin
Move the specified email to TRASH folderemail:write:trash_msg email:write:trash_msg:admin
Move the specified email out of TRASH folderemail:write:untrash_msg email:write:untrash_msg:admin
Update the specified emailemail:write:modify_msg email:write:modify_msg:admin
List emails from the mailboxemail:read:list_msgs email:read:list_msgs:admin
Send out an emailemail:write:send_msg email:write:send_msg:admin
Batch delete the specified emailsemail:write:batch_delete_msgs email:write:batch_delete_msgs:admin
Batch modify the specified emailsemail:write:batch_modify_msgs email:write:batch_modify_msgs:admin
Create a new emailemail:write:msg email:write:msg:admin
Get the specified emailemail:read:msg email:read:msg:admin

Messages.Attachments

API endpointgranular scope
Get the specified attachment for an emailemail:read:attachment email:read:attachment:admin

Settings

API endpointgranular scope
Update mailbox vacation response settingemail:update:setting_vacation email:update:setting_vacation:admin
Get mailbox vacation response settingemail:read:setting_vacation email:read:setting_vacation:admin

Settings.Delegates

API endpointgranular scope
Revoke an existing delegate access from the mailboxemail:delete:setting_delegate email:delete:setting_delegate:admin
List delegates on the mailboxemail:read:list_setting_delegates email:read:list_setting_delegates:admin
Grant a new delegate access on the mailboxemail:write:setting_delegate email:write:setting_delegate:admin
Get the specified delegate on the mailboxemail:read:setting_delegate email:read:setting_delegate:admin

Settings.Filters

API endpointgranular scope
Get the specified email filteremail:read:setting_filter email:read:setting_filter:admin
Delete the specified email filteremail:delete:setting_filter email:delete:setting_filter:admin
Create an email filteremail:write:setting_filter email:write:setting_filter:admin
List email filtersemail:read:list_setting_filters email:read:list_setting_filters:admin

Threads

API endpointgranular scope
Delete an existing email threademail:delete:thread email:delete:thread:admin
Get the specified email threademail:read:thread email:read:thread:admin
Move the specified thread out of TRASH folderemail:write:untrash_thread email:write:untrash_thread:admin
Move the specified thread to TRASH folderemail:write:trash_thread email:write:trash_thread:admin
List email threads from the mailboxemail:read:list_threads email:read:list_threads:admin
Update the specified threademail:write:thread email:write:thread:admin

Whiteboard

The following are the available Whiteboard APIs and their associated granular scopes.

Archiving

API endpointgranular scope
List whiteboards sessionswhiteboard:read:list_sessions whiteboard:read:list_sessions:admin
Download Whiteboards activity filewhiteboard:read:archived_file whiteboard:read:archived_file:admin
List whiteboard sessions activitieswhiteboard:read:session whiteboard:read:session:admin

Classification Labels

API endpointgranular scope
Delete classification labelwhiteboard:delete:classification_labels:admin
Remove classification from whiteboardwhiteboard:delete:whiteboard_classification whiteboard:delete:whiteboard_classification:admin
Apply classification to whiteboardwhiteboard:update:whiteboard_classification whiteboard:update:whiteboard_classification:admin
Create a classification labelwhiteboard:write:classification_labels:admin
Update a classification labelwhiteboard:update:classification_labels:admin
Get classification labelwhiteboard:read:classification_labels:admin
List classification labelswhiteboard:read:list_classification_labels:admin whiteboard:read:list_classification_labels

Collaborator

API endpointgranular scope
Remove the collaborator from a whiteboardwhiteboard:delete:collaborator:admin whiteboard:delete:collaborator
Get collaborators of a whiteboardwhiteboard:read:list_collaborators:admin whiteboard:read:list_collaborators
Share a whiteboard to new users or team chat channels.whiteboard:write:collaborator:admin whiteboard:write:collaborator
Update whiteboard collaboratorswhiteboard:update:collaborator:admin whiteboard:update:collaborator

Document

API endpointgranular scope
Get a whiteboardwhiteboard:read:whiteboard:admin whiteboard:read:whiteboard
Update whiteboard basic informationwhiteboard:update:whiteboard:admin
Create a new whiteboardwhiteboard:write:whiteboard
Delete a whiteboardwhiteboard:delete:whiteboard:admin whiteboard:delete:whiteboard
List all whiteboardswhiteboard:read:list_whiteboards:admin whiteboard:read:list_whiteboards

Export

API endpointgranular scope
Download whiteboard exportwhiteboard:read:export whiteboard:read:export:admin
Get whiteboard export generation statuswhiteboard:read:export whiteboard:read:export:admin
Create whiteboard exportwhiteboard:write:export whiteboard:write:export:admin

File

API endpointgranular scope
Download Imported Whiteboard Filewhiteboard:read:file whiteboard:read:file:admin
Upload file for whiteboard importwhiteboard:write:file whiteboard:write:file:admin

Import

API endpointgranular scope
Get whiteboard import status whiteboard:read:import:admin whiteboard:read:import
Create a new whiteboard by importwhiteboard:write:import whiteboard:write:import:admin

Project

API endpointgranular scope
Share a project to new userswhiteboard:write:project_collaborator whiteboard:write:project_collaborator:admin
Move whiteboards to a projectwhiteboard:write:project_whiteboard whiteboard:write:project_whiteboard:admin
Remove whiteboards from a projectwhiteboard:delete:project_whiteboard whiteboard:delete:project_whiteboard:admin
Remove the collaborator from a projectwhiteboard:delete:project_collaborator:admin whiteboard:delete:project_collaborator
Delete a projectwhiteboard:delete:project whiteboard:delete:project:admin
Update project basic informationwhiteboard:update:project:admin whiteboard:update:project
Get collaborators of a projectwhiteboard:read:project_collaborator whiteboard:read:project_collaborator:admin
List subprojectswhiteboard:read:subproject whiteboard:read:subproject:admin
Get a projectwhiteboard:read:project whiteboard:read:project:admin
Update project collaboratorswhiteboard:update:project_collaborator whiteboard:update:project_collaborator:admin
Create a new projectwhiteboard:write:project whiteboard:write:project:admin
List all projectswhiteboard:read:list_projects:admin whiteboard:read:list_projects
Create a subprojectwhiteboard:write:subproject whiteboard:write:subproject:admin

Settings

API endpointgranular scope
Update whiteboard share settingwhiteboard:update:share_setting:admin whiteboard:update:share_setting

Zoom Clips

The following are the available Zoom Clips APIs and their associated granular scopes.

Clips

API endpointgranular scope
List all clipsclips:read:list_user_clips clips:read:list_user_clips:admin
List all clipsclips:read:list_user_clips:master

Collaborator

API endpointgranular scope
Remove the collaborator from a clipclips:delete:collaborators clips:delete:collaborators:admin
Get collaborators of a clipclips:read:list_collaborator clips:read:list_collaborator:admin

Comment

API endpointgranular scope
List clip commentsclips:read:list_comments clips:read:list_comments:admin
Delete a commentclips:delete:comment clips:delete:comment:admin

Download

API endpointgranular scope
Download a clipclips:read:download_clip clips:read:download_clip:admin

Single

API endpointgranular scope
Delete a clip(soft delete)clips:delete:clip clips:delete:clip:admin
Get a clipclips:read:clip clips:read:clip:admin

Transfer

API endpointgranular scope
Transfer task status checkclips:read:transfer_task_status:admin
Transfer clips ownerclips:write:transfer_owner:admin

Zoom Account

The following are the available Zoom Account APIs and their associated granular scopes.

Accounts

API endpointgranular scope
Upload virtual background filesaccount:write:virtual_background_files:master account:write:virtual_background_files:admin
Upload virtual background filesaccount:write:virtual_background_files:master
Update an account's webinar registration settingsaccount:update:registration_settings:master
Update an account's webinar registration settingsaccount:update:registration_settings:master
Get sub account detailsaccount:read:sub_account:master account:read:sub_account:admin
Delete virtual background filesaccount:delete:virtual_background_files:master account:delete:virtual_background_files:admin
Delete virtual background filesaccount:delete:virtual_background_files:master
List sub accountsaccount:read:list_sub_accounts:master
Get account settingsaccount:read:settings:admin account:read:settings:master
Get account settingsaccount:read:settings:master
Update account settingsaccount:update:settings:admin account:update:settings:master
Update account settingsaccount:update:settings:master
Get an account's webinar registration settingsaccount:read:registration_settings:master
Get an account's webinar registration settingsaccount:read:registration_settings:master
Create a sub accountaccount:write:sub_account:master
Update the account owneraccount:update:owner:master account:update:owner:admin
Update the account owneraccount:update:owner:master
Update optionsaccount:update:options:master
Get account's managed domainsaccount:read:managed_domains:master
Get account's managed domainsaccount:read:managed_domains:master
Get account's trusted domainsaccount:read:trusted_domains:master
Get account's trusted domainsaccount:read:trusted_domains:master
Disassociate a sub accountaccount:delete:sub_account:master
Update locked settingsaccount:update:lock_settings:master account:update:lock_settings:admin
Update locked settingsaccount:update:lock_settings:master
Get locked settingsaccount:read:lock_settings:master
Get locked settingsaccount:read:lock_settings:master

Dashboards

API endpointgranular scope
Get top 25 issues of Zoom Roomsdashboard:read:issues_zoomroom:admin
Get top 25 issues of Zoom Roomsdashboard:read:issues_zoomroom:master
List client meeting satisfactiondashboard:read:meeting_survey:admin
List client meeting satisfactiondashboard:read:meeting_survey:master
Get issues of Zoom Roomsdashboard:read:issues_zoomroom:admin
Get issues of Zoom Roomsdashboard:read:issues_zoomroom:master
Get zoom meetings client feedbackdashboard:read:meeting_feedback:admin
Get zoom meetings client feedbackdashboard:read:meeting_feedback:master
Get post webinar feedbackdashboard:read:post_webinar_feedback:admin
Get post webinar feedbackdashboard:read:post_webinar_feedback:master
Get post meeting feedbackdashboard:read:post_meeting_feedback:admin
Get post meeting feedbackdashboard:read:post_meeting_feedback:master
List meeting participantsdashboard:read:list_meeting_participants:admin
List meeting participantsdashboard:read:list_meeting_participants:master
List meetingsdashboard:read:list_meetings:admin
List meetingsdashboard:read:list_meetings:master
Get Zoom Rooms detailsdashboard:read:zoomroom:admin
Get Zoom Rooms detailsdashboard:read:zoomroom:master
Get webinar participantsdashboard:read:list_webinar_participants:admin
Get webinar participantsdashboard:read:list_webinar_participants:master
Get top 25 Zoom Rooms with issuesdashboard:read:list_zoomrooms:admin
Get top 25 Zoom Rooms with issuesdashboard:read:list_zoomrooms:master
List Zoom Roomsdashboard:read:list_zoomrooms:admin
List Zoom Roomsdashboard:read:list_zoomrooms:master
Get webinar detailsdashboard:read:webinar:admin
Get webinar detailsdashboard:read:webinar:master
Get meeting participant QoSdashboard:read:meeting_participant_qos:admin
Get meeting participant QoSdashboard:read:meeting_participant_qos:master
List webinarsdashboard:read:list_webinars:admin
List webinarsdashboard:read:list_webinars:master
List meeting participants QoSdashboard:read:list_meeting_participants_qos:admin
List meeting participants QoSdashboard:read:list_meeting_participants_qos:master
List Zoom meetings client feedbackdashboard:read:list_meetings_feedback:admin
List Zoom meetings client feedbackdashboard:read:list_meetings_feedback:master
Get meeting quality scoresdashboard:read:meeting_quality_score:admin
Get meeting quality scoresdashboard:read:meeting_quality_score:master
Get CRC port usagedashboard:read:crc_port_usage:admin
Get CRC port usagedashboard:read:crc_port_usage:master
Get webinar participant QoSdashboard:read:webinar_participant_qos:admin
Get webinar participant QoSdashboard:read:webinar_participant_qos:master
List the client versionsdashboard:read:client_versions:admin
List the client versionsdashboard:read:client_versions:master
Get webinar sharing/recording detailsdashboard:read:webinar_sharing:admin
Get webinar sharing/recording detailsdashboard:read:webinar_sharing:master
Get chat metricsdashboard:read:chat:admin
Get chat metricsdashboard:read:chat:master
Get meeting sharing/recording detailsdashboard:read:meeting_sharing:admin
Get meeting sharing/recording detailsdashboard:read:meeting_sharing:master
List webinar participant QoSdashboard:read:list_webinar_participants_qos:admin
List webinar participant QoSdashboard:read:list_webinar_participants_qos:master
Get meeting detailsdashboard:read:meeting:admin
Get meeting detailsdashboard:read:meeting:master

Data Requests

API endpointgranular scope
Get download link for data access request filedata_request:read:download:admin
Cancel data deletion requestdata_request:delete:request:admin
List downloadable files for export data request data_request:read:download:admin
List data request historydata_request:read:history:admin
Create data (export/deletion) requestdata_request:write:request:admin

Information Barriers

API endpointgranular scope
Remove an Information Barrier policyinformation_barrier:delete:policy:admin
Remove an Information Barrier policyinformation_barrier:delete:policy:master
Update an Information Barriers policyinformation_barrier:update:policy:admin
Update an Information Barriers policyinformation_barrier:update:policy:master
Get an Information Barrier policy by IDinformation_barrier:read:policy:admin
Get an Information Barrier policy by IDinformation_barrier:read:policy:master
List information Barrier policiesinformation_barrier:read:list_policies:admin
List information Barrier policiesinformation_barrier:read:list_policies:master
Create an Information Barrier policyinformation_barrier:write:policy:admin
Create an Information Barrier policyinformation_barrier:write:policy:master

Roles

API endpointgranular scope
Unassign a rolerole:delete:member role:delete:member:admin
Unassign a rolerole:delete:member:master
Create a rolerole:write:role role:write:role:admin
Create a rolerole:write:role:master
List rolesrole:read:list_roles role:read:list_roles:admin
List rolesrole:read:list_roles:master
Update role informationrole:update:role role:update:role:admin
Update role informationrole:update:role:master
Delete a rolerole:delete:role role:delete:role:admin
Delete a rolerole:delete:role:master
Get role informationrole:read:role role:read:role:admin
Get role informationrole:read:role:master
List members in a rolerole:read:list_members role:read:list_members:admin
List members in a rolerole:read:list_members:master
Assign a rolerole:write:member role:write:member:admin
Assign a rolerole:write:member:master

Survey Management

API endpointgranular scope
List channel survey instancessurvey_management:read:list_survey_instances:admin
Get survey infosurvey_management:read:survey:admin
Get survey infosurvey_management:read:survey:master
Get survey instancessurvey_management:read:list_survey_instances:admin
Get survey instancessurvey_management:read:list_survey_instances:master
Get survey answerssurvey_management:read:list_survey_answers:admin
Get survey answerssurvey_management:read:list_survey_answers:master
Get surveyssurvey_management:read:list_surveys:admin
Get surveyssurvey_management:read:list_surveys:master

Zoom Phone

The following are the available Zoom Phone APIs and their associated granular scopes.

Accounts

API endpointgranular scope
Delete phone numbers for an account's customized outbound caller IDphone:delete:customized_number:admin
Delete phone numbers for an account's customized outbound caller IDphone:delete:customized_number:master
Add phone numbers for an account's customized outbound caller IDphone:write:customized_number:admin
Add phone numbers for an account's customized outbound caller IDphone:write:customized_number:master
List an account's customized outbound caller ID phone numbersphone:read:list_customized_number:admin
List an account's customized outbound caller ID phone numbersphone:read:list_customized_number:master
List an account's Zoom Phone settingsphone:read:list_account_settings:admin
List an account's Zoom Phone settingsphone:read:list_account_settings:master

Alerts

API endpointgranular scope
Delete an alert settingphone:delete:alert_setting:admin
Delete an alert settingphone:delete:alert_setting:master
Get alert setting detailsphone:read:alert_setting:admin
Get alert setting detailsphone:read:alert_setting:master
List alert settings with paging queryphone:read:list_alert_settings:admin
List alert settings with paging queryphone:read:list_alert_settings:master
Add an alert settingphone:write:alert_setting:admin
Add an alert settingphone:write:alert_setting:master
Update an alert settingphone:patch:alert_setting:admin
Update an alert settingphone:patch:alert_setting:master

Audio Library

API endpointgranular scope
Delete an audio itemphone:delete:audio phone:delete:audio:admin
Delete an audio itemphone:delete:audio:master
Add audio itemsphone:write:batch_audios phone:write:batch_audios:admin
Add audio itemsphone:write:batch_audios:master
Update an audio itemphone:update:audio phone:update:audio:admin
Update an audio itemphone:update:audio:master
Add an audio item for text-to-speech conversionphone:write:audio phone:write:audio:admin
Add an audio item for text-to-speech conversionphone:write:audio:master
Get an audio itemphone:read:audio phone:read:audio:admin
Get an audio itemphone:read:audio:master
List audio itemsphone:read:list_audios phone:read:list_audios:admin
List audio itemsphone:read:list_audios:master

Auto Receptionists

API endpointgranular scope
Delete a non-primary auto receptionistphone:delete:auto_receptionist:admin
Delete a non-primary auto receptionistphone:delete:auto_receptionist:master
Unassign all phone numbersphone:delete:auto_receptionist_number:admin
Unassign all phone numbersphone:delete:auto_receptionist_number:master
Get an auto receptionistphone:read:auto_receptionist:admin
Get an auto receptionistphone:read:auto_receptionist:master
Unassign a phone numberphone:delete:auto_receptionist_number:admin
Unassign a phone numberphone:delete:auto_receptionist_number:master
Update an auto receptionist policyphone:update:auto_receptionist_policy:admin
Update an auto receptionist policyphone:update:auto_receptionist_policy:master
Update an auto receptionistphone:update:auto_receptionist:admin
Update an auto receptionistphone:update:auto_receptionist:master
Add a policy subsettingphone:write:auto_receptionist_policy:admin
Add a policy subsettingphone:write:auto_receptionist_policy:master
List auto receptionistsphone:read:list_auto_receptionists:admin
List auto receptionistsphone:read:list_auto_receptionists:master
Add an auto receptionistphone:write:auto_receptionist:admin
Add an auto receptionistphone:write:auto_receptionist:master
Delete a policy subsettingphone:delete:auto_receptionist_policy:admin
Delete a policy subsettingphone:delete:auto_receptionist_policy:master
Assign phone numbersphone:write:auto_receptionist_number:admin
Assign phone numbersphone:write:auto_receptionist_number:master
Get an auto receptionist policyphone:read:auto_receptionist_policy:admin
Get an auto receptionist policyphone:read:auto_receptionist_policy:master
Update a policy subsettingphone:update:auto_receptionist_policy:admin
Update a policy subsettingphone:update:auto_receptionist_policy:master

Billing Account

API endpointgranular scope
Get billing account detailsphone:read:billing_account:admin
Get billing account detailsphone:read:billing_account:master
List billing accountsphone:read:list_billing_accounts:admin
List billing accountsphone:read:list_billing_accounts:master

Blocked List

API endpointgranular scope
Update a blocked listphone:update:blocked_list:admin
Update a blocked listphone:update:blocked_list:master
List blocked listsphone:read:list_blocked_lists:admin
List blocked listsphone:read:list_blocked_lists:master
Create a blocked listphone:write:blocked_list:admin
Create a blocked listphone:write:blocked_list:master
Get blocked list detailsphone:read:blocked_list:admin
Get blocked list detailsphone:read:blocked_list:master
Delete a blocked listphone:delete:blocked_list:admin
Delete a blocked listphone:delete:blocked_list:master

Call Handling

API endpointgranular scope
Update a call handling settingphone:update:call_handling_setting:admin
Update a call handling settingphone:update:call_handling_setting:master
Add a call handling settingphone:write:call_handling_setting:admin
Add a call handling settingphone:write:call_handling_setting:master
Delete a call handling settingphone:delete:call_handling_setting:admin
Delete a call handling settingphone:delete:call_handling_setting:master
Get call handling settingsphone:read:list_call_handling_settings:admin
Get call handling settingsphone:read:list_call_handling_settings:master

Call Logs

API endpointgranular scope
Get call log detailsphone:read:call_log:admin
Get call log detailsphone:read:call_log:master
Get account's call historyphone:read:list_call_logs:admin
Get account's call historyphone:read:list_call_logs:master
Get call historyphone:read:call_log:admin
Get call historyphone:read:call_log:master
Get call history detailphone:read:call_log:admin
Get call history detailphone:read:call_log:master
Delete a user's call logphone:delete:call_log phone:delete:call_log:admin
Delete a user's call logphone:delete:call_log:master
Get User AI Call Summary Detailphone:read:ai_call_summary phone:read:ai_call_summary:admin
Get User AI Call Summary Detailphone:read:ai_call_summary:master
Get user's call historyphone:read:list_call_logs:admin phone:read:list_call_logs
Get user's call historyphone:read:list_call_logs:master
Delete a user's call historyphone:delete:call_log phone:delete:call_log:admin
Delete a user's call historyphone:delete:call_log:master
Get account's call logsphone:read:list_call_logs:admin
Get account's call logsphone:read:list_call_logs:master
Sync user's call historyphone:read:list_call_logs phone:read:list_call_logs:admin
Sync user's call historyphone:read:list_call_logs:master
Add a client code to a call historyphone:update:call_log:admin
Add a client code to a call historyphone:update:call_log:master
Sync user's call logsphone:read:list_call_logs phone:read:list_call_logs:admin
Sync user's call logsphone:read:list_call_logs:master
Get user's call logsphone:read:list_call_logs phone:read:list_call_logs:admin
Get user's call logsphone:read:list_call_logs:master
Get call elementphone:read:call_log:admin
Get call elementphone:read:call_log:master
Add a client code to a call logphone:update:call_log:admin
Add a client code to a call logphone:update:call_log:master

Call Queues

API endpointgranular scope
Update a call queue's policy subsettingphone:update:call_queue_policy:admin
Update a call queue's policy subsettingphone:update:call_queue_policy:master
Get call queue recordingsphone:read:list_call_queue_recordings:admin
Get call queue recordingsphone:read:list_call_queue_recordings:master
Assign numbers to a call queuephone:write:call_queue_number:admin
Assign numbers to a call queuephone:write:call_queue_number:master
List call queue membersphone:read:list_call_queue_members:admin
List call queue membersphone:read:list_call_queue_members:master
Unassign a memberphone:delete:call_queue_member:admin
Unassign a memberphone:delete:call_queue_member:master
List call queuesphone:read:list_call_queues:admin
List call queuesphone:read:list_call_queues:master
List call queue analyticsphone:read:list_call_queues:admin
List call queue analyticsphone:read:list_call_queues:master
Create a call queuephone:write:call_queue:admin
Create a call queuephone:write:call_queue:master
Unassign all membersphone:delete:call_queue_member:admin
Unassign all membersphone:delete:call_queue_member:master
Add a policy subsetting to a call queuephone:write:call_queue_policy:admin
Add a policy subsetting to a call queuephone:write:call_queue_policy:master
Add members to a call queuephone:write:call_queue_member:admin
Add members to a call queuephone:write:call_queue_member:master
Delete a call queuephone:delete:call_queue:admin
Delete a call queuephone:delete:call_queue:master
Unassign a phone numberphone:delete:call_queue_number:admin
Unassign a phone numberphone:delete:call_queue_number:master
Get call queue detailsphone:read:call_queue:admin
Get call queue detailsphone:read:call_queue:master
Update call queue detailsphone:update:call_queue:admin
Unassign all phone numbersphone:delete:call_queue_number:admin
Unassign all phone numbersphone:delete:call_queue_number:master
Delete a CQ policy settingphone:delete:call_queue_policy:admin
Delete a CQ policy settingphone:delete:call_queue_policy:master

Carrier Reseller

API endpointgranular scope
List phone numbersphone:read:list_carrier_numbers:admin
List phone numbersphone:read:list_carrier_numbers:master
Delete a phone numberphone:delete:carrier_number:admin
Delete a phone numberphone:delete:carrier_number:master
Create phone numbersphone:write:carrier_number:admin
Create phone numbersphone:write:carrier_number:master phone:write:carrier_number:master
Activate phone numbersphone:update:carrier_number:admin
Activate phone numbersphone:update:carrier_number:master

Common Areas

API endpointgranular scope
Assign phone numbers to a common areaphone:write:common_area_number:admin
Assign phone numbers to a common areaphone:write:common_area_number:master
Add a common areaphone:write:common_area:admin
Add a common areaphone:write:common_area:master
Assign calling plans to a common areaphone:write:common_area_calling_plan:admin
Assign calling plans to a common areaphone:write:common_area_calling_plan:master
List common areasphone:read:common_area:admin
List common areasphone:read:common_area:master
Delete common area settingphone:delete:common_area_setting:admin
Delete common area settingphone:delete:common_area_setting:master
Apply template to common areasphone:write:apply_template_to_common_areas:admin
Apply template to common areasphone:write:apply_template_to_common_areas:master
Delete a common areaphone:delete:common_area:admin
Delete a common areaphone:delete:common_area:master
Get common area detailsphone:read:common_area:admin
Get common area detailsphone:read:common_area:master
Get common area settingsphone:read:list_common_area_settings:admin
Get common area settingsphone:read:list_common_area_settings:master
Unassign a calling plan from the common areaphone:delete:common_area_calling_plan:admin
Unassign a calling plan from the common areaphone:delete:common_area_calling_plan:master
Add common area settingphone:write:common_area_setting:admin
Add common area settingphone:write:common_area_setting:master
List activation codesphone:read:list_common_area_activation_codes:admin
List activation codesphone:read:list_common_area_activation_codes:master
Generate activation codes for common areasphone:write:common_area:admin
Generate activation codes for common areasphone:write:common_area:master
Unassign phone numbers from common areaphone:delete:common_area_number:admin
Unassign phone numbers from common areaphone:delete:common_area_number:master
Update common areaphone:update:common_area:admin
Update common areaphone:update:common_area:master
Update common area pin codephone:update:common_area:admin
Update common area pin codephone:update:common_area:master
Update common area settingphone:update:common_area_setting:admin
Update common area settingphone:update:common_area_setting:master

Dashboard

API endpointgranular scope
List detectable personal location usersphone:read:detectable_personal_location:admin
List detectable personal location usersphone:read:detectable_personal_location:master
List real time location for usersphone:read:realtime_location_users:admin
List real time location for usersphone:read:realtime_location_users:master
List real time location for IP phonesphone:read:realtime_location_devices:admin
List real time location for IP phonesphone:read:realtime_location_devices:master
List default emergency address usersphone:read:default_emergency_address:admin
List default emergency address usersphone:read:default_emergency_address:master
List users permission for location sharingphone:read:location_sharing_permission:admin
List users permission for location sharingphone:read:location_sharing_permission:master
List nomadic emergency services usersphone:read:nomadic_emergency_services:admin
List nomadic emergency services usersphone:read:nomadic_emergency_services:master
Get call QoSphone:read:call_qos:admin
Get call QoSphone:read:call_qos:master
Get call details from call logphone:read:call_log:admin
Get call details from call logphone:read:call_log:master
List past call metricsphone:read:list_call_logs:admin
List past call metricsphone:read:list_call_logs:master
List call logsphone:read:list_call_logs:admin
List call logsphone:read:list_call_logs:master
List tracked locationsphone:read:list_tracked_locations:admin
List tracked locationsphone:read:list_tracked_locations:master

Device Line Keys

API endpointgranular scope
Get device line keys informationphone:read:device_line_keys phone:read:device_line_keys:admin
Get device line keys informationphone:read:device_line_keys:master
Batch update device line key positionphone:update:device_line_keys phone:update:device_line_keys:admin
Batch update device line key positionphone:update:device_line_keys:master

Dial by Name Directory

API endpointgranular scope
Delete users from a directoryphone:delete:directory:admin
Delete users from a directoryphone:delete:directory:master
Delete users from a directory of a sitephone:delete:directory:admin
Delete users from a directory of a sitephone:delete:directory:master
List users in directoryphone:read:directory:admin
List users in directoryphone:read:directory:master
List users in a directory by sitephone:read:directory:admin
List users in a directory by sitephone:read:directory:master
Add users to a directoryphone:write:directory:admin
Add users to a directoryphone:write:directory:master
Add users to a directory of a sitephone:write:directory:admin
Add users to a directory of a sitephone:write:directory:master

Emergency Addresses

API endpointgranular scope
Update an emergency addressphone:update:emergency_address:admin
Update an emergency addressphone:update:emergency_address:master
Delete an emergency addressphone:delete:emergency_address:admin
Delete an emergency addressphone:delete:emergency_address:master
List emergency addressesphone:read:list_emergency_addresses:admin
List emergency addressesphone:read:list_emergency_addresses:master
Add an emergency addressphone:write:emergency_address:admin
Add an emergency addressphone:write:emergency_address:master
Get emergency address detailsphone:read:emergency_address:admin
Get emergency address detailsphone:read:emergency_address:master

Emergency Service Locations

API endpointgranular scope
List emergency service locationsphone:read:list_emergency_locations:admin
List emergency service locationsphone:read:list_emergency_locations:master
Delete an emergency locationphone:delete:emergency_location:admin
Delete an emergency locationphone:delete:emergency_location:master
Batch add emergency service locationsphone:write:batch_emergency_locations:admin
Batch add emergency service locationsphone:write:batch_emergency_locations:master
Update emergency service locationphone:update:emergency_location:admin
Update emergency service locationphone:update:emergency_location:master
Add an emergency service locationphone:write:emergency_location:admin
Add an emergency service locationphone:write:emergency_location:master
Get emergency service location detailsphone:read:emergency_location:admin
Get emergency service location detailsphone:read:emergency_location:master

External Contacts

API endpointgranular scope
List external contactsphone:read:list_external_contacts:admin
List external contactsphone:read:list_external_contacts:master
Add an external contactphone:write:external_contact:admin
Add an external contactphone:write:external_contact:master
Update external contactphone:update:external_contact:admin
Update external contactphone:update:external_contact:master
Delete an external contactphone:delete:external_contact:admin
Delete an external contactphone:delete:external_contact:master
Get external contact detailsphone:read:external_contact:admin
Get external contact detailsphone:read:external_contact:master

Fax

API endpointgranular scope
Update fax log read statusphone:read:fax_log:admin phone:read:fax_log
Update fax log read statusphone:read:fax_log:master
Get account's fax logsphone:read:list_fax_log:admin
Get account's fax logsphone:read:list_fax_log:master
Get extension's fax logsphone:read:list_fax_log phone:read:list_fax_log:admin
Get extension's fax logsphone:read:list_fax_log:master
Download fax filephone:read:fax_log phone:read:fax_log:admin
Download fax filephone:read:fax_log:master
Delete fax logphone:delete:fax_log phone:delete:fax_log:admin
Upload fax filephone:write:send_fax phone:write:send_fax:admin
Upload fax filephone:write:send_fax:master
Send faxphone:write:send_fax phone:write:send_fax:admin
Send faxphone:write:send_fax:master
Get fax log detailsphone:read:list_fax_log:admin
Get fax log detailsphone:read:list_fax_log:master

Firmware Update Rules

API endpointgranular scope
Get firmware update rule informationphone:read:firmware_update_rule:admin
Get firmware update rule informationphone:read:firmware_update_rule:master
Delete firmware update rulephone:delete:firmware_update_rule:admin
Delete firmware update rulephone:delete:firmware_update_rule:master
List firmware update rulesphone:read:list_firmware_update_rules:admin
List firmware update rulesphone:read:list_firmware_update_rules:master
Update firmware update rulephone:update:firmware_update_rule:admin
Update firmware update rulephone:update:firmware_update_rule:master
Add a firmware update rulephone:write:firmware_update_rule:admin
Add a firmware update rulephone:write:firmware_update_rule:master
List updatable firmwaresphone:read:list_firmwares:admin
List updatable firmwaresphone:read:list_firmwares:master

Group Call Pickup

API endpointgranular scope
Update the group call pickup informationphone:update:call_pickup_group:admin
Update the group call pickup informationphone:update:call_pickup_group:master
List call pickup group membersphone:read:call_pickup_group_member:admin
List call pickup group membersphone:read:call_pickup_group_member:master
List group call pickup objectsphone:read:list_call_pickup_groups:admin
List group call pickup objectsphone:read:list_call_pickup_groups:master
Delete group call pickup objectsphone:delete:call_pickup_group:admin
Delete group call pickup objectsphone:delete:call_pickup_group:master
Add a group call pickup objectphone:write:call_pickup_group:admin
Add a group call pickup objectphone:write:call_pickup_group:master
Get call pickup group by IDphone:read:call_pickup_group:admin
Get call pickup group by IDphone:read:call_pickup_group:master
Add members to a call pickup groupphone:write:call_pickup_group_member:admin
Add members to a call pickup groupphone:write:call_pickup_group_member:master
Remove members from call pickup groupphone:delete:call_pickup_group_member:admin
Remove members from call pickup groupphone:delete:call_pickup_group_member:master

Groups

API endpointgranular scope
Get group policy detailsphone:read:group_policy:admin
Get group policy detailsphone:read:group_policy:master
Get group phone settingsphone:read:group_setting:admin
Get group phone settingsphone:read:group_setting:master
Update group policyphone:update:group_policy:admin
Update group policyphone:update:group_policy:master

IVR

API endpointgranular scope
Get auto receptionist IVRphone:read:auto_receptionist_ivr:admin
Get auto receptionist IVRphone:read:auto_receptionist_ivr:master
Update auto receptionist IVRphone:update:auto_receptionist_ivr:admin
Update auto receptionist IVRphone:update:auto_receptionist_ivr:master

Inbound Blocked List

API endpointgranular scope
Delete an extension's inbound block rulephone:delete:extension_inbound_block_rule:admin phone:delete:extension_inbound_block_rule
Delete an extension's inbound block rulephone:delete:extension_inbound_block_rule:master
Add an account's inbound block rulephone:write:inbound_block_rule:admin
Add an account's inbound block rulephone:write:inbound_block_rule:master
Delete an account's inbound block rulephone:delete:inbound_block_rule:admin
Delete an account's inbound block rulephone:delete:inbound_block_rule:master
Mark a phone number as blocked for all extensionsphone:update:inbound_blocked_for_all:admin
Mark a phone number as blocked for all extensionsphone:update:inbound_blocked_for_all:master
List an account's inbound block rulesphone:read:list_inbound_block_rules:admin
List an account's inbound block rulesphone:read:list_inbound_block_rules:master
List an extension's inbound block rulesphone:read:list_extension_inbound_block_rules:admin phone:read:list_extension_inbound_block_rules
List an extension's inbound block rulesphone:read:list_extension_inbound_block_rules:master
Delete an account's inbound blocked statisticsphone:delete:extension_inbound_block_rule_stat:admin
Delete an account's inbound blocked statisticsphone:delete:extension_inbound_block_rule_stat:master
Update an account's inbound block rulephone:update:inbound_block_rule:admin
Update an account's inbound block rulephone:update:inbound_block_rule:master
Add an extension's inbound block rulephone:write:extension_inbound_block_rule:admin phone:write:extension_inbound_block_rule
Add an extension's inbound block rulephone:write:extension_inbound_block_rule:master
List an account's inbound blocked statisticsphone:read:list_extension_inbound_block_rules_stat:admin
List an account's inbound blocked statisticsphone:read:list_extension_inbound_block_rules_stat:master

Line Keys

API endpointgranular scope
Get line key position and settings informationphone:read:line_keys phone:read:line_keys:admin
Get line key position and settings informationphone:read:line_keys:master
Delete a line key setting.phone:delete:line_keys phone:delete:line_keys:admin
Delete a line key setting.phone:delete:line_keys:master
Batch update line key position and settings informationphone:update:line_keys phone:update:line_keys:admin
Batch update line key position and settings informationphone:update:line_keys:master

Monitoring Groups

API endpointgranular scope
Remove all monitors or monitored members from a monitoring groupphone:delete:monitoring_group_member:admin
Remove all monitors or monitored members from a monitoring groupphone:delete:monitoring_group_member:master
Get members of a monitoring groupphone:read:list_monitoring_group_members:admin
Get members of a monitoring groupphone:read:list_monitoring_group_members:master
Add members to a monitoring groupphone:write:monitoring_group_member:admin
Add members to a monitoring groupphone:write:monitoring_group_member:master
Delete a monitoring groupphone:delete:monitoring_group:admin
Delete a monitoring groupphone:delete:monitoring_group:master
Get monitoring group by IDphone:read:monitoring_group:admin
Get monitoring group by IDphone:read:monitoring_group:master
Create a monitoring groupphone:write:monitoring_group:admin
Create a monitoring groupphone:write:monitoring_group:master
Get a list of monitoring groups on an accountphone:read:list_monitoring_groups:admin
Get a list of monitoring groups on an accountphone:read:list_monitoring_groups:master
Remove a member from a monitoring groupphone:delete:monitoring_group_member:admin
Remove a member from a monitoring groupphone:delete:monitoring_group_member:master
Update a monitoring groupphone:update:monitoring_group:admin
Update a monitoring groupphone:update:monitoring_group:master

Outbound Calling

API endpointgranular scope
Add common area level outbound calling exception rulephone:write:common_area_outbound_calling_rule:admin
Add common area level outbound calling exception rulephone:write:common_area_outbound_calling_rule:master
Get site level outbound calling countries and regionsphone:read:site_outbound_calling_rule:admin
Get site level outbound calling countries and regionsphone:read:site_outbound_calling_rule:master
Get account level outbound calling countries and regionsphone:read:list_outbound_calling_rules:admin
Get account level outbound calling countries and regionsphone:read:list_outbound_calling_rules:master
Update user level outbound calling countries or regionsphone:update:user_outbound_calling_rule:admin
Update user level outbound calling countries or regionsphone:update:user_outbound_calling_rule:master
Add user level outbound calling exception rulephone:write:user_outbound_calling_rule:admin
Add user level outbound calling exception rulephone:write:user_outbound_calling_rule:master
Delete site level outbound calling exception rulephone:delete:site_outbound_calling_rule:admin
Delete site level outbound calling exception rulephone:delete:site_outbound_calling_rule:master
Update site level outbound calling countries or regionsphone:update:site_outbound_calling_rule:admin
Update site level outbound calling countries or regionsphone:update:site_outbound_calling_rule:master
Delete account level outbound calling exception rulephone:delete:outbound_calling_rule:admin
Delete account level outbound calling exception rulephone:delete:outbound_calling_rule:master
List site level outbound calling exception rulesphone:read:site_outbound_calling_rule:admin
List site level outbound calling exception rulesphone:read:site_outbound_calling_rule:master
Add site level outbound calling exception rulephone:write:site_outbound_calling_rule:admin
Add site level outbound calling exception rulephone:write:site_outbound_calling_rule:master
Update user level outbound calling exception rulephone:update:user_outbound_calling_rule:admin
Update user level outbound calling exception rulephone:update:user_outbound_calling_rule:master
Update common area level outbound calling countries or regionsphone:update:common_area_outbound_calling_rule:admin
Update common area level outbound calling countries or regionsphone:update:common_area_outbound_calling_rule:master
Update account level outbound calling exception rulephone:update:outbound_calling_rule:admin
Update account level outbound calling exception rulephone:update:outbound_calling_rule:master
Add account level outbound calling exception rulephone:write:outbound_calling_rule:admin
Add account level outbound calling exception rulephone:write:outbound_calling_rule:master
Update account level outbound calling countries or regionsphone:update:outbound_calling_rule:admin
Update account level outbound calling countries or regionsphone:update:outbound_calling_rule:master
Get user level outbound calling countries and regionsphone:read:user_outbound_calling_rule:admin
Get user level outbound calling countries and regionsphone:read:user_outbound_calling_rule:master
List account level outbound calling exception rulesphone:read:list_outbound_calling_rules:admin
List account level outbound calling exception rulesphone:read:list_outbound_calling_rules:master
Delete common area level outbound calling exception rulephone:delete:common_area_outbound_calling_rule:admin
Delete common area level outbound calling exception rulephone:delete:common_area_outbound_calling_rule:master
List common area level outbound calling exception rulesphone:read:common_area_outbound_calling_rule:admin
List common area level outbound calling exception rulesphone:read:common_area_outbound_calling_rule:master
Delete user level outbound calling exception rulephone:delete:user_outbound_calling_rule:admin
Delete user level outbound calling exception rulephone:delete:user_outbound_calling_rule:master
Update common area level outbound calling exception rulephone:update:common_area_outbound_calling_rule:admin
Update common area level outbound calling exception rulephone:update:common_area_outbound_calling_rule:master
Get common area level outbound calling countries and regionsphone:read:common_area_outbound_calling_rule:admin
Get common area level outbound calling countries and regionsphone:read:common_area_outbound_calling_rule:master
Update site level outbound calling exception rulephone:update:site_outbound_calling_rule:admin
Update site level outbound calling exception rulephone:update:site_outbound_calling_rule:master
List user level outbound calling exception rulesphone:read:user_outbound_calling_rule:admin
List user level outbound calling exception rulesphone:read:user_outbound_calling_rule:master

Phone Devices

API endpointgranular scope
List Smartphonesphone:read:list_devices:admin
List Smartphonesphone:read:list_devices:master
Assign an entity to a devicephone:write:device_extension:admin
Assign an entity to a devicephone:write:device_extension:master
Reboot a desk phonephone:write:reboot_device:admin
Reboot a desk phonephone:write:reboot_device:master
Delete a devicephone:delete:device:admin
Delete a devicephone:delete:device:master
Update provision template of a devicephone:update:device_provision_template:admin
Update provision template of a devicephone:update:device_provision_template:master
Sync deskphonesphone:write:sync_device:admin
Sync deskphonesphone:write:sync_device:master
Add a devicephone:write:device:admin
Add a devicephone:write:device:master
Get device detailsphone:read:device:admin
Get device detailsphone:read:device:master
Update a devicephone:update:device:admin
Update a devicephone:update:device:master
Unassign an entity from the devicephone:delete:device_extension:admin
Unassign an entity from the devicephone:delete:device_extension:master
List devicesphone:read:list_devices:admin
List devicesphone:read:list_devices:master

Phone Numbers

API endpointgranular scope
Update a phone numberphone:update:number:admin
Update a phone numberphone:update:number:master
Update a site's unassigned phone numbersphone:update:site_number:admin
Update a site's unassigned phone numbersphone:update:site_number:master
Assign a phone number to a userphone:write:user_number phone:write:user_number:admin
Assign a phone number to a userphone:write:user_number:master
Add BYOC phone numbersphone:write:byo_carrier_number:admin
Add BYOC phone numbersphone:write:byo_carrier_number:master
Delete unassigned phone numbersphone:delete:number:admin
Delete unassigned phone numbersphone:delete:number:master
Unassign a phone numberphone:delete:user_number phone:delete:user_number:admin
Unassign a phone numberphone:delete:user_number:master
Get a phone numberphone:read:numbers:admin
Get a phone numberphone:read:numbers:master
List phone numbersphone:read:list_numbers:admin
List phone numbersphone:read:list_numbers:master

Phone Plans

API endpointgranular scope
List plan informationphone:read:list_calling_plans:admin
List plan informationphone:read:list_calling_plans:master
List calling plansphone:read:list_calling_plans:admin
List calling plansphone:read:list_calling_plans:master

Phone Roles

API endpointgranular scope
Update a phone rolephone:update:role:admin
Update a phone rolephone:update:role:master
List phone rolesphone:read:list_roles:admin
List phone rolesphone:read:list_roles:master
Add members to rolesphone:write:role_member:admin
Add members to rolesphone:write:role_member:master
Add phone role targetsphone:write:role:admin
Add phone role targetsphone:write:role:master
Delete phone role targetsphone:delete:role:admin
Delete phone role targetsphone:delete:role:master
List phone role targetsphone:read:list_roles:admin
List phone role targetsphone:read:list_roles:master
Delete a phone rolephone:delete:role:admin
Delete a phone rolephone:delete:role:master
Duplicate a phone rolephone:write:role:admin
Duplicate a phone rolephone:write:role:master
Delete members in a rolephone:delete:role_member:admin
Delete members in a rolephone:delete:role_member:master
List members in a rolephone:read:role_member:admin
List members in a rolephone:read:role_member:master
Get role informationphone:read:role:admin
Get role informationphone:read:role:master

Private Directory

API endpointgranular scope
Remove a member from a private directoryphone:delete:private_directory_member:admin
Remove a member from a private directoryphone:delete:private_directory_member:master
Add members to a private directoryphone:write:private_directory_member:admin
Add members to a private directoryphone:write:private_directory_member:master
Update a private directory memberphone:update:private_directory_member:admin
Update a private directory memberphone:update:private_directory_member:master
List private directory membersphone:read:list_private_directory_members:admin
List private directory membersphone:read:list_private_directory_members:master

Provider Exchange

API endpointgranular scope
List carrier peering phone numbers.phone:read:list_peering_numbers:admin
List carrier peering phone numbers.phone:read:list_peering_numbers:master
Update peering phone numbersphone:update:peering_number:admin
Update peering phone numbersphone:update:peering_number:master
Add peering phone numbersphone:write:peering_number:admin
Add peering phone numbersphone:write:peering_number:master
List peering phone numbersphone:read:list_peering_numbers:admin
List peering phone numbersphone:read:list_peering_numbers:master
Remove peering phone numbersphone:delete:peering_number:admin
Remove peering phone numbersphone:delete:peering_number:master

Provision Templates

API endpointgranular scope
List provision templatesphone:read:list_provision_templates:admin
List provision templatesphone:read:list_provision_templates:master
Delete a provision templatephone:delete:provision_template:admin
Delete a provision templatephone:delete:provision_template:master
Update a provision templatephone:update:provision_template:admin
Update a provision templatephone:update:provision_template:master
Get a provision templatephone:read:provision_template:admin
Get a provision templatephone:read:provision_template:master
Add a provision templatephone:write:provision_template:admin
Add a provision templatephone:write:provision_template:master

Recordings

API endpointgranular scope
Update Auto Delete Fieldphone:update:call_recording phone:update:call_recording:admin
Update Auto Delete Fieldphone:update:call_recording:master
Update Recording Statusphone:update:call_recording phone:update:call_recording:admin
Update Recording Statusphone:update:call_recording:master
Delete a call recordingphone:delete:call_recording phone:delete:call_recording:admin
Delete a call recordingphone:delete:call_recording:master
Get recording by call IDphone:read:call_recording phone:read:call_recording:admin
Get recording by call IDphone:read:call_recording:master
Get user's recordingsphone:read:list_recordings phone:read:list_recordings:admin
Get user's recordingsphone:read:list_recordings:master
Download a phone recording transcriptphone:read:recording_transcript phone:read:recording_transcript:admin
Download a phone recording transcriptphone:read:recording_transcript:master
Download a phone recordingphone:read:call_recording phone:read:call_recording:admin
Download a phone recordingphone:read:call_recording:master
Get call recordingsphone:read:list_call_recordings:admin
Get call recordingsphone:read:list_call_recordings:master

Reports

API endpointgranular scope
Get fax charges usage reportphone:read:fax_charges:admin
Get fax charges usage reportphone:read:fax_charges:master
Get operation logs reportphone:read:operation_logs:admin
Get operation logs reportphone:read:operation_logs:master
Get SMS/MMS charges usage reportphone:read:sms_charges:admin
Get SMS/MMS charges usage reportphone:read:sms_charges:master
Get call charges usage reportphone:read:call_charges:admin
Get call charges usage reportphone:read:call_charges:master

Routing Rules

API endpointgranular scope
Update directory backup routing rulephone:update:routing_rule:admin
Update directory backup routing rulephone:update:routing_rule:master
List directory backup routing rulesphone:read:list_routing_rules:admin
List directory backup routing rulesphone:read:list_routing_rules:master
Add directory backup routing rulephone:write:routing_rule:admin
Add directory backup routing rulephone:write:routing_rule:master
Get directory backup routing rulephone:read:routing_rule:admin
Get directory backup routing rulephone:read:routing_rule:master
Delete directory backup routing rulephone:delete:routing_rule:admin
Delete directory backup routing rulephone:delete:routing_rule:master

SMS

API endpointgranular scope
List user's SMS sessions in descending orderphone:read:sms_session phone:read:sms_session:admin
List user's SMS sessions in descending orderphone:read:sms_session:master
Sync SMS by session IDphone:read:sms_session phone:read:sms_session:admin
Sync SMS by session IDphone:read:sms_session:master
Get SMS by message IDphone:read:sms_message phone:read:sms_message:admin
Get SMS by message IDphone:read:sms_message:master
Get user's SMS sessionsphone:read:list_sms_sessions phone:read:list_sms_sessions:admin
Get user's SMS sessionsphone:read:list_sms_sessions:master
Get SMS session detailsphone:read:sms_session phone:read:sms_session:admin
Get SMS session detailsphone:read:sms_session:master
Get account's SMS sessionsphone:read:list_sms_sessions phone:read:list_sms_sessions:admin
Get account's SMS sessionsphone:read:list_sms_sessions:master
Post SMS messagephone:read:sms_message phone:read:sms_message:admin

SMS Campaign

API endpointgranular scope
Unassign a phone numberphone:delete:sms_campaign_number:admin
Unassign a phone numberphone:delete:sms_campaign_number:master
List user's opt statuses of phone numbersphone:read:sms_campaign_number_opt_status phone:read:sms_campaign_number_opt_status:admin
List user's opt statuses of phone numbersphone:read:sms_campaign_number_opt_status:master
List opt statuses of phone numbers assigned to SMS campaignphone:read:sms_campaign_number_opt_status:admin
List opt statuses of phone numbers assigned to SMS campaignphone:read:sms_campaign_number_opt_status:master
Assign a phone number to SMS campaignphone:write:sms_campaign_number:admin
Assign a phone number to SMS campaignphone:write:sms_campaign_number:master
List SMS campaignsphone:read:list_sms_campaigns:admin
List SMS campaignsphone:read:list_sms_campaigns:master
Update opt statuses of phone numbers assigned to SMS campaignphone:update:sms_campaign_number_opt_status:admin
Update opt statuses of phone numbers assigned to SMS campaignphone:update:sms_campaign_number_opt_status:master
Get an SMS campaignphone:read:sms_campaign:admin
Get an SMS campaignphone:read:sms_campaign:master

SMS Consent

API endpointgranular scope
List opt statuses of phone numbers assigned to SMS consentphone:read:sms_consent_number_opt_status:admin
List opt statuses of phone numbers assigned to SMS consentphone:read:sms_consent_number_opt_status:master

Setting Templates

API endpointgranular scope
Add a setting templatephone:write:setting_template:admin
Add a setting templatephone:write:setting_template:master
Get setting template detailsphone:read:setting_template:admin
Get setting template detailsphone:read:setting_template:master
Update a setting templatephone:update:setting_template:admin
Update a setting templatephone:update:setting_template:master
List setting templatesphone:read:list_setting_templates:admin
List setting templatesphone:read:list_setting_templates:master

Settings

API endpointgranular scope
List ported numbersphone:read:list_ported_numbers:admin
List ported numbersphone:read:list_ported_numbers:master
Update account policyphone:update:policy:admin
Update account policyphone:update:policy:master
List SIP groupsphone:read:list_sip_groups:admin
List SIP groupsphone:read:list_sip_groups:master
Get ported numbers detailsphone:read:ported_number:admin
Get ported numbers detailsphone:read:ported_number:master
List BYOC SIP trunksphone:read:list_sip_trunks:admin
List BYOC SIP trunksphone:read:list_sip_trunks:master
Update phone account settingsphone:update:settings:admin
Update phone account settingsphone:update:settings:master
Get account policy detailsphone:read:policy:admin
Get account policy detailsphone:read:policy:master
Get phone account settingsphone:read:settings:admin
Get phone account settingsphone:read:settings:master

Shared Line Appearance

API endpointgranular scope
List shared line appearancesphone:read:list_shared_line_appearances:admin
List shared line appearancesphone:read:list_shared_line_appearances:master

Shared Line Group

API endpointgranular scope
Unassign a member from a shared line groupphone:delete:shared_line_member:admin
Unassign a member from a shared line groupphone:delete:shared_line_member:master
Assign phone numbersphone:write:shared_line_group_number:admin
Assign phone numbersphone:write:shared_line_group_number:master
Unassign members from a shared line groupphone:delete:shared_line_member:admin
Unassign members from a shared line groupphone:delete:shared_line_member:master
Unassign all phone numbersphone:delete:shared_line_group_number:admin
Unassign all phone numbersphone:delete:shared_line_group_number:master
Add a policy setting to a shared line groupphone:write:shared_line_group_policy:admin
Add a policy setting to a shared line groupphone:write:shared_line_group_policy:master
Add members to a shared line groupphone:write:shared_line_member:admin
Add members to a shared line groupphone:write:shared_line_member:master
Update a shared line group policyphone:update:shared_line_group_policy:admin
Update a shared line group policyphone:update:shared_line_group_policy:master
Update an SLG policy settingphone:update:shared_line_group_policy:admin
Update an SLG policy settingphone:update:shared_line_group_policy:master
Update a shared line groupphone:update:shared_line_group:admin
Update a shared line groupphone:update:shared_line_group:master
Unassign a phone numberphone:delete:shared_line_group_number:admin
Unassign a phone numberphone:delete:shared_line_group_number:master
Get a shared line group policyphone:read:shared_line_group_policy:admin
Get a shared line group policyphone:read:shared_line_group_policy:master
Get a shared line groupphone:read:shared_line_group:admin
Get a shared line groupphone:read:shared_line_group:master
The list of shared line groupsphone:read:list_shared_line_groups:admin
The list of shared line groupsphone:read:list_shared_line_groups:master
Delete a shared line groupphone:delete:shared_line_group:admin
Delete a shared line groupphone:delete:shared_line_group:master
Delete an SLG policy settingphone:delete:shared_line_group_policy:admin
Delete an SLG policy settingphone:delete:shared_line_group_policy:master
Create a shared line groupphone:write:shared_line_group:admin
Create a shared line groupphone:write:shared_line_group:master

Sites

API endpointgranular scope
Get a phone site settingphone:read:site_setting:admin
Get a phone site settingphone:read:site_setting:master
Add a site settingphone:write:site_setting:admin
Add a site settingphone:write:site_setting:master
Update the site settingphone:update:site_setting:admin
Update the site settingphone:update:site_setting:master
Delete a phone sitephone:delete:site:admin
Delete a phone sitephone:delete:site:master
Create a phone sitephone:write:site:admin
Create a phone sitephone:write:site:master
Add customized outbound caller ID phone numbersphone:write:site_customized_number:admin
Add customized outbound caller ID phone numbersphone:write:site_customized_number:master
Remove customized outbound caller ID phone numbersphone:delete:site_customized_number:admin
Remove customized outbound caller ID phone numbersphone:delete:site_customized_number:master
Get phone site detailsphone:read:site:admin
Get phone site detailsphone:read:site:master
Delete a site settingphone:delete:site_setting:admin
Delete a site settingphone:delete:site_setting:master
Update phone site detailsphone:update:site:admin
Update phone site detailsphone:update:site:master
List customized outbound caller ID phone numbersphone:read:list_site_customized_number:admin
List customized outbound caller ID phone numbersphone:read:list_site_customized_number:master
List phone sitesphone:read:list_sites:admin
List phone sitesphone:read:list_sites:master

Users

API endpointgranular scope
Unassign user's calling planphone:delete:users_calling_plan phone:delete:users_calling_plan:admin
Unassign user's calling planphone:delete:users_calling_plan:master
Get a user's profilephone:read:user phone:read:user:admin
Get a user's profilephone:read:user:master
List phone usersphone:read:list_users:admin
List phone usersphone:read:list_users:master
Update user's calling planphone:update:calling_plan phone:update:calling_plan:admin
Update user's calling planphone:update:calling_plan:master
Update multiple users' properties in batchphone:update:batch_users:admin
Update multiple users' properties in batchphone:update:batch_users:master
Assign calling plan to a userphone:write:calling_plan phone:write:calling_plan:admin
Assign calling plan to a userphone:write:calling_plan:master
Get user policy detailsphone:read:user_policy:admin
Get user policy detailsphone:read:user_policy:master
List users' phone numbers for a customized outbound caller IDphone:read:list_user_customized_number phone:read:list_user_customized_number:admin
List users' phone numbers for a customized outbound caller IDphone:read:list_user_customized_number:master
Get a user's profile settingsphone:read:user_setting:admin phone:read:user_setting
Get a user's profile settingsphone:read:user_setting:master
Update user policyphone:update:user_policy:admin
Update user policyphone:update:user_policy:master
Remove users' customized outbound caller ID phone numbersphone:delete:user_customized_number phone:delete:user_customized_number:admin
Remove users' customized outbound caller ID phone numbersphone:delete:user_customized_number:master
Update a user's shared access settingphone:update:shared_setting phone:update:shared_setting:admin
Update a user's shared access settingphone:update:shared_setting:master
Update a user's profile settingsphone:update:user_setting phone:update:user_setting:admin
Update a user's profile settingsphone:update:user_setting:master
Add a user's shared access settingphone:write:shared_setting phone:write:shared_setting:admin
Add a user's shared access settingphone:write:shared_setting:master
Batch add usersphone:write:batch_users:admin
Batch add usersphone:write:batch_users:master
Delete a user's shared access settingphone:delete:shared_setting phone:delete:shared_setting:admin
Delete a user's shared access settingphone:delete:shared_setting:master
Update a user's profilephone:update:user phone:update:user:admin
Update a user's profilephone:update:user:master
Add phone numbers for users' customized outbound caller IDphone:write:user_customized_number phone:write:user_customized_number:admin
Add phone numbers for users' customized outbound caller IDphone:write:user_customized_number:master

Voicemails

API endpointgranular scope
Get user's voicemailsphone:read:list_voicemails phone:read:list_voicemails:admin
Get user's voicemailsphone:read:list_voicemails:master
Update Voicemail Read Statusphone:update:voicemail phone:update:voicemail:admin
Update Voicemail Read Statusphone:update:voicemail:master
Get account voicemailsphone:read:list_voicemails:admin
Get account voicemailsphone:read:list_voicemails:master
Get user voicemail details from a call logphone:read:voicemail phone:read:voicemail:admin
Get user voicemail details from a call logphone:read:voicemail:master
Get voicemail detailsphone:read:voicemail phone:read:voicemail:admin
Get voicemail detailsphone:read:voicemail:master
Download a phone voicemailphone:read:voicemail:admin phone:read:voicemail
Download a phone voicemailphone:read:voicemail:master
Delete a voicemailphone:delete:voicemail phone:delete:voicemail:admin
Delete a voicemailphone:delete:voicemail:master

Zoom Rooms

API endpointgranular scope
Remove a phone number from a Zoom Roomphone:delete:room_phone_number:admin
Remove a phone number from a Zoom Roomphone:delete:room_phone_number:master
Assign calling plans to a Zoom Roomphone:write:room_calling_plan:admin
Assign calling plans to a Zoom Roomphone:write:room_calling_plan:master
Add a Zoom Room to a Zoom Phonephone:write:room:admin
Add a Zoom Room to a Zoom Phonephone:write:room:master
Update a Zoom Room under Zoom Phone licensephone:update:room:admin
Update a Zoom Room under Zoom Phone licensephone:update:room:master
Assign phone numbers to a Zoom Roomphone:write:room_phone_number:admin
Assign phone numbers to a Zoom Roomphone:write:room_phone_number:master
Remove a calling plan from a Zoom Roomphone:delete:room_calling_plan:admin
Remove a calling plan from a Zoom Roomphone:delete:room_calling_plan:master
List Zoom Rooms without Zoom Phone assignmentphone:read:list_rooms:admin
List Zoom Rooms without Zoom Phone assignmentphone:read:list_rooms:master
Remove a Zoom Room from a ZP accountphone:delete:room:admin
Remove a Zoom Room from a ZP accountphone:delete:room:master
Get a Zoom Room under Zoom Phone licensephone:read:room:admin
Get a Zoom Room under Zoom Phone licensephone:read:room:master
List Zoom Rooms under Zoom Phone licensephone:read:list_rooms:admin
List Zoom Rooms under Zoom Phone licensephone:read:list_rooms:master

Tasks

The following are the available Tasks APIs and their associated granular scopes.

Assignee

API endpointgranular scope
Add assignees to a tasktasks:write:assignees tasks:write:assignees:admin
Get assignees of a tasktasks:read:assignees tasks:read:assignees:admin
Remove Assignee from tasktasks:delete:assignees tasks:delete:assignees:admin

Collaborator

API endpointgranular scope
Add collaborators to a tasktasks:write:collaborators tasks:write:collaborators:admin
Remove collaborator from tasktasks:delete:collaborator:admin tasks:delete:collaborator
Get collaborators of a tasktasks:read:list_collaborators tasks:read:list_collaborators:admin

Comment

API endpointgranular scope
Delete a task's commenttasks:delete:comment:admin tasks:delete:comment
Get a task's commentstasks:read:comments tasks:read:comments:admin
Add a comment to tasktasks:write:comment:admin tasks:write:comment

Tasks

API endpointgranular scope
Update task fieldstasks:update:task tasks:update:task:admin
Delete a tasktasks:delete:task:admin tasks:delete:task
Create a new tasktasks:write:task
Get task detailstasks:read:task tasks:read:task:admin
List taskstasks:read:list_tasks:admin tasks:read:list_tasks

Team Chat

The following are the available Team Chat APIs and their associated granular scopes.

Chat Channel Mention Group

API endpointgranular scope
Add channel members to a mention groupteam_chat:update:mention_group team_chat:update:mention_group:admin
List channel mention groupsteam_chat:read:mention_group team_chat:read:mention_group:admin
Remove channel mention group membersteam_chat:update:mention_group team_chat:update:mention_group:admin
Update a channel mention group informationteam_chat:update:mention_group team_chat:update:mention_group:admin
Create a channel mention groupteam_chat:write:mention_group:admin team_chat:write:mention_group
Delete a channel mention groupteam_chat:delete:mention_group team_chat:delete:mention_group:admin
List the members of a mention groupteam_chat:read:mention_group team_chat:read:mention_group:admin

Chat Channels

API endpointgranular scope
List channel membersteam_chat:read:list_members team_chat:read:list_members:admin
Create a channelteam_chat:write:user_channel team_chat:write:user_channel:admin
List channel members (Groups)team_chat:read:list_groups:admin
Update a channelteam_chat:update:channel team_chat:update:channel:admin
Remove a member (group)team_chat:delete:group:admin
Remove a memberteam_chat:delete:member team_chat:delete:member:admin
List channel activity logsteam_chat:read:list_channel_activity_logs:admin
Leave a channelteam_chat:delete:member team_chat:delete:member:admin
Perform operations on channelsteam_chat:update:archive_channels team_chat:update:archive_channels:admin
List user's channelsteam_chat:read:list_user_channels team_chat:read:list_user_channels:admin
Invite channel members (Groups)team_chat:write:groups:admin
Join a channelteam_chat:write:member
Invite channel membersteam_chat:write:members team_chat:write:members:admin
Get a channelteam_chat:read:channel team_chat:read:channel:admin
Delete a channelteam_chat:delete:channel team_chat:delete:channel:admin
Batch remove members from a channelteam_chat:delete:batch_members team_chat:delete:batch_members:admin

Chat Channels (Account-level)

API endpointgranular scope
List channel administratorsteam_chat:read:list_administrators:admin
Get a channelteam_chat:read:user_channel team_chat:read:user_channel:admin
Invite channel membersteam_chat:write:members team_chat:write:members:admin
Batch demote channel administratorsteam_chat:delete:batch_administrators:admin
Search user's or account's channelsteam_chat:write:search_channels team_chat:write:search_channels:admin
Promote channel members to administratorsteam_chat:write:administrator:admin
Remove a memberteam_chat:delete:member:admin
Batch delete channelsteam_chat:delete:channels team_chat:delete:channels:admin
List channel membersteam_chat:read:list_members team_chat:read:list_members:admin
Delete a channelteam_chat:delete:user_channel team_chat:delete:user_channel:admin
Update retention policy of a channelteam_chat:update:retention:admin
Get retention policy of a channelteam_chat:read:retention:admin
List channel activity logsteam_chat:read:list_channel_activity_logs:admin
List account's public channelsteam_chat:read:list_channels:admin
Update a channelteam_chat:update:user_channel team_chat:update:user_channel:admin
Batch remove members from a user's channelteam_chat:delete:member:admin

Chat Emoji

API endpointgranular scope
Add a custom emojiteam_chat:write:custom_emoji team_chat:write:custom_emoji:admin
Delete a custom emojiteam_chat:delete:custom_emoji team_chat:delete:custom_emoji:admin
List custom emojisteam_chat:read:list_custom_emojis team_chat:read:list_custom_emojis:admin

Chat Files

API endpointgranular scope
Send a chat fileteam_chat:write:message_files team_chat:write:message_files:admin
Get file infoteam_chat:read:file team_chat:read:file:admin
Upload a chat fileteam_chat:write:files team_chat:write:files:admin
Delete a chat fileteam_chat:delete:file team_chat:delete:file:admin

Chat Messages

API endpointgranular scope
Get a messageteam_chat:read:user_message team_chat:read:user_message:admin
Delete a scheduled messageteam_chat:delete:scheduled_message
List pinned history messages of channelteam_chat:read:list_pinned_messages
React to a chat messageteam_chat:update:message_emoji team_chat:update:message_emoji:admin
Delete a messageteam_chat:delete:user_message team_chat:delete:user_message:admin
Perform operations on the message of channelteam_chat:update:pin_message
Update a messageteam_chat:update:user_message team_chat:update:user_message:admin
List user's chat messagesteam_chat:read:list_user_messages team_chat:read:list_user_messages:admin
Get a forwarded messageteam_chat:read:user_message team_chat:read:user_message:admin
Add or remove a bookmarkteam_chat:update:bookmark
List scheduled messagesteam_chat:read:list_scheduled_messages
Send a chat messageteam_chat:write:user_message team_chat:write:user_message:admin
List bookmarksteam_chat:read:list_bookmarks
Mark message read or unreadteam_chat:update:message_status team_chat:update:message_status:admin
Retrieve a threadteam_chat:read:thread_message team_chat:read:thread_message:admin

Chat Migration

API endpointgranular scope
Get migrated Zoom channel IDsteam_chat:read:migrated_channels:admin
Migrate channel membersteam_chat:write:migrate_channel_members:admin
Get migrated Zoom user IDsteam_chat:read:migrated_users:admin
Migrate chat messagesteam_chat:write:migrate_chat_messages:admin
Migrate a chat channelteam_chat:write:migrate_a_chat_channel:admin
Migrate chat message reactionsteam_chat:write:migrate_chat_message_reactions:admin

Chat Reminder

API endpointgranular scope
List remindersteam_chat:read:list_reminders
Create a reminder messageteam_chat:write:reminder
Delete a reminder for a messageteam_chat:delete:reminder

Chat Sessions

API endpointgranular scope
Star or unstar a channel or contact userteam_chat:update:chat_control team_chat:update:chat_control:admin
List a user's chat sessionsteam_chat:read:list_user_sessions team_chat:read:list_user_sessions:admin

Contacts

API endpointgranular scope
Get user's contact detailsteam_chat:read:contact
Search company contactscontact:read:list_contacts contact:read:list_contacts:admin
List user's contactsteam_chat:read:list_contacts

IM Groups

API endpointgranular scope
Update an IM directory groupcontact_group:update:group:admin
Update an IM directory groupcontact_group:update:group:master
Add IM directory group memberscontact_group:write:member:admin
Add IM directory group memberscontact_group:write:member:master
List IM directory groupscontact_group:read:list_groups:admin
List IM directory groupscontact_group:read:list_groups:master
Delete an IM directory groupcontact_group:delete:group:admin
Delete an IM directory groupcontact_group:delete:group:master
Retrieve an IM directory groupcontact_group:read:group:admin
Retrieve an IM directory groupcontact_group:read:group:master
Delete IM directory group membercontact_group:delete:member:admin
Delete IM directory group membercontact_group:delete:member:master
Create an IM directory groupcontact_group:write:group:admin
Create an IM directory groupcontact_group:write:group:master
List IM directory group memberscontact_group:read:list_members:admin
List IM directory group memberscontact_group:read:list_members:master

Invitations

API endpointgranular scope
Send new contact invitationteam_chat:write:contact_information:admin team_chat:write:contact_information

Legal Hold

API endpointgranular scope
Add a legal hold matterteam_chat:write:legal_hold_matter:admin
Download legal hold files for given matterteam_chat:read:legal_hold_matter_file:admin
List legal hold files by given matterteam_chat:read:list_legal_hold_matter_files:admin
Update legal hold matterteam_chat:update:legal_hold_matter:admin
List legal hold mattersteam_chat:read:list_legal_hold_matters:admin
Delete legal hold mattersteam_chat:delete:legal_hold_matter:admin

Reports

API endpointgranular scope
Get chat sessions reportsreport:read:list_chat_sessions:admin
Get chat message reportsreport:read:chat_session:admin

Shared Spaces

API endpointgranular scope
Remove members from a shared spaceteam_chat:delete:shared_space_members team_chat:delete:shared_space_members:admin
List shared spacesteam_chat:read:list_shared_spaces team_chat:read:list_shared_spaces:admin
List shared space membersteam_chat:read:list_shared_space_members team_chat:read:list_shared_space_members:admin
Delete a shared spaceteam_chat:delete:shared_space team_chat:delete:shared_space:admin
Get a shared spaceteam_chat:read:shared_space team_chat:read:shared_space:admin
Update shared space settingsteam_chat:update:shared_space team_chat:update:shared_space:admin
Promote shared space members to administratorsteam_chat:write:shared_space_administrators team_chat:write:shared_space_administrators:admin
List shared space channelsteam_chat:read:list_shared_space_channels team_chat:read:list_shared_space_channels:admin
Add members to a shared spaceteam_chat:write:shared_space_members team_chat:write:shared_space_members:admin
Demote shared space administrators to membersteam_chat:delete:shared_space_administrators team_chat:delete:shared_space_administrators:admin
Create a shared spaceteam_chat:write:shared_space team_chat:write:shared_space:admin
Move shared space channelsteam_chat:update:shared_space_channels
Transfer shared space ownershipteam_chat:update:shared_space_owner team_chat:update:shared_space_owner:admin

Workforce Management

The following are the available Workforce Management APIs and their associated granular scopes.

Filter groups

API endpointgranular scope
[List filter groups](/docs/api/rest/reference/Workforce Management/methods/#operation/Listfiltergroups)workforce_management:read:list_filter_groups:admin

Forecasts

API endpointgranular scope
[List forecasts](/docs/api/rest/reference/Workforce Management/methods/#operation/Listforecasts)workforce_management:read:forecasts:admin
[Get a forecast for a scheduling group](/docs/api/rest/reference/Workforce Management/methods/#operation/Getforecastofschedulinggroup)workforce_management:read:forecasts:admin

Imports

API endpointgranular scope
[Upload historical queue metrics](/docs/api/rest/reference/Workforce Management/methods/#operation/Uploadhistoricalqueuemetrics)workforce_management:write:queue_metrics:admin
[Get historical queue metrics import metadata](/docs/api/rest/reference/Workforce Management/methods/#operation/Viewhistoricalqueuemetricimoprtmeta)workforce_management:read:queue_metrics:admin

Organizational Groups

API endpointgranular scope
[Get multiple organizational groups](/docs/api/rest/reference/Workforce Management/methods/#operation/getMultipleOrganizationalGroups)workforce_management:read:organizational_groups:admin
[Update an organizational group](/docs/api/rest/reference/Workforce Management/methods/#operation/updateOrganizationalGroup)workforce_management:update:organizational_groups:admin
[Get a single organizational group](/docs/api/rest/reference/Workforce Management/methods/#operation/getOrganizationalGroup)workforce_management:read:organizational_groups:admin
[Delete organizational group](/docs/api/rest/reference/Workforce Management/methods/#operation/deleteOrganizationalGroup)workforce_management:delete:organizational_groups:admin
[Create an organizational group](/docs/api/rest/reference/Workforce Management/methods/#operation/createOrganizationalGroup)workforce_management:write:organizational_groups:admin

Reports

API endpointgranular scope
[List all schedule agents](/docs/api/rest/reference/Workforce Management/methods/#operation/listScheduleAgents)workforce_management:read:list_schedule_agents:admin
[List agents' adherence data](/docs/api/rest/reference/Workforce Management/methods/#operation/listAdherenceAgents)workforce_management:read:list_adherence_agents:admin

Schedules

API endpointgranular scope
[List all schedule agents](/docs/api/rest/reference/Workforce Management/methods/#operation/listSchedules)workforce_management:read:list_schedule_agents:admin

Scheduling groups

API endpointgranular scope
[List scheduling groups](/docs/api/rest/reference/Workforce Management/methods/#operation/Listschedulinggroups)workforce_management:read:list_scheduling_groups:admin

Users

API endpointgranular scope
[List users](/docs/api/rest/reference/Workforce Management/methods/#operation/Listallusers)workforce_management:read:list_users:admin

Zoom User

The following are the available Zoom User APIs and their associated granular scopes.

Divisions

API endpointgranular scope
Create a divisiondivision:write:division:admin
Get a divisiondivision:read:division:admin
List divisionsdivision:read:list_divisions:admin
List division membersdivision:read:member:admin
Delete a divisiondivision:delete:division:admin
Assign a divisiondivision:write:member:admin
Update a divisiondivision:update:division:admin

Groups

API endpointgranular scope
Delete Virtual Background filesgroup:delete:virtual_background_files:admin
Delete Virtual Background filesgroup:delete:virtual_background_files:master
Upload Virtual Background filesgroup:write:virtual_background_files:admin
Upload Virtual Background filesgroup:write:virtual_background_files:master
List group channelsgroup:read:list_channels:admin
List group channelsgroup:read:list_channels:master
Add group membersgroup:write:member:admin
Add group membersgroup:write:member:master
Delete a group admingroup:delete:administrator:admin
Delete a group admingroup:delete:administrator:master
Update a groupgroup:update:group:admin
Update a groupgroup:update:group:master
Update locked settingsgroup:update:lock_settings:admin
Update locked settingsgroup:update:lock_settings:master
Create a groupgroup:write:group:admin
Create a groupgroup:write:group:master
Get locked settingsgroup:read:lock_settings:admin
Get locked settingsgroup:read:lock_settings:master
Update a group's settingsgroup:update:settings:admin
Update a group's settingsgroup:update:settings:master
Update a group's webinar registration settingsgroup:update:registration_settings:admin
Update a group's webinar registration settingsgroup:update:registration_settings:master
Get a group's settingsgroup:read:settings:admin
Get a group's settingsgroup:read:settings:master
List group adminsgroup:read:administrator:admin
List group adminsgroup:read:administrator:master
Delete a group membergroup:delete:member:admin
Delete a group membergroup:delete:member:master
List groupsgroup:read:list_groups:admin
List groupsgroup:read:list_groups:master
Get a groupgroup:read:group:admin
Get a groupgroup:read:group:master
Add group adminsgroup:write:administrator:admin
List group members group:read:list_members:admin
List group members group:read:list_members:master
Update a group membergroup:update:member:admin
Update a group membergroup:update:member:master
Delete a groupgroup:delete:group:admin
Delete a groupgroup:delete:group:master
Get a group's webinar registration settingsgroup:read:registration_settings:admin
Get a group's webinar registration settingsgroup:read:registration_settings:master

Users

API endpointgranular scope
List a user's collaboration devicesuser:read:list_collaboration_devices user:read:list_collaboration_devices:admin
Get meeting summary templatesuser:read:settings user:read:settings:admin
Get user permissionsuser:read:list_permissions user:read:list_permissions:admin
Get user permissionsuser:read:list_permissions:master
Delete a scheduleruser:delete:scheduler user:delete:scheduler:admin
Delete a scheduleruser:delete:scheduler:master
Add assistantsuser:write:assistant user:write:assistant:admin
Add assistantsuser:write:assistant:master
Update a user's presence statususer:update:presence_status user:update:presence_status:admin
Get a useruser:read:user user:read:user:admin
Get a useruser:read:user:master
Upload a user's profile pictureuser:write:profile_picture user:write:profile_picture:admin
Upload a user's profile pictureuser:write:profile_picture:master
Update user statususer:update:status user:update:status:admin
Update user statususer:update:status:master
Get user summaryuser:read:summary:admin
Get user summaryuser:read:summary:master
Delete user schedulersuser:delete:scheduler user:delete:scheduler:admin
Delete user schedulersuser:delete:scheduler:master
Get a user presence statususer:read:presence_status user:read:presence_status:admin
List user schedulersuser:read:list_schedulers user:read:list_schedulers:admin
List user schedulersuser:read:list_schedulers:master
Delete a user assistantuser:delete:assistant user:delete:assistant:admin
Delete a user assistantuser:delete:assistant:master
Delete user assistantsuser:delete:assistant user:delete:assistant:admin
Delete user assistantsuser:delete:assistant:master
List user assistantsuser:read:list_assistants user:read:list_assistants:admin
List user assistantsuser:read:list_assistants:master
Delete a useruser:delete:user user:delete:user:admin
Delete a useruser:delete:user:master
Get the user's ZAKuser:read:zak user:read:zak:admin
Get user settingsuser:read:settings user:read:settings:admin
Get user settingsuser:read:settings:master
Update a user's emailuser:update:email user:update:email:admin
Update a user's emailuser:update:email:master
List usersuser:read:list_users:admin
List usersuser:read:list_users:master
Update user settingsuser:update:settings user:update:settings:admin
Update user settingsuser:update:settings:master
Revoke a user's SSO tokenuser:delete:token user:delete:token:admin
Revoke a user's SSO tokenuser:delete:token:master
Delete Virtual Background filesuser:delete:virtual_background_files user:delete:virtual_background_files:admin
Delete Virtual Background filesuser:delete:virtual_background_files:master
Upload Virtual Background filesuser:write:virtual_background_files user:write:virtual_background_files:admin
Upload Virtual Background filesuser:write:virtual_background_files:master
Get a user's tokenuser:read:token user:read:token:admin
Get a user's tokenuser:read:token:master
Bulk update features for usersuser:write:feature:admin
Bulk update features for usersuser:write:feature:master
Create usersuser:write:user:admin
Create usersuser:write:user:master
Get collaboration device detailuser:read:collaboration_device user:read:collaboration_device:admin
Check a user's PM roomuser:read:pm_room user:read:pm_room:admin
Update a user's passworduser:update:password user:update:password:admin
Update a user's passworduser:update:password:master
Check a user emailuser:read:email user:read:email:admin
Update a useruser:update:user user:update:user:admin
Update a useruser:update:user:master

Zoom Billing

The following are the available Zoom Billing APIs and their associated granular scopes.

Billing

API endpointgranular scope
Cancel a base planbilling:update:cancel_plan:master
Download subaccounts' billing invoice reportsbilling:read:download_invoice_reports:master
Download an invoice filebilling:read:download_invoice_file:master
Update billing informationbilling:update:billing_information:master
List upcoming renewal accountsbilling:read:list_upcoming_renewal_accounts:master
Update a base planbilling:update:plan:master
Get account plan informationbilling:read:plan_information:master billing:read:plan_information:admin
Get invoice detailsbilling:read:invoice_details:master billing:read:invoice_details:admin
Update an account's additional planbilling:update:additional_plans:master
Get billing informationbilling:read:billing_information:master billing:read:billing_information:admin
List billing invoicesbilling:read:list_invoices:master billing:read:list_invoices:admin
Get plan usagebilling:read:plan_usage:master billing:read:plan_usage:admin
Subscribe subaccount to an additional planbilling:write:subscribe_additional_plans:master
Cancel additional plansbilling:update:cancel_additional_plans:master
Download an invoice file (v2)billing:read:download_invoice_file:master
Delete subaccounts' billing invoice reportbilling:delete:invoice_report:master
Subscribe an account to a planbilling:write:subscribe_plan:master

Zoom Scheduler

The following are the available Zoom Scheduler APIs and their associated granular scopes.

Routing Forms

API endpointgranular scope
get routing responsescheduler:read:routing scheduler:read:routing:admin
list account routing responsescheduler:read:routing scheduler:read:routing:admin

analytics

API endpointgranular scope
Report analyticsscheduler:read:analytics scheduler:read:analytics:admin

availability

API endpointgranular scope
Get availability scheduler:read:availability scheduler:read:availability:admin
Patch availabilityscheduler:update:availability scheduler:update:availability:admin
Insert availabilityscheduler:write:availability scheduler:write:availability:admin
Delete availabilityscheduler:delete:availability scheduler:delete:availability:admin
List availabilityscheduler:read:list_availability scheduler:read:list_availability:admin

scheduled events

API endpointgranular scope
Patch scheduled eventsscheduler:update:scheduled_event scheduler:update:scheduled_event:admin
List scheduled eventsscheduler:read:list_scheduled_events scheduler:read:list_scheduled_events:admin
Get scheduled events scheduler:read:scheduled_event scheduler:read:scheduled_event:admin
Get scheduled event attendeescheduler:read:scheduled_event_attendee scheduler:read:scheduled_event_attendee:admin
Delete scheduled events scheduler:delete:scheduled_event scheduler:delete:scheduled_event:admin

schedules

API endpointgranular scope
List schedulesscheduler:read:list_schedule scheduler:read:list_schedule:admin
Patch schedulesscheduler:update:patch_schedule scheduler:update:patch_schedule:admin
Insert schedulesscheduler:write:insert_schedule scheduler:write:insert_schedule:admin
Get schedulesscheduler:read:get_schedule scheduler:read:get_schedule:admin
Delete schedulesscheduler:delete:delete_schedule scheduler:delete:delete_schedule:admin

scheduling links

API endpointgranular scope
Single use linkscheduler:write:single_use_link scheduler:write:single_use_link:admin

shares

API endpointgranular scope
Create sharesscheduler:write:share scheduler:write:share:admin

team

API endpointgranular scope
List teamscheduler:read:get_schedule scheduler:read:get_schedule:admin

users

API endpointgranular scope
Get userscheduler:read:user scheduler:read:user:admin

AI Companion

The following are the available AI Companion APIs and their associated granular scopes.

Archive

API endpointgranular scope
[Get AI Companion conversation archives](/docs/api/rest/reference/AI Companion/methods/#operation/GetAICconversationarchives)aic:read:conversation_archives:admin

Zoom Quality Management

The following are the available Zoom Quality Management APIs and their associated granular scopes.

Evaluations

API endpointgranular scope
[List automated evaluations](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/ListAutomatedEvaluations)zoom_quality_management:read:evaluations:admin zoom_quality_management:read:evaluations
[View evaluation detail](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/EvaluationDetail)zoom_quality_management:read:evaluations zoom_quality_management:read:evaluations:admin
[List evaluations](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/Listevaluations)zoom_quality_management:read:evaluations zoom_quality_management:read:evaluations:admin

Interactions

API endpointgranular scope
[View interaction detail](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/InteractionDetail)zoom_quality_management:read:interactions zoom_quality_management:read:interactions:admin
[Add an interaction](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/Addinteraction)zoom_quality_management:write:interactions zoom_quality_management:write:interactions:admin
[List interactions](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/ListInteractions)zoom_quality_management:read:interactions zoom_quality_management:read:interactions:admin

Zoom Revenue Accelerator

The following are the available Zoom Revenue Accelerator APIs and their associated granular scopes.

Accounts

API endpointgranular scope
Get indicators settings [Deprecated]zra:read:indicator zra:read:indicator:admin
Get indicators settingszra:read:indicator zra:read:indicator:admin

CRM

API endpointgranular scope
Unregister CRM API connectionzra:delete:crm_registration:admin
Get CRM dealszra:read:crm_deal:admin
Get CRM contactszra:read:crm_contact:admin
Bulk import CRM leadszra:write:crm_lead:admin
Get current CRM API registrationzra:read:crm_registration:admin
Register CRM API connectionzra:write:crm_registration:admin
Bulk import CRM accountszra:write:crm_accounts:admin
Bulk import CRM contactszra:write:crm_contact:admin
Poll async task resultzra:read:crm_task:admin
Get CRM leadszra:read:crm_lead:admin
Get CRM accountszra:read:crm_account:admin
Bulk import CRM dealszra:write:crm_deal:admin

Conversations

API endpointgranular scope
Upload iq multipart file.zra:write:file zra:write:file:admin
Get conversation comments [Deprecated]zra:read:list_conversation_comments zra:read:list_conversation_comments:admin
Delete conversation's comment [Deprecated]zra:delete:conversation_comment zra:delete:conversation_comment:admin
Add new comments to the conversation [Deprecated]zra:write:conversation_comment zra:write:conversation_comment:admin
Add new comments to the conversationzra:read:list_conversation_comments zra:read:list_conversation_comments:admin
Get conversation content analysis [Deprecated]zra:read:conversation_analysis zra:read:conversation_analysis:admin
Get a user's playlist [Deprecated]zra:read:list_conversation_playlists zra:read:list_conversation_playlists
Get conversation commentszra:read:list_conversation_comments zra:read:list_conversation_comments:admin
List conversations [Deprecated]zra:read:list_conversations zra:read:list_conversations:admin
Update conversation host id to new host id by conversation id [Deprecated]zra:update:conversation_host zra:update:conversation_host:admin
Delete conversation by conversation ID [Deprecated]zra:delete:conversations zra:delete:conversations:admin
Get conversation content analysiszra:read:conversation_analysis zra:read:conversation_analysis:admin
Update conversation host id to new host id by conversation idzra:update:conversation_host zra:update:conversation_host:admin
Add conversation by file id or download url.zra:write:conversation zra:write:conversation:admin
Delete conversation's commentzra:delete:conversation_comment zra:delete:conversation_comment:admin
Upload iq multipart file. [Deprecated]zra:write:file zra:write:file:admin
Get conversation information [Deprecated]zra:read:conversations:admin zra:read:conversations
Add conversation by meeting record url or meeting UUID.zra:write:conversation zra:write:conversation:admin
Upload IQ filezra:write:file zra:write:file:admin
Add conversation by file id or download url. [Deprecated]zra:write:conversation zra:write:conversation:admin
Edit conversation comment [Deprecated]zra:update:conversation_comment zra:update:conversation_comment:admin
Get conversation scorecards [Deprecated]zra:read:conversation_scorecards zra:read:conversation_scorecards:admin
Upload IQ file [Deprecated]zra:write:file zra:write:file:admin
Initiate and complete a multipart upload.zra:write:file zra:write:file:admin
[Initiate and complete a multipart upload. [Deprecated]](/docs/api/rest/reference/iq/methods/#operation/InitiateAndCompleteAMultipartUpload. [Deprecated])zra:write:file zra:write:file:admin
Get a user's playlistzra:read:list_conversation_playlists zra:read:list_conversation_playlists
List conversationszra:read:list_conversations zra:read:list_conversations:admin
Get conversation interactionszra:read:conversation_participants zra:read:conversation_participants:admin
Get conversation informationzra:read:conversations:admin zra:read:conversations
Edit conversation commentzra:update:conversation_comment zra:update:conversation_comment:admin
Delete conversation by conversation IDzra:delete:conversations zra:delete:conversations:admin
Get conversation scorecardszra:read:conversation_scorecards zra:read:conversation_scorecards:admin
Get conversation interactions [Deprecated]zra:read:conversation_participants zra:read:conversation_participants:admin
Add conversation by meeting record url or meeting UUID. [Deprecated]zra:write:conversation zra:write:conversation:admin

Deals

API endpointgranular scope
List dealszra:read:list_deals zra:read:list_deals:admin
Delete activity from the dealzra:delete:deal_activity zra:delete:deal_activity:admin
Get deal information [Deprecated]zra:read:deal zra:read:deal:admin
Get deal activitieszra:read:list_deal_activities zra:read:list_deal_activities:admin
Get deal activities [Deprecated]zra:read:list_deal_activities zra:read:list_deal_activities:admin
List deals [Deprecated]zra:read:list_deals zra:read:list_deals:admin
Delete activity from the deal [Deprecated]zra:delete:deal_activity zra:delete:deal_activity:admin
Get deal informationzra:read:deal zra:read:deal:admin

ScheduleMeetings

API endpointgranular scope
List scheduled meetingszra:read:list_conversations zra:read:list_conversations:admin

Teams

API endpointgranular scope
Delete Teamzra:delete:team:admin
Get Team Detailzra:read:team:admin
Assign Team Managerszra:write:team_manages:admin
Assign Team Memberszra:write:team_members:admin
List Unassigned Team Userszra:read:unassigned_team_users:admin
Move team to new parentzra:update:team:admin
Remove additional access from current teamzra:delete:team:admin
Update Team namezra:update:team:admin
Unassign Team Memberszra:delete:team_members:admin
List Team Managerszra:read:team_managers:admin
Create Teamzra:write:team:admin
Grant additional access to current teamzra:write:team:admin
List Account Teamszra:read:team_list:admin
Remove additional access from target teamszra:delete:team:admin
Unassign Team Managerszra:delete:team_managers:admin
List Team Memberszra:read:team_members:admin
Grant additional access to target teamszra:write:team:admin

Integration Healthcare

The following are the available Integration Healthcare APIs and their associated granular scopes.

clinicalnotes

API endpointgranular scope
[List clinical notes](/docs/api/rest/reference/Integration Healthcare/methods/#operation/GetClinicalNote)healthcare:read:list_clinical_notes:admin healthcare:read:list_clinical_notes:master
[Get a Clinical Note](/docs/api/rest/reference/Integration Healthcare/methods/#operation/GetaClinicalNote)healthcare:read:clinical_notes:admin healthcare:read:clinical_notes:master
[Update a Clinical Note](/docs/api/rest/reference/Integration Healthcare/methods/#operation/UpdateClinicalNote)healthcare:update:clinical_notes:admin healthcare:update:clinical_notes:master

Zoom Rooms

The following are the available Zoom Rooms APIs and their associated granular scopes.

Room Apps

API endpointgranular scope
Config Zoom Room Controller Appszoom_rooms:write:zoom_apps:admin

Visitor Management

API endpointgranular scope
Get a list of visitors by location visitor_management:read:list_invitations visitor_management:read:list_invitations:admin
Invitation details by invitationIDvisitor_management:read:invitation_details visitor_management:read:invitation_details:admin
Update an invitationvisitor_management:update:invitation visitor_management:update:invitation:admin
Send an invitationvisitor_management:write:invitation visitor_management:write:invitation:admin
Check in a visitorvisitor_management:write:check_in visitor_management:write:check_in:admin
Delete an Invitation visitor_management:delete:invitation visitor_management:delete:invitation:admin

Workspaces

API endpointgranular scope
Add a workspace photoworkspace:write:workspace:admin
Get a workspace's reservationsworkspace:read:list_reservations workspace:read:list_reservations:admin
Delete workspace photosworkspace:delete:photo:admin
Get a workspaceworkspace:read:list_workspaces workspace:read:list_workspaces:admin
Add or Update a Workspace floor mapworkspace:write:location workspace:write:location:admin
Update a reservationworkspace:update:reservation workspace:update:reservation:admin
Edit a workspace assetworkspace:update:asset:admin
Delete Workspace floor mapworkspace:write:location workspace:write:location:admin
List workspace reservation questionnairesworkspace:read:reservation:admin workspace:read:reservation:master
Create a reservationworkspace:write:reservation workspace:write:reservation:admin
List workspace additional information with time rangeworkspace:read:list_workspaces workspace:read:list_workspaces:admin
Check in/out of a reservationworkspace:write:events workspace:write:events:admin
Get all workspace assetsworkspace:read:asset:admin
Create a workspace assetworkspace:write:asset:admin
Get a workspace reservation by reservationIdworkspace:read:reservation workspace:read:reservation:admin
List released workspaces by timeoutzoom_rooms:read:list_release_infos:admin
Get Workspace Calendar Free/Busy Eventworkspace:read:workspace:admin
List workspacesworkspace:read:list_workspaces workspace:read:list_workspaces:admin
Create a workspaceworkspace:write:workspace:admin
Delete a workspaceworkspace:delete:workspace:admin
Update a workspaceworkspace:update:workspace:admin
Update workspace settingsworkspace:update:setting:admin workspace:update:setting:master
Get a workspace QR codeworkspace:read:qr:admin
Delete a reservationworkspace:delete:reservation workspace:delete:reservation:admin
Get a workspace location floor mapworkspace:read:location workspace:read:location:admin
Get questionnaire answer summaryworkspace:read:workspace_reservation_questionnaire_response:admin workspace:read:workspace_reservation_questionnaire_response:master
Get a location's hot desk usageworkspace:read:usage workspace:read:usage:admin
Get a user's workspace's reservationsworkspace:read:list_reservations:admin
Get a workspace assetworkspace:read:asset:admin
Set Workspace Calendar Free/Busy Eventworkspace:write:workspace:admin
Delete a workspace assetworkspace:delete:asset:admin
Set a desk assignmentworkspace:write:assignment:admin
Get a desk assignmentworkspace:read:assignment workspace:read:assignment:admin
Delete a desk assignmentworkspace:delete:assignment:admin

Zoom Rooms

API endpointgranular scope
Get device informationzoom_rooms:read:device_profile:admin
List Zoom Roomszoom_rooms:read:list_rooms:admin
List Zoom Roomszoom_rooms:read:list_rooms:master
Delete a device profilezoom_rooms:delete:device_profile:admin
Delete a device profilezoom_rooms:delete:device_profile:master
Use Zoom Room controlszoom_rooms:update:room_control:admin
Use Zoom Room controlszoom_rooms:update:room_control:master
Create a device profilezoom_rooms:write:device_profile:admin
Create a device profilezoom_rooms:write:device_profile:master
Update Zoom Room settingszoom_rooms:update:room_settings:admin
Update Zoom Room settingszoom_rooms:update:room_settings:master
List Zoom Room deviceszoom_rooms:read:list_devices:admin
List Zoom Room deviceszoom_rooms:read:list_devices:master
Update E911 digital signagezoom_rooms:update:room_controls:admin
Update E911 digital signagezoom_rooms:update:room_controls:master
Get Zoom Room profilezoom_rooms:read:room:admin
Get Zoom Room profilezoom_rooms:read:room:master
Delete a Zoom Roomzoom_rooms:delete:room:admin
Delete a Zoom Roomzoom_rooms:delete:room:master
Get Zoom Rooms virtual controller URLzoom_rooms:read:virtual_controller:admin
Get Zoom Rooms virtual controller URLzoom_rooms:read:virtual_controller:admin
Update a Zoom Room profilezoom_rooms:update:room:admin
Update a Zoom Room profilezoom_rooms:update:room:master
Change a Zoom Room's locationzoom_rooms:update:room_location:admin
Change a Zoom Room's locationzoom_rooms:update:room_location:master
List device profileszoom_rooms:read:list_device_profiles:admin
List device profileszoom_rooms:read:list_device_profiles:master
Get Zoom Room settingszoom_rooms:read:room_settings:admin
Get Zoom Room settingszoom_rooms:read:room_settings:master
Add a Zoom Roomzoom_rooms:write:room:admin
Add a Zoom Roomzoom_rooms:write:room:master
Get Zoom Room sensor datazoom_rooms:read:sensor_data:admin
Update a device profilezoom_rooms:update:device_profile:admin
Update a device profilezoom_rooms:update:device_profile:master
Get a device profilezoom_rooms:read:device_profile:admin
Get a device profilezoom_rooms:read:device_profile:master

Zoom Rooms Account

API endpointgranular scope
Get Zoom Room account profilezoom_rooms:read:account_profile:admin
Get Zoom Room account profilezoom_rooms:read:account_profile:master
Update Zoom Room account profilezoom_rooms:update:account_profile:admin
Update Zoom Room account profilezoom_rooms:update:account_profile:master
Get Zoom Room account settingszoom_rooms:read:account_settings:admin
Get Zoom Room account settingszoom_rooms:read:account_settings:master
Update Zoom Room account settingszoom_rooms:update:account_settings:admin
Update Zoom Room account settingszoom_rooms:update:account_settings:master

Zoom Rooms Calendar

API endpointgranular scope
Start calendar service sync processzoom_rooms:update:calendar_service:admin
List calendar serviceszoom_rooms:read:list_calendar_services:admin
List calendar resources by calendar servicezoom_rooms:read:list_calendar_resources:admin
Add a calendar resource to a calendar servicezoom_rooms:write:calendar_resource:admin
Delete a calendar resourcezoom_rooms:delete:calendar_resource:admin
Get a calendar resource by IDzoom_rooms:read:calendar_resource:admin
Delete a calendar servicezoom_rooms:delete:calendar_service:admin

Zoom Rooms Content

API endpointgranular scope
List Digital Signage library playlist published roomszoom_rooms:read:digital_signage_library_playlists:admin
List Digital Signage library playlist published roomszoom_rooms:read:digital_signage_library_playlists:master
Add Zoom Rooms background image library contentzoom_rooms:write:background_library_content:admin
Update Zoom Rooms Background Image Library Folderzoom_rooms:update:background_library_folder:admin
List default Zoom Rooms background image library contentszoom_rooms:read:background_library_content:admin
Add a digital signage URLzoom_rooms:write:digital_signage_library_contents:admin
Add a digital signage URLzoom_rooms:write:digital_signage_library_contents:master
Update Digital Signage library playlist published roomszoom_rooms:write:digital_signage_library_playlists:admin
Update Digital Signage library playlist published roomszoom_rooms:write:digital_signage_library_playlists:master
Add Zoom Rooms Background Image Library Folderzoom_rooms:write:background_library_folder:admin
Delete Zoom Rooms Background Image Library Folderzoom_rooms:delete:background_library_folder:admin
Add a Digital Signage library playlistzoom_rooms:write:digital_signage_library_playlists:admin
Add a Digital Signage library playlistzoom_rooms:write:digital_signage_library_playlists:master
Delete Digital Signage library playlistzoom_rooms:write:digital_signage_library_playlists:admin
Delete Digital Signage library playlistzoom_rooms:write:digital_signage_library_playlists:master
Update Digital Signage library playlist content itemszoom_rooms:write:digital_signage_library_playlists:admin
Update Digital Signage library playlist content itemszoom_rooms:write:digital_signage_library_playlists:master
Get Zoom Rooms Background Image Library Folderzoom_rooms:read:background_library_folder:admin
Update a Digital Signage content item attributeszoom_rooms:write:digital_signage_library_contents:admin
Update a Digital Signage content item attributeszoom_rooms:write:digital_signage_library_contents:master
List Zoom Rooms Background Image Library Folderszoom_rooms:read:background_library_folder:admin
List Digital Signage library playlistszoom_rooms:read:digital_signage_library_playlists:admin
List Digital Signage library playlistszoom_rooms:read:digital_signage_library_playlists:master
Update a digital signage content folderzoom_rooms:write:digital_signage_library_contents:admin
Update a digital signage content folderzoom_rooms:write:digital_signage_library_contents:master
Add a digital signage content folderzoom_rooms:write:digital_signage_library_contents:admin
Add a digital signage content folderzoom_rooms:write:digital_signage_library_contents:master
Get Digital Signage content folderzoom_rooms:read:digital_signage_library_contents:admin
Get Digital Signage content folderzoom_rooms:read:digital_signage_library_contents:master
Get Digital Signage library playlist content itemszoom_rooms:read:digital_signage_library_playlists:admin
Get Digital Signage library playlist content itemszoom_rooms:read:digital_signage_library_playlists:master
Get Digital Signage content itemzoom_rooms:read:digital_signage_library_contents:admin
Get Digital Signage content itemzoom_rooms:read:digital_signage_library_contents:master
Get Zoom Rooms background image library contentzoom_rooms:read:background_library_content:admin
List Zoom Rooms background image library contentszoom_rooms:read:background_library_content:admin
Get Digital Signage library playlistzoom_rooms:read:digital_signage_library_playlists:admin
Get Digital Signage library playlistzoom_rooms:read:digital_signage_library_playlists:master
Delete a Digital Signage content itemzoom_rooms:write:digital_signage_library_contents:admin
Delete a Digital Signage content itemzoom_rooms:write:digital_signage_library_contents:master
Add a digital signage image or video zoom_rooms:write:digital_signage_library_contents:admin
Add a digital signage image or video zoom_rooms:write:digital_signage_library_contents:master
Delete a Digital Signage content folderzoom_rooms:write:digital_signage_library_contents:admin
Delete a Digital Signage content folderzoom_rooms:write:digital_signage_library_contents:master
Update Zoom Rooms background image library contentzoom_rooms:update:background_library_content:admin
List Digital Signage content itemszoom_rooms:read:digital_signage_library_contents:admin
List Digital Signage content itemszoom_rooms:read:digital_signage_library_contents:master
Update a Digital Signage library playlistzoom_rooms:write:digital_signage_library_playlists:admin
Update a Digital Signage library playlistzoom_rooms:write:digital_signage_library_playlists:master
Update a Digital Signage image or video filezoom_rooms:write:digital_signage_library_contents:admin
Update a Digital Signage image or video filezoom_rooms:write:digital_signage_library_contents:master
Delete Zoom Rooms Background Image Library Contentzoom_rooms:delete:background_library_content:admin

Zoom Rooms Devices

API endpointgranular scope
Change Zoom Rooms app versionzoom_rooms:update:device_app_version:admin
Change Zoom Rooms app versionzoom_rooms:update:device_app_version:master
Delete a Zoom Room user devicezoom_rooms:delete:device:admin

Zoom Rooms Location

API endpointgranular scope
Add a locationzoom_rooms:write:location:admin
Add a locationzoom_rooms:write:location:master
Get Zoom Room location structurezoom_rooms:read:location_hierarchy:admin
Get Zoom Room location structurezoom_rooms:read:location_hierarchy:master
Update Zoom Rooms location structurezoom_rooms:update:location_hierarchy:admin
Update Zoom Rooms location structurezoom_rooms:update:location_hierarchy:master
Delete a locationzoom_rooms:write:location:admin
Delete a locationzoom_rooms:write:location:master
Change the assigned parent locationzoom_rooms:update:location:admin
Change the assigned parent locationzoom_rooms:update:location:master
List Zoom Room locationszoom_rooms:read:list_locations:admin
List Zoom Room locationszoom_rooms:read:list_locations:master
Update location settingszoom_rooms:update:location_settings:admin
Update location settingszoom_rooms:update:location_settings:master
Get location settingszoom_rooms:read:location_settings:admin
Get location settingszoom_rooms:read:location_settings:master
Update Zoom Room location profilezoom_rooms:update:location:admin
Update Zoom Room location profilezoom_rooms:update:location:master
Get Zoom Room location profilezoom_rooms:read:location:admin
Get Zoom Room location profilezoom_rooms:read:location:master

Zoom Rooms Tags

API endpointgranular scope
Assign Tags to Zoom Rooms By Location IDzoom_rooms:update:room_tag:admin
List all Zoom Room Tagszoom_rooms:read:list_tags:admin
Assign Tags to a Zoom Roomzoom_rooms:update:room_tag:admin
Create a new Zoom Rooms Tagzoom_rooms:write:tag:admin
Delete Tagzoom_rooms:delete:tag:admin
Un-assign Tags from a Zoom Roomzoom_rooms:delete:room_tag:admin
Edit Tagzoom_rooms:update:tag:admin

QSS

The following are the available QSS APIs and their associated granular scopes.

Dashboards

API endpointgranular scope
List meeting participants QoS Summarydashboard:read:list_meeting_participants_qos:admin
List meeting participants QoS Summarydashboard:read:list_meeting_participants_qos:master
List webinar participants QoS Summarydashboard:read:list_webinar_participants_qos:admin
List webinar participants QoS Summarydashboard:read:list_webinar_participants_qos:master

Conference Room Connector (CRC)

The following are the available Conference Room Connector (CRC) APIs and their associated granular scopes.

Account

API endpointgranular scope
Get Cisco/Polycom Room Account Settingcrc:read:rooms_account_settings:admin
Get Cisco/Polycom Room Account Settingcrc:read:rooms_account_settings:master
Update Cisco/Polycom Room Account Settingcrc:update:rooms_account_settings:admin
Update Cisco/Polycom Room Account Settingcrc:update:rooms_account_settings:master

Api Connector

API endpointgranular scope
Get an API Connector's private keycrc:read:apiconnector_private_key:admin
Get an API Connector's private keycrc:read:apiconnector_private_key:master
Get an API Connectorcrc:read:apiconnector:admin
Get an API Connectorcrc:read:apiconnector:master
List API Connectorscrc:read:list_apiconnectors:admin
List API Connectorscrc:read:list_apiconnectors:master
Delete an API Connectorcrc:delete:apiconnector:admin
Delete an API Connectorcrc:delete:apiconnector:master
Create an API Connectorcrc:write:apiconnector:admin
Create an API Connectorcrc:write:apiconnector:master
Update an API Connector's private keycrc:update:apiconnector_private_key:admin
Update an API Connector's private keycrc:update:apiconnector_private_key:master
Update an API Connectorcrc:update:apiconnector:admin
Update an API Connectorcrc:update:apiconnector:master

Cisco/Polycom Rooms

API endpointgranular scope
Get a Managed Roomcrc:read:room:admin
Get a Managed Roomcrc:read:room:master
Delete a managed roomcrc:delete:room:admin
Delete a managed roomcrc:delete:room:master
List Managed Roomscrc:read:list_rooms:admin
List Managed Roomscrc:read:list_rooms:master
Update a Managed Roomcrc:update:room:admin
Update a Managed Roomcrc:update:room:master
Create a Managed Roomcrc:write:room:admin
Create a Managed Roomcrc:write:room:master

Participant

API endpointgranular scope
Get participant identifier codecrc:read:participant_identifier_code:admin crc:read:participant_identifier_code:master

Room Template

API endpointgranular scope
Delete a room templatecrc:delete:rooms_template:admin
Delete a room templatecrc:delete:rooms_template:master
List Room Templatescrc:read:list_rooms_templates:admin
List Room Templatescrc:read:list_rooms_templates:master
Get a Room Templatecrc:read:rooms_template:admin
Get a Room Templatecrc:read:rooms_template:master
Create a Room Templatecrc:write:rooms_template:admin
Create a Room Templatecrc:write:rooms_template:master
Update a Room Templatecrc:update:rooms_template:admin
Update a Room Templatecrc:update:rooms_template:master

Contact Center

The following are the available Contact Center APIs and their associated granular scopes.

Address Books

API endpointgranular scope
Create an address book custom fieldcontact_center:write:address_book_custom_field:admin
Get an address bookcontact_center:read:address_book:admin
Create an address bookcontact_center:write:address_book:admin
Get an address book's custom fieldcontact_center:read:address_book_custom_field:admin
Update an address bookcontact_center:update:address_book:admin
Get an address book unitcontact_center:read:address_book_unit:admin
Delete an address bookcontact_center:delete:address_book:admin
Delete an address book unitcontact_center:delete:address_book_unit:admin
Delete an address book custom fieldcontact_center:delete:address_book_custom_field:admin
List address book unitscontact_center:read:list_address_book_units:admin
Update an address book contactcontact_center:update:address_book_contact:admin
List an address book's custom fieldscontact_center:read:address_book_custom_field:admin
Create an address book contactcontact_center:write:address_book_contact:admin
Update an address book unitcontact_center:update:address_book_unit:admin
Create an address book unitcontact_center:write:address_book_unit:admin
List address book contactscontact_center:read:list_address_book_contacts:admin
Get an address book contactcontact_center:read:address_book_contact:admin
List address bookscontact_center:read:list_address_books:admin
Update an address book custom fieldcontact_center:update:address_book_custom_field:admin
Delete an address book contactcontact_center:delete:address_book_contact:admin
List a contact's custom fieldscontact_center:read:address_book_custom_field:admin

Agent Statuses

API endpointgranular scope
Get a system statuscontact_center:read:system_status:admin
Create a system statuscontact_center:write:system_status:admin
Update a system statuscontact_center:update:system_status:admin
Delete a system statuscontact_center:delete:system_status:admin
List system statusescontact_center:read:list_system_statues:admin

Asset Library

API endpointgranular scope
List assetscontact_center:read:asset_library:admin
Update an asset categorycontact_center:write:asset_library:admin
Create an assetcontact_center:write:asset_library:admin
List asset categoriescontact_center:read:asset_library:admin
Update an assetcontact_center:write:asset_library:admin
Delete an asset categorycontact_center:delete:asset_library:admin
Delete an assetcontact_center:delete:asset_library:admin
Get an assetcontact_center:read:asset_library:admin
Create an asset categorycontact_center:write:asset_library:admin
Duplicate an assetcontact_center:write:asset_library:admin
Delete asset itemscontact_center:write:asset_library:admin
Get an asset categorycontact_center:read:asset_library:admin

Block List Rules

API endpointgranular scope
Delete IP addresses' block list rulescontact_center:delete:block_list_rules:admin
Create block list rules for IP addressescontact_center:write:block_list_rules:admin
Delete phone numbers' block list rulescontact_center:delete:block_list_rules:admin
Get a block list rule of phone numberscontact_center:read:block_list_rules:admin
Get a block list rule of IP addressescontact_center:read:block_list_rules:admin
Create block list rules for phone numberscontact_center:write:block_list_rules:admin
List block list rules for IP addressescontact_center:read:block_list_rules:admin
List block list rules of phone numberscontact_center:read:block_list_rules:admin

Call Control

API endpointgranular scope
List user's devices contact_center:read:user_device:admin
Control an engagement's recordingcontact_center:update:engagement_recording_control:admin
Command control of a usercontact_center:write:user_control:admin

Campaigns

API endpointgranular scope
Create a campaign contact list's contactcontact_center:write:outbound_campaign_contacts:admin
Create an outbound campaigncontact_center:write:outbound_campaign:admin
Update a batch of contacts on a campaign contact listcontact_center:update:outbound_campaign_contacts:admin
Update contact on a campaign contact listcontact_center:update:outbound_campaign_contacts:admin
List outbound campaignscontact_center:read:outbound_campaign:admin
Delete an outbound campaigncontact_center:delete:outbound_campaign:admin
Update an outbound campaign statuscontact_center:update:outbound_campaign:admin
Update a campaign contact listcontact_center:update:outbound_campaign_contactlist:admin
Get a campaign contact listcontact_center:read:outbound_campaign_contactlist:admin
Create a campaign contact listcontact_center:write:outbound_campaign_contactlist:admin
List campaign contact listscontact_center:read:outbound_campaign_contactlist:admin
Batch update campaign contact listscontact_center:update:outbound_campaign_contactlist:admin
Batch delete a campaign DNC list's phonescontact_center:delete:outbound_campaign_dnc_list_phones:admin
List campaign DNC phone numberscontact_center:read:outbound_campaign_dnc_list_phones:admin
List a campaign contact list's contactscontact_center:read:outbound_campaign_contacts:admin
Batch create a campaign DNC list's phonescontact_center:write:outbound_campaign_dnc_list_phones:admin
Get an outbound campaigncontact_center:read:outbound_campaign:admin
Remove a campaign contact listcontact_center:delete:outbound_campaign_contactlist:admin
Update an outbound campaigncontact_center:update:outbound_campaign:admin
Remove campaign contact list's contactcontact_center:delete:outbound_campaign_contacts:admin
Get a campaign contact list's contactcontact_center:read:outbound_campaign_contacts:admin

Dispositions

API endpointgranular scope
Create a disposition setcontact_center:write:disposition_set:admin
List disposition setscontact_center:read:list_disposition_sets:admin
Get a disposition setcontact_center:read:disposition_set:admin
Create a dispositioncontact_center:write:disposition:admin
Delete a dispositioncontact_center:delete:disposition:admin
Update a disposition setcontact_center:update:disposition_set:admin
List dispositionscontact_center:read:list_dispositions:admin
Delete a disposition setcontact_center:delete:disposition_set:admin
Update a dispositioncontact_center:update:disposition:admin
Get a dispositioncontact_center:read:disposition:admin

Engagements

API endpointgranular scope
Poll an engagement recording's statuscontact_center:read:engagement_recording_status:admin
Update an engagementcontact_center:update:engagement:admin
Get available transfer userscontact_center:read:list_users:admin
Start an engagementcontact_center:write:engagement:admin
Get available transfer flowscontact_center:read:flow:admin
Get an engagement's attachmentscontact_center:read:attachment:admin
Get an engagement's eventscontact_center:read:engagement:admin
List engagementscontact_center:read:list_engagements:admin
Get an engagement's surveycontact_center:read:engagement:admin
Get an engagementcontact_center:read:engagement:admin
Get available transfer queuescontact_center:read:list_queues:admin

Flows

API endpointgranular scope
Import a flowcontact_center:write:flow:admin
Remove flow entry pointscontact_center:delete:flow:admin
List flowscontact_center:read:list_flows:admin
List flow's entry pointscontact_center:read:flow:admin
List entry pointscontact_center:read:flow:admin
Add flow entry pointscontact_center:write:flow:admin
Edit a flowcontact_center:update:flow:admin
Get a flowcontact_center:read:flow:admin
Delete a flowcontact_center:delete:flow:admin
Publish a flowcontact_center:update:flow:admin
Export a flowcontact_center:read:flow:admin

Inboxes

API endpointgranular scope
Create an inboxcontact_center:write:inbox:admin
List an account's inbox messagescontact_center:read:inbox_messages:admin
Assign inbox access userscontact_center:write:inbox_user:admin
Update an inboxcontact_center:update:inbox:admin
Delete inboxescontact_center:delete:inbox:admin
Remove inbox access queuescontact_center:delete:inbox_queue:admin
Delete an inbox's messagescontact_center:delete:inbox_messages:admin
Update an inbox's email notification settingcontact_center:update:inbox:admin
Get an inbox's userscontact_center:read:inbox_user:admin
Get inbox email notification listcontact_center:read:inbox:admin
Delete inbox messagescontact_center:delete:inbox_messages:admin
List an inbox's messagescontact_center:read:inbox_messages:admin
Get inbox access queuescontact_center:read:list_inbox_queues:admin
Assign inbox access queuescontact_center:write:inbox_queue:admin
List inboxescontact_center:read:list_inboxes:admin
Delete an inbox messagecontact_center:delete:inbox_message:admin
Get an inboxcontact_center:read:inbox:admin
Unassign inbox access userscontact_center:delete:inbox_user:admin

Logs

API endpointgranular scope
List voice call logscontact_center:read:voice_call_log:admin
List voice call logscontact_center:read:voice_call_log:master
List message historycontact_center:read:messaging:admin
List email message historycontact_center:read:engagement_log:admin
List work item message historycontact_center:read:engagement_log:admin
List SMS logscontact_center:read:sms_log:admin
List SMS logscontact_center:read:sms_log:master

Messaging

API endpointgranular scope
Send a messagecontact_center:write:messaging:admin

Notes

API endpointgranular scope
List notescontact_center:read:list_notes:admin
Get a notecontact_center:read:note:admin
Update a notecontact_center:update:note
List engagement notescontact_center:read:list_notes:admin

Operating Hours

API endpointgranular scope
Create business hourscontact_center:write:business_hour:admin
List the business hours' queuescontact_center:read:business_hours_queue:admin
Update a closure setcontact_center:update:closure_hour:admin
Create a closure setcontact_center:write:closure_hour:admin
Update business hourscontact_center:update:business_hour:admin
List business hourscontact_center:read:list_business_hours:admin
List the closures' queuescontact_center:read:closure_hour_queue:admin
Get a closure setcontact_center:read:closure_hour:admin
List the business hours' flowscontact_center:read:business_hours_flow:admin
Delete business hourscontact_center:delete:business_hour:admin
Get business hourscontact_center:read:business_hour:admin
Delete a closure setcontact_center:delete:closure_hour:admin
List closurescontact_center:read:list_closure_hours:admin
List the closures' flowscontact_center:read:clousre_hour_flow:admin

Queues

API endpointgranular scope
Update a queue's operating hourscontact_center:patch:queue_operating_hours:admin
Update a queue's interrupt settingscontact_center:update:queue:admin
Delete a queuecontact_center:delete:queue:admin
Assign queue dispositionscontact_center:write:queue disposition:admin
Assign a queue menu based interruptcontact_center:update:queue:admin
Delete queue recordingscontact_center:delete:recording:admin
Assign queue supervisorscontact_center:delete:queue_supervisor:admin
Assign queue agentscontact_center:write:queue_agent:admin
List queue dispositionscontact_center:read:list_dispositions:admin
Batch delete queuescontact_center:delete:queue:admin
Unassign a queue teamcontact_center:delete:queue_team:admin
List queuescontact_center:read:list_queues:admin
Get a queue templatecontact_center:read:queue:admin
Get a queuecontact_center:read:queue:admin
Unassign a queue dispositioncontact_center:delete:queue_disposition:admin
Update a queue agent's opt-in/opt-out statuscontact_center:update:queue_agent:admin
Assign queue teamscontact_center:write:queue_team:admin
Create a queuecontact_center:write:queue:admin
List queue supervisorscontact_center:delete:queue_supervisor:admin
Schedule a callback on a queuecontact_center:write:queue:admin
Unassign a queue agentcontact_center:delete:queue_agent:admin
Delete an attendee from a scheduled callback eventcontact_center:delete:queue:admin
Get a queue's interrupt settingscontact_center:read:queue:admin
List queue agentscontact_center:read:list_queue_agents:admin
Unassign a queue disposition setcontact_center:delete:queue_disposition_set:admin
List queue templatescontact_center:read:queue:admin
List queue recordingscontact_center:read:list_recordings:admin contact_center:read:list_recordings
List queue disposition setscontact_center:read:list_disposition_sets:admin
Batch create queues with a templatecontact_center:write:queue:admin
Get a queue's operating hourscontact_center:read:queue_operating_hours:admin
Assign queue disposition setscontact_center:write:queue_disposition_set:admin
Unassign queue teamscontact_center:delete:queue_team:admin
Delete a queue's interrupt menu configurationcontact_center:delete:queue:admin
Unassign a queue supervisorcontact_center:delete:queue_supervisor:admin
List a queue's scheduled callbacks availabilitycontact_center:read:queue:admin
Update a queuecontact_center:update:queue:admin

RTMS

API endpointgranular scope
Update engagement Real-Time Media Streams (RTMS) app statuscontact_center:update:engagement_rtms_app_status contact_center:update:engagement_rtms_app_status:admin

Recordings

API endpointgranular scope
Delete engagement recordingscontact_center:delete:recording:admin
Delete a recordingcontact_center:delete:recording:admin
List recordingscontact_center:read:list_recordings:admin
List engagement recordingscontact_center:read:list_recordings:admin

Regions

API endpointgranular scope
List regionscontact_center:read:list_regions:admin
Update a regioncontact_center:udpate:region:admin
Delete a regioncontact_center:delete:region:admin
Assign users to a regioncontact_center:write:region_user:admin
Create a regioncontact_center:write:region:admin
Get a regioncontact_center:read:region:admin
List a region's userscontact_center:read:list_region_users:admin

Reports V2(CX Analytics)

API endpointgranular scope
List historical disposition dataset datacontact_center:read:dataset_disposition:admin
List historical queue performance dataset datacontact_center:read:dataset_queue_performance:admin
List historical flow performance dataset datacontact_center:read:dataset_flow_performance:admin
List historical expert assist dataset datacontact_center:read:dataset_expert_assist:admin
List operation logscontact_center:read:operation_logs:admin
List historical Zoom Phone to Contact Center call journey datacontact_center:read:call_journey_log:admin
List historical engagement log datacontact_center:read:engagement_log:admin
List historical outbound dialer performance dataset datacontact_center:read:dataset_outbound_dialer_performance:admin
List historical agent performance dataset datacontact_center:read:dataset_agent_performance:admin
List historical engagement dataset datacontact_center:read:dataset_engagement:admin
List historical agent timecard dataset datacontact_center:read:dataset_agent_timecard:admin

Reports(Legacy Reports)

API endpointgranular scope
List historical queue's agents reportscontact_center:read:agent_report:admin
List historical detail reportscontact_center:read:engagement_report:admin
List agent leg reportscontact_center:read:agent_report:admin
List agent's status history reportscontact_center:read:agent_status_report:admin
List agent's time sheet reportscontact_center:read:agent_report:admin
List historical agent reports by queuecontact_center:read:agent_report:admin
List historical queue reportscontact_center:read:queue_report:admin

Roles

API endpointgranular scope
Create a rolecontact_center:write:role:admin
Delete a rolecontact_center:delete:role:admin
Update a rolecontact_center:update:role:admin
Delete role privilegescontact_center:delete:role:admin
List users of a rolecontact_center:read:list_role_users:admin
Unassign a user from a rolecontact_center:delete:role_user:admin
List rolescontact_center:read:list_roles:admin
Assign a rolecontact_center:write:role_user:admin
Duplicate a rolecontact_center:write:role:admin
Get a rolecontact_center:read:role:admin

Routing Profiles

API endpointgranular scope
Get a consumer routing profilecontact_center:read:consumer_routing_profile:admin
Update a consumer routing profile's detailscontact_center:update:consumer_routing_profile:admin
List consumer routing profilescontact_center:read:consumer_routing_profile:admin
Create a consumer routing profilecontact_center:write:consumer_routing_profile:admin
Update an agent routing profile's detailscontact_center:update:agent_routing_profile:admin
Create an agent routing profilecontact_center:write:agent_routing_profile:admin
Delete a consumer routing profilecontact_center:delete:consumer_routing_profile:admin
List agent routing profilescontact_center:read:agent_routing_profile:admin
Delete an agent routing profilecontact_center:delete:agent_routing_profile:admin
Get an agent routing profilecontact_center:read:agent_routing_profile:admin

SMS

API endpointgranular scope
Send an SMScontact_center:write:sms:admin

Skills

API endpointgranular scope
Create a skillcontact_center:write:skill:admin
List skill categoriescontact_center:read:list_skill_categories:admin
Delete a skillcontact_center:delete:skill:admin
Update a skillcontact_center:update:skill:admin
List users of a skillcontact_center:read:list_skill_users:admin
Create a skill categorycontact_center:write:skill_category:admin
List skillscontact_center:read:list_skills:admin
Get a skill categorycontact_center:read:skill_category:admin
Get a skillcontact_center:read:skill:admin
Delete a skill categorycontact_center:delete:skill_category:admin
Update a skill categorycontact_center:update:skill_category:admin

Teams

API endpointgranular scope
Unassign team supervisorscontact_center:delete:team:admin
Get a teamcontact_center:read:team:admin
List teamscontact_center:read:team:admin
List team's parent teamscontact_center:read:team:admin
Unassign team agentscontact_center:delete:team:admin
Create a teamcontact_center:write:team:admin
Move a teamcontact_center:update:team:admin
Delete a teamcontact_center:delete:team:admin
List a team's child teamscontact_center:read:team:admin
Assign team agentscontact_center:write:team:admin
Update a teamcontact_center:update:team:admin
Assign team supervisorscontact_center:write:team:admin
List team supervisorscontact_center:read:team:admin
List team agentscontact_center:read:team:admin

Users

API endpointgranular scope
Create a user's profilecontact_center:write:user:admin
Batch update user statuscontact_center:write:batch_users:admin
Create a user templatecontact_center:write:user_templates:admin
Batch delete user profilescontact_center:delete:batch_users:admin
Update a user's statuscontact_center:update:user:admin
Opt-in or opt-out a user's queuescontact_center:update:queue_agent:admin
Batch create user profilescontact_center:write:batch_users:admin
List a user's queuescontact_center:read:list_user_queues:admin
List user profilescontact_center:read:list_users:admin
Get a user templatecontact_center:read:user_templates:admin
List user templatescontact_center:read:user_templates:admin
Delete a user templatecontact_center:delete:user_templates:admin
Update a user templatecontact_center:update:user_templates:admin
List a user's recordingscontact_center:read:list_recordings:admin contact_center:read:list_recordings
Update a user's profilecontact_center:update:user:admin
Assign a user's skillscontact_center:write:user_skill:admin
Get a user's profilecontact_center:read:user:admin
List a user's skillscontact_center:read:list_user_skills:admin
Delete a user's profilecontact_center:delete:user:admin
Batch update user profilescontact_center:update:batch_users:admin
Unassign a user's skillcontact_center:delete:user_skill:admin
Delete a user's recordingscontact_center:delete:recording:admin

Variables

API endpointgranular scope
Delete a variablecontact_center:delete:variable:admin
List variablescontact_center:read:list_variables:admin
List variable groupscontact_center:read:list_variable_groups:admin
Get a variable logcontact_center:read:variable_log:admin
Get a variable groupcontact_center:read:variable_group:admin
Create a variablecontact_center:write:variable:admin
Delete a variable groupcontact_center:delete:variable_group:admin
Delete a variable logcontact_center:delete:variable_log:admin
Update a variable groupcontact_center:update:variable_group:admin
Get a variablecontact_center:read:variable:admin
Create a variable groupcontact_center:write:variable_group:admin
List variable logscontact_center:read:list_variable_logs:admin
Update a variablecontact_center:update:variable:admin

Zoom Calendar

The following are the available Zoom Calendar APIs and their associated granular scopes.

acl

API endpointgranular scope
Create a new ACL rulecalendar:write:acl calendar:write:acl:admin
Delete an existing ACL rulecalendar:delete:acl calendar:delete:acl:admin
Update the specified ACL rulecalendar:update:acl calendar:update:acl:admin
List ACL rules of specified calendarcalendar:read:list_acl calendar:read:list_acl:admin
Get the specified ACL rulecalendar:read:acl calendar:read:acl:admin

calendar list

API endpointgranular scope
Insert an existing calendar to the user's own calendarListcalendar:write:calendar_list
Delete an existing calendar from the user's own calendarListcalendar:delete:calendar_list
List the calendars in the user's own calendarListcalendar:read:list_calendar_lists
Update an existing calendar in the user's own calendarListcalendar:update:calendar_list
Get a specified calendar from the user's own calendarListcalendar:read:calendar_list

calendars

API endpointgranular scope
Get the specified calendarcalendar:read:calendar calendar:read:calendar:admin
Delete a calendar owned by a usercalendar:delete:calendar calendar:delete:calendar:admin
Create a new secondary calendarcalendar:write:calendar calendar:write:calendar:admin
Update the specified calendarcalendar:update:calendar calendar:update:calendar:admin

colors

API endpointgranular scope
Get the color definitions for calendars and eventscalendar:read:color calendar:read:color:admin

events

API endpointgranular scope
Quick add an event to the specified calendarcalendar:write:quick_add_event calendar:write:quick_add_event:admin
Move the specified event from a calendar to another specified calendarcalendar:write:move_event calendar:write:move_event:admin
Get the specified event on the specified calendarcalendar:read:event calendar:read:event:admin
Update the specified event on the specified calendarcalendar:update:event calendar:update:event:admin
Import event to the specified calendarcalendar:write:import_event calendar:write:import_event:admin
List events on the specified calendarcalendar:read:list_events calendar:read:list_events:admin
Insert a new event to the specified calendarcalendar:write:event calendar:write:event:admin
List all instances of the specified recurring eventcalendar:read:instance_event calendar:read:instance_event:admin
Delete an existing event from the specified calendarcalendar:delete:event calendar:delete:event:admin

freebusy

API endpointgranular scope
Query freebusy information for a set of calendarscalendar:read:list_events calendar:read:list_events:admin

settings

API endpointgranular scope
Get the specified user calendar settings of the authenticated usercalendar:read:setting
List all user calendar settings of the authenticated usercalendar:read:list_settings
Patch the specified user calendar settings of the authenticated user calendar:update:setting calendar:update:setting:admin

Zoom Virtual Agent

The following are the available Zoom Virtual Agent APIs and their associated granular scopes.

Knowledge Management

API endpointgranular scope
Get articleszva:read:list_km_articles zva:read:list_km_articles:admin
Get synczva:read:km_kb:admin
Get articlezva:read:km_article zva:read:km_article:admin
Delete articlezva:delete:km_article zva:delete:km_article:admin
Create sync requestzva:update:km_kb:admin
Update articlezva:update:km_article zva:update:km_article:admin
Create articlezva:write:km_article zva:write:km_article:admin

Report

API endpointgranular scope
Get ZVA engagementszva:read:list_engagements:admin
Get ZVA query detailszva:read:list_queries:admin
Get ZVA Surveyszva:read:list_surveys:admin
Get ZVA variable detailszva:read:list_variables:admin
Get ZVA transcriptszva:read:list_transcripts:admin

Number Management

The following are the available Number Management APIs and their associated granular scopes.

Cloud Peering Provider Exchange

API endpointgranular scope
[Add peering phone numbers](/docs/api/rest/reference/Number Management/methods/#operation/addPeeringPhoneNumbers)number_management:write:peering_number:admin
[Add peering phone numbers](/docs/api/rest/reference/Number Management/ma/#operation/addPeeringPhoneNumbers)number_management:write:peering_number:master
[List peering phone numbers for provider](/docs/api/rest/reference/Number Management/methods/#operation/Listpeeringphonenumbersforprovider)number_management:read:list_carrier_peering_numbers:admin
[List peering phone numbers for provider](/docs/api/rest/reference/Number Management/ma/#operation/Listpeeringphonenumbersforprovider)number_management:read:list_carrier_peering_numbers:master
[Update peering phone numbers](/docs/api/rest/reference/Number Management/methods/#operation/updatePeeringPhoneNumbers)number_management:update:peering_number:admin
[Update peering phone numbers](/docs/api/rest/reference/Number Management/ma/#operation/updatePeeringPhoneNumbers)number_management:update:peering_number:master
[Remove peering phone numbers](/docs/api/rest/reference/Number Management/methods/#operation/deletePeeringPhoneNumbers)number_management:delete:peering_number:admin
[Remove peering phone numbers](/docs/api/rest/reference/Number Management/ma/#operation/deletePeeringPhoneNumbers)number_management:delete:peering_number:master
[List peering phone numbers](/docs/api/rest/reference/Number Management/methods/#operation/listPeeringPhoneNumbers)number_management:read:list_peering_numbers:admin
[List peering phone numbers](/docs/api/rest/reference/Number Management/ma/#operation/listPeeringPhoneNumbers)number_management:read:list_peering_numbers:master

Phone Numbers

API endpointgranular scope
[Add BYOC phone numbers](/docs/api/rest/reference/Number Management/methods/#operation/AddBYOCPhoneNumber)number_management:write:byoc_numbers:admin
[Add BYOC phone numbers](/docs/api/rest/reference/Number Management/ma/#operation/AddBYOCPhoneNumber)number_management:write:byoc_numbers:master
[List phone numbers](/docs/api/rest/reference/Number Management/methods/#operation/listPhoneNumbers)number_management:read:list_numbers:admin
[List phone numbers](/docs/api/rest/reference/Number Management/ma/#operation/listPhoneNumbers)number_management:read:list_numbers:master
[Get a phone number](/docs/api/rest/reference/Number Management/methods/#operation/getPhoneNumber)number_management:read:numbers:admin
[Get a phone number](/docs/api/rest/reference/Number Management/ma/#operation/getPhoneNumber)number_management:read:numbers:master
[Delete phone numbers](/docs/api/rest/reference/Number Management/methods/#operation/DeleteNumbers)number_management:delete:numbers:admin
[Delete phone numbers](/docs/api/rest/reference/Number Management/ma/#operation/DeleteNumbers)number_management:delete:numbers:master
[Update a phone number](/docs/api/rest/reference/Number Management/methods/#operation/updatePhoneNumberDetail)number_management:update:numbers:admin
[Update a phone number](/docs/api/rest/reference/Number Management/ma/#operation/updatePhoneNumberDetail)number_management:update:numbers:master
[Allocate/Unallocate phone numbers](/docs/api/rest/reference/Number Management/methods/#operation/AllocateNumber)number_management:write:numbers:admin
[Allocate/Unallocate phone numbers](/docs/api/rest/reference/Number Management/ma/#operation/AllocateNumber)number_management:write:numbers:master

Phone Plan

API endpointgranular scope
[List phone number plan information](/docs/api/rest/reference/Number Management/methods/#operation/Listphonenumberplaninformation)number_management:read:numbers_plan:admin
[List phone number plan information](/docs/api/rest/reference/Number Management/ma/#operation/Listphonenumberplaninformation)number_management:read:numbers_plan:master

SMS Campaigns

API endpointgranular scope
[List SMS campaigns](/docs/api/rest/reference/Number Management/methods/#operation/listAccountSMSCampaigns)number_management:read:list_sms_campaigns:admin
[List SMS campaigns](/docs/api/rest/reference/Number Management/ma/#operation/listAccountSMSCampaigns)number_management:read:list_sms_campaigns:master
[Get an SMS campaign](/docs/api/rest/reference/Number Management/methods/#operation/GetSMSCampaign)number_management:read:sms_campaign:admin
[Get an SMS campaign](/docs/api/rest/reference/Number Management/ma/#operation/GetSMSCampaign)number_management:read:sms_campaign:master
[Assign a phone number to SMS campaign](/docs/api/rest/reference/Number Management/methods/#operation/assignCampaignPhoneNumbers)number_management:update:numbers:admin
[Assign a phone number to SMS campaign](/docs/api/rest/reference/Number Management/ma/#operation/assignCampaignPhoneNumbers)number_management:update:numbers:master
[Unassign phone number from SMS campaign](/docs/api/rest/reference/Number Management/methods/#operation/unassignCampaignPhoneNumber)number_management:update:numbers:admin
[Unassign phone number from SMS campaign](/docs/api/rest/reference/Number Management/ma/#operation/unassignCampaignPhoneNumber)number_management:update:numbers:master

SMS Consent

API endpointgranular scope
[Unassign phone numbers from SMS consent policy](/docs/api/rest/reference/Number Management/methods/#operation/UnassignPhoneNumbersFromConsent)number_management:delete:numbers:admin
[Unassign phone numbers from SMS consent policy](/docs/api/rest/reference/Number Management/ma/#operation/UnassignPhoneNumbersFromConsent)number_management:delete:numbers:master
[Update an SMS consent policy](/docs/api/rest/reference/Number Management/methods/#operation/UpdateSMSConsent)number_management:update:sms_consent:admin
[Update an SMS consent policy](/docs/api/rest/reference/Number Management/ma/#operation/UpdateSMSConsent)number_management:update:sms_consent:master
[List SMS consent policies](/docs/api/rest/reference/Number Management/methods/#operation/ListSMSConsents)number_management:read:sms_consent:admin
[List SMS consent policies](/docs/api/rest/reference/Number Management/ma/#operation/ListSMSConsents)number_management:read:sms_consent:master
[Assign phone numbers to SMS consent policy](/docs/api/rest/reference/Number Management/methods/#operation/AssignPhoneNumbersToConsent)number_management:write:numbers:admin
[Assign phone numbers to SMS consent policy](/docs/api/rest/reference/Number Management/ma/#operation/AssignPhoneNumbersToConsent)number_management:write:numbers:master
[Get an SMS consent policy](/docs/api/rest/reference/Number Management/methods/#operation/GetSMSConsent)number_management:read:sms_consent:admin
[Get an SMS consent policy](/docs/api/rest/reference/Number Management/ma/#operation/GetSMSConsent)number_management:read:sms_consent:master
[Delete SMS consent policies](/docs/api/rest/reference/Number Management/methods/#operation/DeleteSMSConsents)number_management:delete:sms_consent:admin
[Delete SMS consent policies](/docs/api/rest/reference/Number Management/ma/#operation/DeleteSMSConsents)number_management:delete:sms_consent:master
[List phone numbers assigned to SMS consent policy](/docs/api/rest/reference/Number Management/methods/#operation/ListConsentPhoneNumbers)number_management:read:sms_consent:admin
[List phone numbers assigned to SMS consent policy](/docs/api/rest/reference/Number Management/ma/#operation/ListConsentPhoneNumbers)number_management:read:sms_consent:master
[Create an SMS consent policy](/docs/api/rest/reference/Number Management/methods/#operation/CreateSMSConsent)number_management:write:sms_consent:admin
[Create an SMS consent policy](/docs/api/rest/reference/Number Management/ma/#operation/CreateSMSConsent)number_management:write:sms_consent:master

Setting

API endpointgranular scope
[List ported numbers](/docs/api/rest/reference/Number Management/methods/#operation/Listportednumbers)number_management:read:list_ported_numbers:admin
[List ported numbers](/docs/api/rest/reference/Number Management/ma/#operation/Listportednumbers)number_management:read:list_ported_numbers:master
[List BYOC SIP trunks](/docs/api/rest/reference/Number Management/methods/#operation/ListBYOCSIPtrunks)number_management:read:list_sip_trunks:admin
[List BYOC SIP trunks](/docs/api/rest/reference/Number Management/ma/#operation/ListBYOCSIPtrunks)number_management:read:list_sip_trunks:master
[Get ported numbers details](/docs/api/rest/reference/Number Management/methods/#operation/Getportednumbersdetails)number_management:read:ported_number:admin
[Get ported numbers details](/docs/api/rest/reference/Number Management/ma/#operation/Getportednumbersdetails)number_management:read:ported_number:master
[List SIP groups](/docs/api/rest/reference/Number Management/methods/#operation/ListSIPgroups)number_management:read:list_sip_groups:admin
[List SIP groups](/docs/api/rest/reference/Number Management/ma/#operation/ListSIPgroups)number_management:read:list_sip_groups:master

Zoom Commerce

The following are the available Zoom Commerce APIs and their associated granular scopes.

Account Management

API endpointgranular scope
Get the account details for a Zoom Partner/Subreseller/End Customerzoom_commerce:read:account:admin
Create an end customer accountzoom_commerce:write:sub_account:admin
Get the list of all accounts associated with a Zoom Partner/Sub-Reseller, by the account typezoom_commerce:read:account:admin
Add contacts to an existing end customer or your own account.zoom_commerce:update:account:admin

Billing

API endpointgranular scope
Gets the PDF document for the billing document IDzoom_commerce:read:billing_documents:admin
Gets all billing documents for a distributor or a resellerzoom_commerce:read:billing_documents:admin
Get detailed information about a specific invoice for a distributor or a resellerzoom_commerce:read:billing_documents:admin

Deal Registration

API endpointgranular scope
Get details of a deal registration by registration numberzoom_commerce:read:deal_registration:admin
Gets all valid Deal Registrations for a partnerzoom_commerce:read:deal_registration:admin
Retrieves all valid Zoom Campaigns which a deal registration can be associated with.zoom_commerce:read:deal_registration:admin
Creates a new deal registration for a partnerzoom_commerce:write:deal_registration:admin
Updates an existing deal registrationzoom_commerce:write:deal_registration:admin

Order

API endpointgranular scope
Preview delta order metrics and subscriptions in an order zoom_commerce:write:order:admin
Gets all orders for a Zoom partner.zoom_commerce:read:order:admin
Get order details by order reference IDzoom_commerce:read:order:admin
Create a subscription order for a Zoom partnerzoom_commerce:write:order:admin

Platform

API endpointgranular scope
Gets details of all files associated with a quote or deal registrationzoom_commerce:read:file:admin
Download a file associated with a quote or deal registration.zoom_commerce:read:file:admin
Upload an attachment pdf file in context of a deal registration or quotezoom_commerce:write:file:admin

Product Catalog

API endpointgranular scope
Gets the details for a Zoom product or offer.zoom_commerce:read:product_catalog:admin
Gets the pricebook in a downloadable filezoom_commerce:read:product_catalog:admin
Gets Zoom Product Catalog for a Zoom Partnerzoom_commerce:read:product_catalog:admin

Quote

API endpointgranular scope
Get quote details by quote reference IDzoom_commerce:read:quote:admin
Submits a subscription quote for provisioningzoom_commerce:write:quote:admin
Gets all quotes for a Zoom partnerzoom_commerce:read:quote:admin
Preview delta quote metrics and subscriptions in a quote zoom_commerce:write:quote:admin
Update a subscription quote for a Zoom partnerzoom_commerce:write:quote:admin
Create a subscription quote for a Zoom Partnerzoom_commerce:write:quote:admin

Subscription

API endpointgranular scope
Gets paid subscriptions for a Zoom partner.zoom_commerce:read:subscription:admin
Get trial details for an end customer by their Zoom account number or the trial IDzoom_commerce:read:subscription:admin
Get trial subscriptions for a Zoom partnerzoom_commerce:read:subscription:admin
Gets subscription details for a given subscription numberzoom_commerce:read:subscription:admin
Gets subscription changes/versions for a given subscription number.zoom_commerce:read:subscription:admin

Docs

The following are the available Docs APIs and their associated granular scopes.

Collaborator

API endpointgranular scope
Modify a collaborator’s role on a filedocs:update:collaborator docs:update:collaborator:admin
Remove a collaborator from a filedocs:delete:collaborator docs:delete:collaborator:admin
Add collaborators for a filedocs:write:collaborator docs:write:collaborator:admin
List collaborators of a filedocs:read:list_file_collaborators docs:read:list_file_collaborators:admin

Export

API endpointgranular scope
Get file export statusdocs:read:export
Get file contentdocs:read:export
Create a file exportdocs:write:export

File Management

API endpointgranular scope
Create a new filedocs:write:file docs:write:file:admin
Modify metadata of a filedocs:update:file docs:update:file:admin
Get metadata of a filedocs:read:file docs:read:file:admin
List all children of a filedocs:read:list_children docs:read:list_children:admin
Delete a filedocs:delete:file docs:delete:file:admin

File Uploads

API endpointgranular scope
Create file upload for docs import or attachmentsdocs:write:file_uploads docs:write:file_uploads:admin

General Access

API endpointgranular scope
Get the general access setting of a filedocs:read:general_access docs:read:general_access:admin
Modify the general access setting of a filedocs:update:general_access docs:update:general_access:admin

Import

API endpointgranular scope
Create a new file by importdocs:write:import docs:write:import:admin
Get file import statusdocs:read:import docs:read:import:admin

Zoom Video Management

The following are the available Zoom Video Management APIs and their associated granular scopes.

Channels

API endpointgranular scope
List channelsvideo_mgmt:read:list_channels video_mgmt:read:list_channels:admin
Update channelvideo_mgmt:update:channel video_mgmt:update:channel:admin
Channel actionsvideo_mgmt:update:channel video_mgmt:update:channel:admin
Get channel detailsvideo_mgmt:read:channel video_mgmt:read:channel:admin
Create a channelvideo_mgmt:write:channel video_mgmt:write:channel:admin
Delete channelvideo_mgmt:delete:channel video_mgmt:delete:channel:admin

Permissions

API endpointgranular scope
List channel permissionsvideo_mgmt:read:list_permissions video_mgmt:read:list_permissions:admin
Update channel permissionsvideo_mgmt:update:permissions video_mgmt:update:permissions:admin
Create channel permissionsvideo_mgmt:write:permissions video_mgmt:write:permissions:admin
Delete channel permissionsvideo_mgmt:delete:permissions video_mgmt:delete:permissions:admin

Playlists

API endpointgranular scope
Delete playlistvideo_mgmt:delete:playlist video_mgmt:delete:playlist:admin
Add channel playlists video_mgmt:write:channel_playlists video_mgmt:write:channel_playlists:admin
List playlistsvideo_mgmt:read:list_playlists video_mgmt:read:list_playlists:admin
List channel playlistsvideo_mgmt:read:list_channel_playlists video_mgmt:read:list_channel_playlists:admin
Create a playlistvideo_mgmt:write:playlist video_mgmt:write:playlist:admin
Delete channel playlistsvideo_mgmt:delete:channel_playlists video_mgmt:delete:channel_playlists:admin
Update playlistvideo_mgmt:update:playlist video_mgmt:update:playlist:admin

Videos

API endpointgranular scope
List playlist videosvideo_mgmt:read:list_playlist_videos video_mgmt:read:list_playlist_videos:admin
Add playlist videosvideo_mgmt:write:playlist_videos video_mgmt:write:playlist_videos:admin
Delete playlist videosvideo_mgmt:delete:playlist_videos video_mgmt:delete:playlist_videos:admin
Delete channel videosvideo_mgmt:delete:channel_videos video_mgmt:delete:channel_videos:admin
Add channel videosvideo_mgmt:write:channel_videos video_mgmt:write:channel_videos:admin
List all videosvideo_mgmt:read:list_videos video_mgmt:read:list_videos:admin
List channel videosvideo_mgmt:read:list_channel_videos video_mgmt:read:list_channel_videos:admin

files

API endpointgranular scope
Upload file for video managementvideo_mgmt:write:file video_mgmt:write:file:admin

Zoom Events

The following are the available Zoom Events APIs and their associated granular scopes.

Attendee Actions

API endpointgranular scope
Update event attendee actionszoom_events:update:batch_attendee_actions zoom_events:update:batch_attendee_actions:admin
List event attendee actionszoom_events:read:list_attendee_actions zoom_events:read:list_attendee_actions:admin
List session attendee actionszoom_events:read:list_session_attendee_actions zoom_events:read:list_session_attendee_actions:admin
Update session attendee actionszoom_events:update:batch_session_attendee_actions zoom_events:update:batch_session_attendee_actions:admin

Co Editors

API endpointgranular scope
Add or remove event co-editorszoom_events:write:coeditor zoom_events:write:coeditor:admin
List coeditorszoom_events:read:list_coeditors zoom_events:read:list_coeditors:admin

Emails

API endpointgranular scope
List event emails sent statuszoom_events:read:list_emails_status zoom_events:read:list_emails_status:admin
List event email typeszoom_events:read:list_email_types zoom_events:read:list_email_types:admin

Event Access

API endpointgranular scope
List event access linkszoom_events:read:list_access_links zoom_events:read:list_access_links:admin
Get event access linkzoom_events:read:access_links zoom_events:read:access_links:admin
Update event accesszoom_events:update:access_links zoom_events:update:access_links:admin
Delete event access linkzoom_events:delete:access_links zoom_events:delete:access_links:admin
Create event access linkzoom_events:write:access_links zoom_events:write:access_links:admin

Events

API endpointgranular scope
List eventszoom_events:read:list_events zoom_events:read:list_events:admin
Get an eventzoom_events:read:event zoom_events:read:event:admin
Delete an eventzoom_events:delete:event zoom_events:delete:event:admin
Event actionszoom_events:write:event zoom_events:write:event:admin
Update an eventzoom_events:update:event zoom_events:update:event:admin
Create an eventzoom_events:write:event zoom_events:write:event:admin

Exhibitors

API endpointgranular scope
Create an exhibitorzoom_events:write:exhibitor zoom_events:write:exhibitor:admin
List exhibitorszoom_events:read:list_exhibitors zoom_events:read:list_exhibitors:admin
Update exhibitor for an eventzoom_events:update:exhibitor zoom_events:update:exhibitor:admin
Delete an exhibitorzoom_events:delete:exhibitor zoom_events:delete:exhibitor:admin
List sponsor tierszoom_events:read:list_sponsor_tiers zoom_events:read:list_sponsor_tiers:admin
Get an exhibitorzoom_events:read:exhibitor zoom_events:read:exhibitor:admin

Files

API endpointgranular scope
Upload events multipart fileszoom_events:write:file_upload zoom_events:write:file_upload:admin
Upload events filezoom_events:write:file_upload zoom_events:write:file_upload:admin
Initiate and complete the multipart file upload zoom_events:write:file_upload zoom_events:write:file_upload:admin

Hubs

API endpointgranular scope
Creates a new hub hostzoom_events:write:hub_host zoom_events:write:hub_host:admin
List hub Hostszoom_events:read:list_hub_hosts zoom_events:read:list_hub_hosts:admin
List hub videoszoom_events:read:list_hub_videos zoom_events:read:list_hub_videos:admin
Remove hub hostzoom_events:delete:hub_host zoom_events:delete:hub_host:admin
List hubszoom_events:read:list_hubs zoom_events:read:list_hubs:admin

Registrants

API endpointgranular scope
List registrantszoom_events:read:list_registrants zoom_events:read:list_registrants:admin
List session attendeeszoom_events:read:list_session_attendees zoom_events:read:list_session_attendees:admin

Reports

API endpointgranular scope
Get VOD channel registration reportzoom_events:read:vod_registrations zoom_events:read:vod_registrations:admin
Get event survey reportzoom_events:read:list_session_surveys zoom_events:read:list_session_surveys:admin
Get session attendance reportzoom_events:read:session_attendance zoom_events:read:session_attendance:admin
Get chat transcripts reportzoom_events:read:chat_transcripts zoom_events:read:chat_transcripts:admin
Get custom reportzoom_events:read:custom_report zoom_events:read:custom_report:admin
Get event registrations reportzoom_events:read:event_registration zoom_events:read:event_registration:admin
Get event attendance (Live or Lobby) reportzoom_events:read:event_attendance zoom_events:read:event_attendance:admin

Sessions

API endpointgranular scope
List sessionszoom_events:read:list_sessions zoom_events:read:list_sessions:admin
List session reservationszoom_events:read:list_session_reservations zoom_events:read:list_session_reservations:admin
Add session reservationszoom_events:write:session_reservations zoom_events:write:session_reservations:admin
Update a sessionzoom_events:update:session zoom_events:update:session:admin
Get the session informationzoom_events:read:session zoom_events:read:session:admin
Create a sessionzoom_events:write:session zoom_events:write:session:admin
List session pollszoom_events:read:list_session_polls zoom_events:read:list_session_polls:admin
Get session livestream configurationzoom_events:read:session_livestream_config zoom_events:read:session_livestream_config:admin
Delete session reservationszoom_events:delete:session_reservations zoom_events:delete:session_reservations:admin
Update session livestream configurationzoom_events:update:session_livestream_config zoom_events:update:session_livestream_config:admin
List session interpreterszoom_events:read:list_session_interpreters zoom_events:read:list_session_interpreters:admin
Delete a sessionzoom_events:delete:session zoom_events:delete:session:admin
Create or update session pollszoom_events:update:session_poll zoom_events:update:session_poll:admin
Get ticket session join token by Event ID and Session IDzoom_events:read:session_token zoom_events:read:session_token:admin
Create or update session interpreterszoom_events:update:session_interpreter zoom_events:update:session_interpreter:admin

Speakers

API endpointgranular scope
List speakerszoom_events:read:list_speakers zoom_events:read:list_speakers:admin
Get a speakerzoom_events:read:speaker zoom_events:read:speaker:admin
Create a speakerzoom_events:write:speaker zoom_events:write:speaker:admin
Delete a speakerzoom_events:delete:speaker zoom_events:delete:speaker:admin
Update a speakerzoom_events:update:speaker zoom_events:update:speaker:admin

Ticket Types

API endpointgranular scope
List ticket typeszoom_events:read:list_ticket_types zoom_events:read:list_ticket_types:admin
Update registration questions for ticket typezoom_events:update:registraion_question zoom_events:update:registraion_question:admin
Delete a ticket typezoom_events:delete:ticket_type zoom_events:delete:ticket_type:admin
Update ticket type for an eventzoom_events:update:ticket_type zoom_events:update:ticket_type:admin
List registration questions for ticket typezoom_events:read:list_registration_questions zoom_events:read:list_registration_questions:admin
Create an event ticket typezoom_events:write:ticket_type zoom_events:write:ticket_type:admin
Update registration questions for an eventzoom_events:update:registraion_question zoom_events:update:registraion_question:admin
List registration questions for an eventzoom_events:read:list_registration_questions zoom_events:read:list_registration_questions:admin

Tickets

API endpointgranular scope
Update ticketzoom_events:write:ticket zoom_events:write:ticket:admin
Create ticketszoom_events:write:ticket zoom_events:write:ticket:admin
Get a ticketzoom_events:read:ticket zoom_events:read:ticket:admin
Delete a ticketzoom_events:delete:ticket zoom_events:delete:ticket:admin
List ticketszoom_events:read:list_tickets zoom_events:read:list_tickets:admin

Video On-Demand

API endpointgranular scope
VOD channel actionszoom_events:update:vod_channel zoom_events:update:vod_channel:admin
List VOD channel videoszoom_events:read:list_vod_channel_videos zoom_events:read:list_vod_channel_videos:admin
Delete VOD Channelzoom_events:delete:vod_channel zoom_events:delete:vod_channel:admin
Create VOD channelzoom_events:write:vod_channel zoom_events:write:vod_channel:admin
Delete VOD channel videozoom_events:delete:vod_channel_videos zoom_events:delete:vod_channel_videos:admin
Update VOD channelzoom_events:update:vod_channel zoom_events:update:vod_channel:admin
Get VOD channel detailszoom_events:read:vod_channel zoom_events:read:vod_channel:admin
List channelszoom_events:read:list_all_vod_channels zoom_events:read:list_all_vod_channels:admin
Add VOD channel videoszoom_events:write:vod_channel_videos zoom_events:write:vod_channel_videos:admin

Video On-Demand Registrations

API endpointgranular scope
List VOD Registrationzoom_events:read:vod_registrations zoom_events:read:vod_registrations:admin
Get VOD Registration Questionszoom_events:read:vod_registration_questions zoom_events:read:vod_registration_questions:admin
update VOD channel registration questionszoom_events:update:vod_registration_questions zoom_events:update:vod_registration_questions:admin
VOD channel registrationzoom_events:write:vod_registration zoom_events:write:vod_registration:admin

Videos

API endpointgranular scope
Update metadata for a specific video.zoom_events:update:video_metadata zoom_events:update:video_metadata:admin
Get metadata for a specific videozoom_events:read:video_metadata zoom_events:read:video_metadata:admin

Marketplace

The following are the available Marketplace APIs and their associated granular scopes.

App

API endpointgranular scope
List appsmarketplace:read:list_apps:admin
Get an app's user requestsmarketplace:read:app_request:admin
Update app's request statusmarketplace:update:app_request:admin
Update app pre approval setting marketplace:write:app_pre_approve:admin
Generate Zoom App Deeplinkmarketplace:write:app_deeplink:admin
Get user's custom field valuesmarketplace:read:custom_fields:admin marketplace:read:custom_fields
Get API call logsmarketplace:read:list_api_logs:admin
Send app notificationsmarketplace:write:notifications
Create appsmarketplace:write:app marketplace:write:app:admin
Create appsmarketplace:write:app:master
Get app user entitlementsmarketplace:read:list_user_entitlements marketplace:read:list_user_entitlements:admin
Get a user's entitlementsmarketplace:read:list_user_entitlements marketplace:read:list_user_entitlements:admin
Get information about an appmarketplace:read:app marketplace:read:app:admin
Add app allow requests for usersmarketplace:write:app_request:admin
Rotate client secretmarketplace:update:client_secret
Get a user's app requestsmarketplace:read:list_user_app_requests:admin marketplace:read:list_user_app_requests
Enable or disable user app subscriptionmarketplace:write:app:admin
Deletes an appmarketplace:write:app marketplace:write:app:admin

Manifest

API endpointgranular scope
Export an app manifest from an existing appmarketplace:read:app marketplace:read:app:admin
Update an app by manifestmarketplace:write:app marketplace:write:app:admin
Validate an app manifestmarketplace:read:app marketplace:read:app:admin

SCIM

The following are the available SCIM APIs and their associated granular scopes.

Group

API endpointgranular scope
Create a groupscim2:admin
List groupsscim2:admin
Delete a groupscim2:admin
Get a groupscim2:admin
Update a groupscim2:admin

User

API endpointgranular scope
Delete a userscim2:admin
List usersscim2:admin
Deactivate a userscim2:admin
Get a userscim2:admin
Create a userscim2:admin
Update a userscim2:admin

Zoom Auto Dialer

The following are the available Zoom Auto Dialer APIs and their associated granular scopes.

Call History & Reporting

API endpointgranular scope
[Get Call History by ID](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/GetCallDetailsbyCallID)zoom_auto_dialer:read:call_history:admin
[Get Call History](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/GetCallHistory)zoom_auto_dialer:read:call_history:admin

Call List Management

API endpointgranular scope
[Create Call List](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/CreateCallList)zoom_auto_dialer:write:call_lists:admin
[Update Call List](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/UpdateCallList)zoom_auto_dialer:update:call_lists:admin
[List Call Lists](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/ListCallLists)zoom_auto_dialer:read:call_lists:admin
[Get Call List by ID](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/GetCallListbyID)zoom_auto_dialer:read:call_lists:admin
[Delete Call List](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/DeleteCallList)zoom_auto_dialer:delete:call_lists:admin

Prospect Management

API endpointgranular scope
[List All Prospects in Call List](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/ListAllProspectsInCallList)zoom_auto_dialer:read:prospects:admin
[Update Prospects batch](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/UpdateProspects)zoom_auto_dialer:update:prospects:admin
[Delete Prospect](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/DeleteProspect)zoom_auto_dialer:delete:prospects:admin
[Create Prospect](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/CreateProspect)zoom_auto_dialer:write:prospects:admin
[Create Prospects batch](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/CreateProspects)zoom_auto_dialer:write:prospects:admin
[Get Prospect by ID](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/GetProspectbyID)zoom_auto_dialer:read:prospects:admin
[Update Prospect](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/UpdateProspect)zoom_auto_dialer:update:prospects:admin