# 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 Forms API
  version: 1.0.0
extends: openapi/zendesk-ticket-forms-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: 12
- target: $.paths['/api/v2/ticket_forms'].get
  update:
    x-apievangelist-phrasing:
      intent: List ticket forms
      effect: read
      questions:
      - What ticket forms exist in my Zendesk account?
      - Can I list only the ticket forms end users can see?
      instructions:
      - text: List all ticket forms.
      - text: List ticket forms where active is {active} and end-user visible is {end_user_visible}.
        slots:
          active: query.active
          end_user_visible: query.end_user_visible
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/ticket_forms'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a ticket form
      effect: write
      questions:
      - Can I create a new ticket form with its own set of fields?
      - Who is allowed to create ticket forms?
      instructions:
      - text: Create a ticket form for billing requests.
      - text: Add a new ticket form with these fields.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/ticket_forms/{ticket_form_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a ticket form
      effect: read
      questions:
      - How do I see the fields and settings of one ticket form?
      - Can end users look up a single ticket form?
      instructions:
      - text: Show this ticket form.
      - text: Get the details of one ticket form by id.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/ticket_forms/{ticket_form_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a ticket form
      effect: write
      questions:
      - Can I change the name or fields of an existing ticket form?
      - Is it possible to hide a ticket form from end users?
      instructions:
      - text: Update this ticket form to add a new field.
      - text: Rename one ticket form.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/ticket_forms/{ticket_form_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a ticket form
      effect: destructive
      questions:
      - Can I delete a ticket form I don't use anymore?
      - Who has permission to remove ticket forms?
      instructions:
      - text: Delete this ticket form.
      - text: Remove the unused ticket form.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/ticket_forms/{ticket_form_id}/clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone a ticket form
      effect: write
      questions:
      - Can I duplicate an existing ticket form as a starting point?
      - Is there a way to copy a ticket form?
      instructions:
      - text: Clone this ticket form.
      - text: Make a copy of the existing ticket form.
      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 a ticket form's status associations
      effect: read
      questions:
      - Which ticket statuses are associated with a ticket form?
      - Can I see the custom statuses linked to one form?
      instructions:
      - text: List the ticket statuses associated with this form.
      - text: Show which statuses are linked to one ticket 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 update a form's status associations
      effect: write
      questions:
      - Can I add and remove status associations on a form in one call?
      - Is there a bulk operation for a ticket form's statuses?
      instructions:
      - text: Update the status associations for this ticket form in bulk.
      - text: Add and remove several statuses on one form at once.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/ticket_forms/{ticket_form_id}/ticket_form_statuses'].post
  update:
    x-apievangelist-phrasing:
      intent: Link statuses to a ticket form
      effect: write
      questions:
      - How can I associate new ticket statuses with a form?
      - Can I create several form status associations at once?
      instructions:
      - text: Associate these ticket statuses with the form.
      - text: Link new statuses to one 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 or delete a single status association on a form?
      - What's the way to edit one ticket form status link by its id?
      instructions:
      - text: Update this single ticket form status association.
      - text: Change one status link on the form by its association id.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/ticket_forms/reorder'].put
  update:
    x-apievangelist-phrasing:
      intent: Reorder ticket forms
      effect: write
      questions:
      - Can I change the order ticket forms appear in?
      - What do I pass to set the ticket form order?
      instructions:
      - text: Reorder the ticket forms in this sequence.
      - text: Put the billing form first in the ticket form order.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/ticket_forms/show_many'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several ticket forms by id
      effect: read
      questions:
      - Can I fetch up to 100 ticket forms by id in one request?
      - Which endpoint does the web widget use to load several forms?
      instructions:
      - text: Show the ticket forms {ids}.
        slots:
          ids: query.ids
      - text: Fetch ticket forms {ids} where active is {active}.
        slots:
          ids: query.ids
          active: query.active
      method: generated
      generated: '2026-09-26'