Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Organization Subscriptions API

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

$.info

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

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

$.paths['/api/v2/organization_subscriptions/{organization_subscription_id}'].get

$.paths['/api/v2/organization_subscriptions/{organization_subscription_id}'].delete

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 Subscriptions API
  version: 1.0.0
extends: openapi/zendesk-organization-subscriptions-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: 4
- target: $.paths['/api/v2/organization_subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List organization subscriptions
      effect: read
      questions:
      - Who is subscribed to updates on organizations?
      - As an end user, which organizations am I following?
      instructions:
      - text: List all organization subscriptions.
      - text: Show the organizations I'm subscribed to.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/organization_subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to an organization's tickets
      effect: write
      questions:
      - How do I follow an organization so I get notified about its tickets?
      - Can end users subscribe to a shared organization they belong to?
      instructions:
      - text: Subscribe me to the Acme Corp organization.
      - text: Create an organization subscription for this user on their shared org.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/organization_subscriptions/{organization_subscription_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization subscription
      effect: read
      questions:
      - How do I look up one organization subscription?
      - Which user and organization does a given subscription link?
      instructions:
      - text: Show that organization subscription.
      - text: Get the details of this org subscription record.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/organization_subscriptions/{organization_subscription_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe from an organization
      effect: destructive
      questions:
      - How do I stop following an organization?
      - Can an end user cancel their own organization subscription?
      instructions:
      - text: Unsubscribe me from the Acme Corp organization.
      - text: Delete that organization subscription.
      method: generated
      generated: '2026-09-26'