# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Zendesk Custom Ticket Statuses API
  version: 1.0.0
extends: openapi/zendesk-custom-ticket-statuses-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: 6
- target: $.paths['/api/v2/custom_status/default'].put
  update:
    x-apievangelist-phrasing:
      intent: Set default custom statuses in bulk
      effect: write
      questions:
      - Can I change which custom status is the default for several categories at once?
      - Is there a bulk way to update default ticket statuses?
      instructions:
      - text: Update the default custom statuses in one request.
      - text: Make these custom statuses the defaults for their categories.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_statuses'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom ticket statuses
      effect: read
      questions:
      - What custom ticket statuses does my account have?
      - Can I filter custom statuses to only active ones or a category like pending?
      instructions:
      - text: List custom statuses in the {status_categories} category.
        slots:
          status_categories: query.status_categories
      - text: Show custom statuses where active is {active}.
        slots:
          active: query.active
      - text: 'List only default custom statuses: {default}.'
        slots:
          default: query.default
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_statuses'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom ticket status
      effect: write
      questions:
      - Can I add a status like Waiting on Vendor to tickets?
      - Who can create a custom ticket status?
      instructions:
      - text: Create a custom status called Waiting on Vendor under pending.
      - text: Add a new custom ticket status for escalated tickets.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_statuses/{custom_status_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom ticket status
      effect: read
      questions:
      - Where can I see the details of one custom status?
      - Can end users read a custom ticket status?
      instructions:
      - text: Show this custom ticket status.
      - text: Get the Waiting on Vendor status.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_statuses/{custom_status_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom ticket status
      effect: write
      questions:
      - Can I rename a custom ticket status?
      - Can I deactivate a custom status without deleting it?
      instructions:
      - text: Rename this custom status.
      - text: Deactivate the Waiting on Vendor custom status.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_statuses/{custom_status_id}/ticket_form_statuses'].post
  update:
    x-apievangelist-phrasing:
      intent: Link a custom status to ticket forms
      effect: write
      questions:
      - Can I make a custom status available on specific ticket forms?
      - Can one custom status be associated with several ticket forms at once?
      instructions:
      - text: Associate this custom status with forms {ticket_form_status}.
        slots:
          ticket_form_status: requestBody.ticket_form_status
      - text: Add ticket form status links {ticket_form_status} for the custom status.
        slots:
          ticket_form_status: requestBody.ticket_form_status
      method: generated
      generated: '2026-09-26'