Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Ticket Content Pins API

4 actions 4 updates phrasing extends openapi/zendesk-ticket-content-pins-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 4

$.info
$.paths['/api/v2/ticket_content_pins'].get
$.paths['/api/v2/ticket_content_pins'].post
$.paths['/api/v2/ticket_content_pins/{content_pin_id}'].delete

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 Ticket Content Pins API
  version: 1.0.0
extends: openapi/zendesk-ticket-content-pins-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: 3
- target: $.paths['/api/v2/ticket_content_pins'].get
  update:
    x-apievangelist-phrasing:
      intent: List a ticket's content pins
      effect: read
      questions:
      - Which articles have been pinned to a ticket for quick access?
      - Can I see the content pinned to one ticket?
      instructions:
      - text: List the content pins on ticket {ticket_id}.
        slots:
          ticket_id: query.ticket_id
      - text: Show the articles pinned to ticket {ticket_id}.
        slots:
          ticket_id: query.ticket_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/ticket_content_pins'].post
  update:
    x-apievangelist-phrasing:
      intent: Pin content to a ticket
      effect: write
      questions:
      - How do I pin a help center article to a ticket?
      - Can I pin a community post or external link to a ticket?
      instructions:
      - text: Pin {ticket_content_pin} to the ticket.
        slots:
          ticket_content_pin: requestBody.ticket_content_pin
      - text: Attach this knowledge base article as a content pin on the ticket.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/ticket_content_pins/{content_pin_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a content pin from a ticket
      effect: destructive
      questions:
      - Can I unpin an article from a ticket?
      - Which call deletes a content pin?
      instructions:
      - text: Delete content pin {content_pin_id}.
        slots:
          content_pin_id: path.content_pin_id
      - text: Unpin {content_pin_id} from its ticket.
        slots:
          content_pin_id: path.content_pin_id
      method: generated
      generated: '2026-09-26'