Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Assignee Field Assignable Agents API

4 actions 4 updates phrasing extends openapi/zendesk-assigneefieldassignableagents-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 4

$.info
$.paths['/api/lotus/assignables/autocomplete.json'].get
$.paths['/api/lotus/assignables/groups.json'].get
$.paths['/api/lotus/assignables/groups/{group_id}/agents.json'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Zendesk Assignee Field Assignable Agents API
  version: 1.0.0
extends: openapi/zendesk-assigneefieldassignableagents-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: 3
- target: $.paths['/api/lotus/assignables/autocomplete.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Search assignable groups and agents
      effect: read
      questions:
      - Can I search assignable agents and groups by name?
      - Which agents or groups match a name I type in the assignee field?
      instructions:
      - text: Search assignable groups and agents named Maria.
      - text: Find assignees whose name matches a keyword.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/lotus/assignables/groups.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List assignable groups
      effect: read
      questions:
      - Which groups can tickets be assigned to?
      - Can I list the groups shown in the assignee field?
      instructions:
      - text: List assignable groups.
      - text: Show all groups in the assignee field.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/lotus/assignables/groups/{group_id}/agents.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List assignable agents in a group
      effect: read
      questions:
      - Which agents in a group can be assigned tickets?
      - Can I list the assignable members of one group?
      instructions:
      - text: List assignable agents in this group.
      - text: Show which agents in one group can take tickets.
      method: generated
      generated: '2026-09-26'