# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Zendesk Ticket Form Statuses API
  version: 1.0.0
extends: openapi/zendesk-ticket-form-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: 9
- 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:
      - How do I make a custom status available on several ticket forms at once?
      - Can I associate one custom ticket status with multiple forms?
      instructions:
      - text: Associate the Waiting on Vendor custom status with forms {ticket_form_status}.
        slots:
          ticket_form_status: requestBody.ticket_form_status
      - text: Add this custom status to our Billing and Returns forms.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/ticket_form_statuses'].get
  update:
    x-apievangelist-phrasing:
      intent: List all ticket form status associations
      effect: read
      questions:
      - Which custom statuses are enabled on which ticket forms across the account?
      - Where can I see every form-to-status association?
      instructions:
      - text: List every ticket form status association in the account.
      - text: Show all mappings between ticket forms and custom statuses.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/ticket_form_statuses/show_many'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several ticket form statuses by id
      effect: read
      questions:
      - Can I fetch specific ticket form status associations by a list of ids?
      - Is there a batch lookup for form status mappings?
      instructions:
      - text: Get ticket form statuses {ids}.
        slots:
          ids: query.ids
      - text: Show the form status associations with ids {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/ticket_forms/{ticket_form_id}/ticket_form_statuses'].get
  update:
    x-apievangelist-phrasing:
      intent: List statuses enabled on one ticket form
      effect: read
      questions:
      - Which custom statuses can agents pick on a particular ticket form?
      - How do I see the statuses associated with one form?
      instructions:
      - text: List the statuses associated with the Returns ticket form.
      - text: Show which custom statuses are enabled on that form.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/ticket_forms/{ticket_form_id}/ticket_form_statuses'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk add and remove statuses on a form
      effect: write
      questions:
      - Can I add and remove several statuses on a ticket form in a single call?
      - How do I bulk change which statuses a form offers?
      instructions:
      - text: On the Billing form, add Pending Refund and remove On Hold in one bulk update.
      - text: Bulk update the status associations on that ticket form.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/ticket_forms/{ticket_form_id}/ticket_form_statuses'].post
  update:
    x-apievangelist-phrasing:
      intent: Add statuses to a ticket form
      effect: write
      questions:
      - How do I enable new custom statuses on a specific ticket form?
      - Can I create several status associations for one form at once?
      instructions:
      - text: Enable the Awaiting Parts status on the Repairs ticket form.
      - text: Create status associations for that form.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/ticket_forms/{ticket_form_id}/ticket_form_statuses'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove statuses from a ticket form
      effect: destructive
      questions:
      - Can I remove several status associations from a form by id?
      - How do I stop a group of statuses from appearing on a ticket form?
      instructions:
      - text: Delete ticket form status associations {id} from this form.
        slots:
          id: requestBody.id
      - text: Remove those statuses from the Repairs ticket form.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/ticket_forms/{ticket_form_id}/ticket_form_statuses/{ticket_form_status_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one form status association
      effect: write
      questions:
      - Can I change a single ticket form status association by its id?
      - How do I edit just one status mapping on a form?
      instructions:
      - text: Update that single ticket form status association.
      - text: Change one status mapping on the Billing form by its id.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/ticket_forms/{ticket_form_id}/ticket_form_statuses/{ticket_form_status_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one form status association
      effect: destructive
      questions:
      - How do I remove just one status from a ticket form?
      - Can I delete a single form status association by id?
      instructions:
      - text: Delete that one ticket form status association.
      - text: Remove the On Hold status mapping from the Billing form.
      method: generated
      generated: '2026-09-26'