Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Oauth Grant Type Tokens API

2 actions 2 updates phrasing extends openapi/zendesk-grant-type-tokens-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['/oauth/tokens'].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 Oauth Grant Type Tokens API
  version: 1.0.0
extends: openapi/zendesk-grant-type-tokens-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['/oauth/tokens'].post
  update:
    x-apievangelist-phrasing:
      intent: Exchange a grant for an OAuth access token
      effect: write
      questions:
      - How do I exchange an authorization code for a Zendesk OAuth access token?
      - How long is an authorization code valid before I must trade it for a token?
      - Is the password grant type still recommended for getting a token?
      instructions:
      - text: Exchange this authorization code for an OAuth access token.
      - text: Trade the code my redirect just received for a token before its 120 seconds run out.
      method: generated
      generated: '2026-09-26'