Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Tickets Conversation Log API

2 actions 2 updates phrasing extends openapi/zendesk-conversation-log-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 2

$.info
$.paths['/api/v2/tickets/{ticket_id}/conversation_log'].get

OpenAPI Overlay

Raw ↑ 
# 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 Conversation Log API
  version: 1.0.0
extends: openapi/zendesk-conversation-log-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: 1
- target: $.paths['/api/v2/tickets/{ticket_id}/conversation_log'].get
  update:
    x-apievangelist-phrasing:
      intent: List a ticket's conversation log
      effect: read
      questions:
      - Can I see the full conversation log of events for a ticket?
      - How many conversation log events come back per page?
      instructions:
      - text: List the conversation log events for the ticket.
      - text: Show the messaging conversation history on that ticket.
      method: generated
      generated: '2026-09-26'