Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Satisfaction Reasons API

3 actions 3 updates phrasing extends openapi/zendesk-satisfaction-reasons-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/satisfaction_reasons'].get

$.paths['/api/v2/satisfaction_reasons/{satisfaction_reason_id}'].get

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 Satisfaction Reasons API
  version: 1.0.0
extends: openapi/zendesk-satisfaction-reasons-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/satisfaction_reasons'].get
  update:
    x-apievangelist-phrasing:
      intent: List satisfaction rating reasons
      effect: read
      questions:
      - What reasons can customers pick when they give a bad satisfaction rating?
      - Where can I see all the CSAT reasons configured for our account?
      instructions:
      - text: List all satisfaction reasons for the account.
      - text: Show the reasons customers can choose when rating us poorly.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/satisfaction_reasons/{satisfaction_reason_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one satisfaction reason
      effect: read
      questions:
      - How do I look up a single satisfaction reason by its id?
      - What text and value does a specific CSAT reason have?
      instructions:
      - text: Show satisfaction reason {satisfaction_reason_id}.
        slots:
          satisfaction_reason_id: path.satisfaction_reason_id
      - text: Get the details of CSAT reason {satisfaction_reason_id}.
        slots:
          satisfaction_reason_id: path.satisfaction_reason_id
      method: generated
      generated: '2026-09-26'