Zoom Contact Center divisions only apply to a subset of the Contact Center APIs. Use this reference to check whether a specific endpoint supports divisions before you call it.
The endpoints are grouped below by API family, along with whether each one accepts the X-Zoom-Division-Id request header to scope the operation to a division.
For more information about divisions and how to use the header, see Using divisions with Contact Center.
All paths are relative to /v2/contact_center.
Address Books
These are the address book APIs that support divisions. For more information, see Address Books.
| Path | Accepts division header |
|---|---|
/address_books | Yes |
/address_books/{addressBookId} | Yes |
/address_books/{addressBookId}/contacts | Yes |
/address_books/{addressBookId}/contacts/{contactId} | Yes |
/address_books/{addressBookId}/contacts/batch | Yes |
/address_books/contacts/{contactId}/custom_fields | Yes |
/address_books/custom_fields | Yes |
/address_books/custom_fields/{customFieldId} | Yes |
/address_books/units | Yes |
/address_books/units/{unitId} | Yes |
Agent Statuses
These are the agent status APIs that support divisions. For more information, see Agent Statuses.
| Path | Accepts division header |
|---|---|
/system_statuses | Yes |
/system_statuses/{statusId} | Yes |
Asset Library
These are the asset library APIs that support divisions. For more information, see Asset Library.
| Path | Accepts division header |
|---|---|
/asset_library/assets | Yes |
/asset_library/assets/{assetId} | Yes |
/asset_library/assets/{assetId}/duplicate | Yes |
/asset_library/assets/{assetId}/items | Yes |
/asset_library/assets/items | Yes |
/asset_library/categories | Yes |
/asset_library/categories/{categoryId} | Yes |
Block List Rules
These are the block list rule APIs that support divisions. For more information, see Block List Rules.
| Path | Accepts division header |
|---|---|
/block_list_rules/ip_addresses | Yes |
/block_list_rules/ip_addresses/{ipAddressBlockListRuleId} | Yes |
/block_list_rules/phone_numbers | Yes |
/block_list_rules/phone_numbers/{phoneBlockListRuleId} | Yes |
Call Control
These are the call control APIs that support divisions. For more information, see Call Control.
| Path | Accepts division header |
|---|---|
/users/{userId}/devices | Yes |
Campaigns
These are the campaign APIs that support divisions. For more information, see Campaigns.
| Path | Accepts division header |
|---|---|
/outbound_campaign/campaigns | Yes |
/outbound_campaign/campaigns/{campaignId} | Yes |
/outbound_campaign/campaigns/{campaignId}/status | Yes |
/outbound_campaign/contact_list_custom_fields | Yes |
/outbound_campaign/contact_list_custom_fields/{customFieldId} | Yes |
/outbound_campaign/contact_lists | Yes |
/outbound_campaign/contact_lists/{contactListId} | Yes |
/outbound_campaign/contact_lists/{contactListId}/contacts | Yes |
/outbound_campaign/contact_lists/{contactListId}/contacts/{contactId} | Yes |
/outbound_campaign/contact_lists/{contactListId}/contacts/batch | Yes |
/outbound_campaign/contacts/{contactId}/custom_fields | Yes |
/outbound_campaign/dnc_lists/{dncListId}/phones | Yes |
Dispositions
These are the disposition APIs that support divisions. For more information, see Dispositions.
| Path | Accepts division header |
|---|---|
/dispositions | Yes |
/dispositions/{dispositionId} | Yes |
/dispositions/sets | Yes |
/dispositions/sets/{dispositionSetId} | Yes |
Engagements
These are the engagement APIs that support divisions. For more information, see Engagements.
| Path | Accepts division header |
|---|---|
/engagements | No |
/engagements/{engagementId} | Yes |
/engagements/{engagementId}/attachments | Yes |
/engagements/{engagementId}/events | Yes |
/engagements/{engagementId}/survey | Yes |
/engagements/{engagementId}/transfer/flows | Yes |
/engagements/{engagementId}/transfer/queues | Yes |
/engagements/{engagementId}/transfer/users | Yes |
/open_engagements | Yes |
Flows
These are the flow APIs that support divisions. For more information, see Flows.
| Path | Accepts division header |
|---|---|
/flows | Yes |
/flows_entry_points | Yes |
/flows/{flowId} | Yes |
/flows/{flowId}/entry_points | Yes |
/flows/{flowId}/export | Yes |
Follow-up Tasks
These are the follow-up task APIs that support divisions. For more information, see Follow-up Tasks.
| Path | Accepts division header |
|---|---|
/engagements/{engagementId}/follow_up_tasks | Yes |
/engagements/{engagementId}/follow_up_tasks/{taskId} | Yes |
Inboxes
These are the inbox APIs that support divisions. For more information, see Inboxes.
| Path | Accepts division header |
|---|---|
/inboxes | Yes |
/inboxes/{inboxId} | Yes |
/inboxes/{inboxId}/email_notification | Yes |
/inboxes/{inboxId}/email_notifications | Yes |
/inboxes/{inboxId}/messages | Yes |
/inboxes/{inboxId}/messages/{messageId} | Yes |
/inboxes/{inboxId}/queues | Yes |
/inboxes/{inboxId}/users | Yes |
/inboxes/messages | Yes |
Logs
These are the log APIs that support divisions. For more information, see Logs.
| Path | Accepts division header |
|---|---|
/email/messages | Yes |
/messaging/messages | Yes |
/work_item/messages | Yes |
Notes
These are the note APIs that support divisions. For more information, see Notes.
| Path | Accepts division header |
|---|---|
/engagements/{engagementId}/notes | Yes |
/engagements/{engagementId}/notes/{noteId} | Yes |
/engagements/notes | Yes |
Operating Hours
These are the operating hours APIs that support divisions. For more information, see Operating Hours.
| Path | Accepts division header |
|---|---|
/business_hours | Yes |
/business_hours/{businessHourId} | Yes |
/business_hours/{businessHourId}/flows | Yes |
/business_hours/{businessHourId}/queues | Yes |
/closures | Yes |
/closures/{closureSetId} | Yes |
/closures/{closureSetId}/flows | Yes |
/closures/{closureSetId}/queues | Yes |
Queues
These are the queue APIs that support divisions. For more information, see Queues.
| Path | Accepts division header |
|---|---|
/queue_templates | Yes |
/queue_templates/{queueTemplateId} | Yes |
/queues | Yes |
/queues/{queueId} | Yes |
/queues/{queueId}/agents | Yes |
/queues/{queueId}/agents/{userId} | Yes |
/queues/{queueId}/dispositions | Yes |
/queues/{queueId}/dispositions/{dispositionId} | Yes |
/queues/{queueId}/dispositions/sets | Yes |
/queues/{queueId}/dispositions/sets/{dispositionSetId} | Yes |
/queues/{queueId}/interrupt | Yes |
/queues/{queueId}/interrupt_menu | Yes |
/queues/{queueId}/operating_hours | Yes |
/queues/{queueId}/recordings | Yes |
/queues/{queueId}/scheduled_callbacks/attendees/{attendeeId} | Yes |
/queues/{queueId}/scheduled_callbacks/supportive_slots | Yes |
/queues/{queueId}/supervisors | Yes |
/queues/{queueId}/supervisors/{userId} | Yes |
/queues/{queueId}/teams | Yes |
/queues/{queueId}/teams/{teamId} | Yes |
/queues/batch | Yes |
Recordings
These are the recording APIs that support divisions. For more information, see Recordings.
| Path | Accepts division header |
|---|---|
/engagements/{engagementId}/recordings | Yes |
/recordings | Yes |
/recordings/{recordingId} | Yes |
Regions
These are the region APIs that support divisions. For more information, see Regions.
| Path | Accepts division header |
|---|---|
/regions | Yes |
/regions/{regionId} | Yes |
/regions/{regionId}/users | Yes |
Reports V2 (CX Analytics)
These are the reporting APIs that support divisions. For more information, see Reports V2 (CX Analytics).
| Path | Accepts division header |
|---|---|
/reports/operation_logs | Yes |
Roles
These are the role APIs that support divisions. For more information, see Roles.
| Path | Accepts division header |
|---|---|
/roles | Yes |
/roles/{roleId} | Yes |
/roles/{roleId}/privileges | Yes |
/roles/{roleId}/users | Yes |
/roles/{roleId}/users/{userId} | Yes |
/roles/duplicate | Yes |
Routing Profiles
These are the routing profile APIs that support divisions. For more information, see Routing Profiles.
| Path | Accepts division header |
|---|---|
/agent_routing_profiles | Yes |
/agent_routing_profiles/{agentRoutingProfileId} | Yes |
/consumer_routing_profiles | Yes |
/consumer_routing_profiles/{consumerRoutingProfileId} | Yes |
Skills
These are the skill APIs that support divisions. For more information, see Skills.
| Path | Accepts division header |
|---|---|
/skills | Yes |
/skills/{skillId} | Yes |
/skills/{skillId}/users | Yes |
/skills/categories | Yes |
/skills/categories/{skillCategoryId} | Yes |
Teams
These are the team APIs that support divisions. For more information, see Teams.
| Path | Accepts division header |
|---|---|
/teams | Yes |
/teams/{teamId} | Yes |
/teams/{teamId}/agents | Yes |
/teams/{teamId}/children | Yes |
/teams/{teamId}/move | Yes |
/teams/{teamId}/parents | Yes |
/teams/{teamId}/supervisors | Yes |
Users
These are the user APIs that support divisions. For more information, see Users.
| Path | Accepts division header |
|---|---|
/users | Yes |
/users/{userId} | Yes |
/users/{userId}/opt_in_out_queues | Yes |
/users/{userId}/queues | Yes |
/users/{userId}/recordings | Yes |
/users/{userId}/skills | Yes |
/users/{userId}/skills/{skillId} | Yes |
/users/{userId}/status | Yes |
/users/batch | Yes |
/users/status | Yes |
/users/templates | Yes |
/users/templates/{templateId} | Yes |
Variables
These are the variable APIs that support divisions. For more information, see Variables.
| Path | Accepts division header |
|---|---|
/variable_logs | Yes |
/variable_logs/{variableLogId} | Yes |
/variables | Yes |
/variables/{variableId} | Yes |
/variables/groups | Yes |
/variables/groups/{variableGroupId} | Yes |