Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Account Account Settings API

3 actions 3 updates phrasing extends openapi/zendesk-account-settings-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/account/settings'].get
$.paths['/api/v2/account/settings'].put

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 Account Account Settings API
  version: 1.0.0
extends: openapi/zendesk-account-settings-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/account/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: View account settings
      effect: read
      questions:
      - What settings are enabled on our Zendesk account?
      - Can an agent read the account-level configuration?
      instructions:
      - text: Show our account settings.
      - text: Get the current account configuration so I can check which features are on.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/account/settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Change account settings
      effect: write
      questions:
      - How do I change an account-wide setting through the API?
      - Which account settings can an admin update?
      instructions:
      - text: Update our account settings to turn on the setting I name.
      - text: Change the account-level ticket settings as described.
      method: generated
      generated: '2026-09-26'