Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Account Reseller API

3 actions 3 updates phrasing extends openapi/zendesk-reseller-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/accounts'].post

$.paths['/api/v2/accounts/available'].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 Account Reseller API
  version: 1.0.0
extends: openapi/zendesk-reseller-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/accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a trial account
      effect: write
      questions:
      - Can a reseller spin up a new trial help desk account?
      - What is needed to create a trial account for a customer?
      instructions:
      - text: Create a trial account for this customer.
      - text: Start a new trial help desk for Acme.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/accounts/available'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether a subdomain is available
      effect: read
      questions:
      - Is a subdomain still free to use for a new account?
      - Do I need credentials to check subdomain availability?
      instructions:
      - text: Check if the subdomain {subdomain} is available.
        slots:
          subdomain: query.subdomain
      - text: See whether {subdomain} is taken.
        slots:
          subdomain: query.subdomain
      method: generated
      generated: '2026-09-26'