Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Suspended Tickets API

9 actions 9 updates phrasing extends openapi/zendesk-suspended-tickets-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 9

$.info

$.paths['/api/v2/suspended_tickets/attachments'].post

$.paths['/api/v2/suspended_tickets'].get

$.paths['/api/v2/suspended_tickets/{id}'].get

$.paths['/api/v2/suspended_tickets/{id}'].delete

$.paths['/api/v2/suspended_tickets/{id}/recover'].put

$.paths['/api/v2/suspended_tickets/destroy_many'].delete

$.paths['/api/v2/suspended_tickets/export'].post

$.paths['/api/v2/suspended_tickets/recover_many'].put

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Zendesk Suspended Tickets API
  version: 1.0.0
extends: openapi/zendesk-suspended-tickets-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: 8
- target: $.paths['/api/v2/suspended_tickets/attachments'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy a suspended ticket's attachments
      effect: write
      questions:
      - Can I keep the attachments from a suspended ticket when I recover it manually?
      - How do I get attachment tokens for files on a suspended ticket?
      instructions:
      - text: Copy the attachments on this suspended ticket as upload tokens.
      - text: Make attachment tokens from a suspended ticket's files.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/suspended_tickets'].get
  update:
    x-apievangelist-phrasing:
      intent: List suspended tickets
      effect: read
      questions:
      - Which incoming emails were suspended instead of becoming tickets?
      - Can I see everything in the suspended tickets queue?
      instructions:
      - text: List all suspended tickets.
      - text: Show the suspended ticket queue.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/suspended_tickets/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a suspended ticket
      effect: read
      questions:
      - Why was a particular ticket suspended?
      - Can I view the details of one suspended ticket?
      instructions:
      - text: Show this suspended ticket and its suspension cause.
      - text: Get the details of one suspended ticket.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/suspended_tickets/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a suspended ticket
      effect: destructive
      questions:
      - Can I delete a single suspended ticket that's spam?
      - Who is allowed to delete a suspended ticket?
      instructions:
      - text: Delete this suspended ticket.
      - text: Discard one spam suspended ticket.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/suspended_tickets/{id}/recover'].put
  update:
    x-apievangelist-phrasing:
      intent: Recover a suspended ticket
      effect: write
      questions:
      - Can I turn a suspended ticket back into a normal ticket?
      - Who becomes the requester when I recover a suspended ticket?
      instructions:
      - text: Recover this suspended ticket.
      - text: Restore one suspended ticket to the ticket queue.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/suspended_tickets/destroy_many'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete many suspended tickets
      effect: destructive
      questions:
      - Can I bulk delete up to 100 suspended tickets?
      - Do I pass ticket ids or suspended ids to delete suspended tickets in bulk?
      instructions:
      - text: Bulk delete these suspended tickets.
      - text: Clear up to 100 suspended tickets in one call.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/suspended_tickets/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export suspended tickets to CSV
      effect: read
      questions:
      - Can I export the suspended tickets list to a CSV file?
      - How do I receive a suspended tickets export?
      instructions:
      - text: Export all suspended tickets to CSV.
      - text: Start a CSV export of the suspended ticket queue and email it to me.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/suspended_tickets/recover_many'].put
  update:
    x-apievangelist-phrasing:
      intent: Recover many suspended tickets
      effect: write
      questions:
      - Can I recover a batch of suspended tickets at once?
      - What happens to suspended tickets that fail to recover in bulk?
      instructions:
      - text: Recover these suspended tickets in bulk.
      - text: Restore up to 100 suspended tickets in one request.
      method: generated
      generated: '2026-09-26'