Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Tickets Ticket Import API

3 actions 3 updates phrasing extends openapi/zendesk-ticket-import-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 3

$.info

$.paths['/api/v2/imports/tickets'].post

$.paths['/api/v2/imports/tickets/create_many'].post

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 Tickets Ticket Import API
  version: 1.0.0
extends: openapi/zendesk-ticket-import-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: 2
- target: $.paths['/api/v2/imports/tickets'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a historical ticket
      effect: write
      questions:
      - Can I import an old ticket from another system with its original dates?
      - Who is allowed to import tickets?
      instructions:
      - text: Import this historical ticket with its comments.
      - text: Bring over one legacy ticket with its original timestamps.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/imports/tickets/create_many'].post
  update:
    x-apievangelist-phrasing:
      intent: Import up to 100 historical tickets
      effect: write
      questions:
      - Can I import a batch of legacy tickets at once?
      - What is the maximum number of tickets per bulk import?
      instructions:
      - text: Bulk import these 100 legacy tickets.
      - text: Import this batch of historical tickets in one request.
      method: generated
      generated: '2026-09-26'