Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Organization Memberships API

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

$.info
$.paths['/api/v2/organization_memberships'].get
$.paths['/api/v2/organization_memberships'].post
$.paths['/api/v2/organization_memberships/{organization_membership_id}'].get
$.paths['/api/v2/organization_memberships/{organization_membership_id}'].delete
$.paths['/api/v2/organization_memberships/create_many'].post
$.paths['/api/v2/organization_memberships/destroy_many'].delete
$.paths['/api/v2/users/{user_id}/organization_memberships/{organization_membership_id}/make_default'].put
$.paths['/api/v2/users/{user_id}/organizations/{organization_id}'].delete
$.paths['/api/v2/users/{user_id}/organizations/{organization_id}/make_default'].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 Organization Memberships API
  version: 1.0.0
extends: openapi/zendesk-organization-memberships-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: 9
- target: $.paths['/api/v2/organization_memberships'].get
  update:
    x-apievangelist-phrasing:
      intent: List organization memberships
      effect: read
      questions:
      - Which organizations does each user in my account belong to?
      - In what order are a user's organization memberships returned?
      instructions:
      - text: List the organization memberships in the account.
      - text: Show all user-to-organization memberships, default organization first.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/organization_memberships'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a user to an organization
      effect: write
      questions:
      - How do I assign a user to an organization?
      - What error comes back if the user is already in that organization?
      instructions:
      - text: Add this user to the given organization.
      - text: Create one organization membership for a customer.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/organization_memberships/{organization_membership_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show an organization membership
      effect: read
      questions:
      - Can I look up a single organization membership by its ID?
      - What does one membership record between a user and an organization contain?
      instructions:
      - text: Show the organization membership with that membership ID.
      - text: Fetch one user-organization membership record.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/organization_memberships/{organization_membership_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an organization membership
      effect: destructive
      questions:
      - What happens to a user's working tickets when I remove their organization membership?
      - Can I delete a single membership by its membership ID?
      instructions:
      - text: Delete that organization membership by its membership ID.
      - text: Remove the membership and unassign the user's working tickets for that organization.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/organization_memberships/create_many'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk create organization memberships
      effect: write
      questions:
      - Can I add up to 100 users to organizations in one job?
      - How do I track a bulk membership creation after it is queued?
      instructions:
      - text: Bulk create these organization memberships as a background job.
      - text: Assign many users to their organizations at once.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/organization_memberships/destroy_many'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk remove organization memberships
      effect: destructive
      questions:
      - Can I remove several organization memberships in one request?
      - Are working tickets unassigned when memberships are removed in bulk?
      instructions:
      - text: Delete the organization memberships {ids}.
        slots:
          ids: query.ids
      - text: Bulk remove memberships {ids} and unassign their working tickets.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/users/{user_id}/organization_memberships/{organization_membership_id}/make_default'].put
  update:
    x-apievangelist-phrasing:
      intent: Make a membership the user's default
      effect: write
      questions:
      - Can I choose which membership is a user's default using the membership ID?
      - Are agents allowed to set the default membership for an end user?
      instructions:
      - text: Make that organization membership the user's default, by membership ID.
      - text: Set a user's default membership using the membership record.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/users/{user_id}/organizations/{organization_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from an organization
      effect: destructive
      questions:
      - Can I take a user out of a specific organization using the user and organization IDs?
      - Does unassigning a user from an organization affect their open tickets?
      instructions:
      - text: Unassign the user from that organization by user ID and organization ID.
      - text: Take this customer out of the organization they belong to.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/users/{user_id}/organizations/{organization_id}/make_default'].put
  update:
    x-apievangelist-phrasing:
      intent: Make an organization the user's default
      effect: write
      questions:
      - Can I set a user's default organization by pointing at the organization ID?
      - Which call makes a given organization primary for a user?
      instructions:
      - text: Switch the customer's default to the organization with that organization ID.
      - text: Set the customer's primary organization.
      method: generated
      generated: '2026-09-26'