Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Brand Agents API

3 actions 3 updates phrasing extends openapi/zendesk-brand-agents-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/brand_agents'].get

$.paths['/api/v2/brand_agents/{brand_agent_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 Brand Agents API
  version: 1.0.0
extends: openapi/zendesk-brand-agents-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/brand_agents'].get
  update:
    x-apievangelist-phrasing:
      intent: List brand agent memberships
      effect: read
      questions:
      - Which agents belong to which brands?
      - Can I list all brand agent memberships?
      instructions:
      - text: List all brand agent memberships.
      - text: Show which agents are assigned to each brand.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/brand_agents/{brand_agent_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a brand agent membership
      effect: read
      questions:
      - How do I look up one brand agent membership by id?
      - Can I see a single agent's brand membership?
      instructions:
      - text: Show this brand agent membership.
      - text: Get one brand membership by id.
      method: generated
      generated: '2026-09-26'