Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Queues Omnichannel Routing Queues API

8 actions 8 updates phrasing extends openapi/zendesk-omnichannel-routing-queues-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Zendesk's API. It is a proposal applied on top of the contract, not a document Zendesk publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info

$.paths['/api/v2/queues'].get

$.paths['/api/v2/queues'].post

$.paths['/api/v2/queues/{queue_id}'].get

$.paths['/api/v2/queues/{queue_id}'].put

$.paths['/api/v2/queues/{queue_id}'].delete

$.paths['/api/v2/queues/definitions'].get

$.paths['/api/v2/queues/order'].patch

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Zendesk Queues Omnichannel Routing Queues API
  version: 1.0.0
extends: openapi/zendesk-omnichannel-routing-queues-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/api/v2/queues'].get
  update:
    x-apievangelist-phrasing:
      intent: List routing queues
      effect: read
      questions:
      - What omnichannel routing queues are active in my account?
      - Can I see all my routing queues?
      instructions:
      - text: List all routing queues.
      - text: Show every active omnichannel queue.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/queues'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a routing queue
      effect: write
      questions:
      - Can I create a new omnichannel routing queue?
      - What goes into a queue definition?
      instructions:
      - text: Create a routing queue for VIP customers.
      - text: Add a new queue from this definition.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/queues/{queue_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a routing queue
      effect: read
      questions:
      - How do I look up one routing queue's definition?
      - Can agents view a specific queue?
      instructions:
      - text: Show this routing queue.
      - text: Get one queue's definition.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/queues/{queue_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a routing queue
      effect: write
      questions:
      - Can I change the conditions or groups of a routing queue?
      - Who is allowed to update a queue?
      instructions:
      - text: Update this queue to route to a different group.
      - text: Change the definition of one routing queue.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/queues/{queue_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a routing queue
      effect: destructive
      questions:
      - Can I delete a routing queue and its related records?
      - Is deleting a queue reversible?
      instructions:
      - text: Delete this routing queue.
      - text: Remove one queue and its related records.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/queues/definitions'].get
  update:
    x-apievangelist-phrasing:
      intent: Get queue condition definitions
      effect: read
      questions:
      - What conditions can a routing queue use?
      - Where do I find the allowed values for queue conditions?
      instructions:
      - text: Get the queue and condition definitions.
      - text: Show what conditions a queue can evaluate.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/queues/order'].patch
  update:
    x-apievangelist-phrasing:
      intent: Reorder routing queues
      effect: write
      questions:
      - Can I change the order routing queues are evaluated in?
      - Do I have to include every queue id when reordering?
      instructions:
      - text: Reorder the routing queues in this sequence.
      - text: Move the VIP queue to be evaluated first.
      method: generated
      generated: '2026-09-26'