Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Groups API

8 actions 8 updates phrasing extends openapi/zendesk-groups-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/groups'].get
$.paths['/api/v2/groups'].post
$.paths['/api/v2/groups/{group_id}'].get
$.paths['/api/v2/groups/{group_id}'].put
$.paths['/api/v2/groups/{group_id}'].delete
$.paths['/api/v2/groups/assignable'].get
$.paths['/api/v2/groups/count'].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 Groups API
  version: 1.0.0
extends: openapi/zendesk-groups-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/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List agent groups
      effect: read
      questions:
      - What agent groups exist in my help desk?
      - How many groups come back per page when listing them?
      instructions:
      - text: List all the agent groups in the account.
      - text: Show every support group with cursor pagination.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an agent group
      effect: write
      questions:
      - How do I set up a new team of agents such as Billing or Tier 2?
      - Can agents with a custom role create groups?
      instructions:
      - text: Create a new agent group called Billing.
      - text: Add a support group for my escalations team.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/groups/{group_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a group
      effect: read
      questions:
      - Can I fetch the details of a single agent group?
      - What information is stored on one support group?
      instructions:
      - text: Show the group with that group ID.
      - text: Fetch the details of one agent group.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/groups/{group_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a group
      effect: write
      questions:
      - Can I rename an existing agent group?
      - Who is allowed to edit a group's settings?
      instructions:
      - text: Rename that agent group to Premium Support.
      - text: Update the settings of one existing group.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/groups/{group_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a group
      effect: destructive
      questions:
      - Can I delete an agent group I no longer use?
      - Which roles are allowed to remove groups?
      instructions:
      - text: Delete that agent group.
      - text: Remove the unused support group from the account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/groups/assignable'].get
  update:
    x-apievangelist-phrasing:
      intent: List groups tickets can be assigned to
      effect: read
      questions:
      - Which groups can tickets actually be assigned to?
      - Can I list only the assignable groups rather than all groups?
      instructions:
      - text: List the groups that tickets can be assigned to.
      - text: Show only assignable groups for my ticket routing.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/groups/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count groups
      effect: read
      questions:
      - How many agent groups does my account have?
      - When was the group count last refreshed?
      instructions:
      - text: Count the groups in the account.
      - text: Give me the approximate number of agent groups.
      method: generated
      generated: '2026-09-26'