Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Group Memberships API

9 actions 9 updates phrasing extends openapi/zendesk-group-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 9

$.info

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

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

$.paths['/api/v2/group_memberships/{group_membership_id}'].get

$.paths['/api/v2/group_memberships/{group_membership_id}'].delete

$.paths['/api/v2/group_memberships/assignable'].get

$.paths['/api/v2/group_memberships/create_many'].post

$.paths['/api/v2/group_memberships/destroy_many'].delete

$.paths['/api/v2/users/{user_id}/group_memberships/{group_membership_id}/make_default'].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 Group Memberships API
  version: 1.0.0
extends: openapi/zendesk-group-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: 8
- target: $.paths['/api/v2/group_memberships'].get
  update:
    x-apievangelist-phrasing:
      intent: List group memberships
      effect: read
      questions:
      - Which agents belong to which groups?
      - Can I page through every group membership in my account?
      instructions:
      - text: List all group memberships.
      - text: Show which agents are in which groups.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/group_memberships'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an agent to a group
      effect: write
      questions:
      - Can I assign an agent to a support group?
      - Who is allowed to add agents to groups?
      instructions:
      - text: Add this agent to the Billing group.
      - text: Create a group membership for the new hire in Tier 1.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/group_memberships/{group_membership_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a group membership
      effect: read
      questions:
      - Is a group membership id the same as a group id?
      - Can I look up one specific membership record?
      instructions:
      - text: Show this group membership.
      - text: Get the details of that membership record.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/group_memberships/{group_membership_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an agent from a group
      effect: destructive
      questions:
      - What happens to an agent's tickets when they leave a group?
      - Can I take one agent out of a group immediately?
      instructions:
      - text: Remove this agent from the group.
      - text: Delete that group membership and unassign the agent's working tickets.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/group_memberships/assignable'].get
  update:
    x-apievangelist-phrasing:
      intent: List assignable group memberships
      effect: read
      questions:
      - Which group memberships can tickets actually be assigned to?
      - Can I list only memberships that are assignable?
      instructions:
      - text: List assignable group memberships.
      - text: Show memberships where tickets can be assigned.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/group_memberships/create_many'].post
  update:
    x-apievangelist-phrasing:
      intent: Add many agents to groups at once
      effect: write
      questions:
      - Can I assign up to 100 agents to groups in one request?
      - Does bulk adding agents to groups return a job status?
      instructions:
      - text: Add all of these agents to their groups in bulk.
      - text: Create group memberships for this batch of new agents.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/group_memberships/destroy_many'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove many agents from groups
      effect: destructive
      questions:
      - Can I remove several agents from groups in one call?
      - Are working tickets unassigned when memberships are removed in bulk?
      instructions:
      - text: Remove group memberships {ids}.
        slots:
          ids: query.ids
      - text: Bulk delete memberships {ids} and unassign their tickets.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/users/{user_id}/group_memberships/{group_membership_id}/make_default'].put
  update:
    x-apievangelist-phrasing:
      intent: Set an agent's default group
      effect: write
      questions:
      - Can I choose which group is an agent's default?
      - Where is an agent's primary group set?
      instructions:
      - text: Make this membership the agent's default group.
      - text: Set Billing as the default group for this agent.
      method: generated
      generated: '2026-09-26'