Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Organization Fields API

7 actions 7 updates phrasing extends openapi/zendesk-organization-fields-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 7

$.info

$.paths['/api/v2/organization_fields'].get

$.paths['/api/v2/organization_fields'].post

$.paths['/api/v2/organization_fields/{organization_field_id}'].get

$.paths['/api/v2/organization_fields/{organization_field_id}'].put

$.paths['/api/v2/organization_fields/{organization_field_id}'].delete

$.paths['/api/v2/organization_fields/reorder'].put

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 Organization Fields API
  version: 1.0.0
extends: openapi/zendesk-organization-fields-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: 6
- target: $.paths['/api/v2/organization_fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom organization fields
      effect: read
      questions:
      - What custom fields exist on organizations?
      - Should I cache the organization field list?
      instructions:
      - text: List the custom organization fields.
      - text: Show every custom field on organization records.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/organization_fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom organization field
      effect: write
      questions:
      - Can I add a field like contract tier to organizations?
      - Which field types can a new organization field use?
      instructions:
      - text: Create an organization field called Contract Tier.
      - text: Add a dropdown field to organizations for region.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/organization_fields/{organization_field_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom organization field
      effect: read
      questions:
      - Where can I see one organization field's configuration?
      - Can agents look up an organization field definition?
      instructions:
      - text: Show this organization field.
      - text: Get the Contract Tier organization field.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/organization_fields/{organization_field_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom organization field
      effect: write
      questions:
      - Can I change dropdown options on an organization field?
      - What happens to existing choices when I update an organization dropdown?
      instructions:
      - text: Update this organization field's title.
      - text: Replace the options on the region organization field.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/organization_fields/{organization_field_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom organization field
      effect: destructive
      questions:
      - Can I remove an organization field entirely?
      - Is deleting an organization field limited to admins?
      instructions:
      - text: Delete this organization field.
      - text: Remove the unused Contract Tier organization field.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/organization_fields/reorder'].put
  update:
    x-apievangelist-phrasing:
      intent: Reorder custom organization fields
      effect: write
      questions:
      - Can I change the order organization fields appear in?
      - Who can reorder organization fields?
      instructions:
      - text: Reorder the organization fields into this sequence.
      - text: Move the region field to the top of organization fields.
      method: generated
      generated: '2026-09-26'