Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Workspaces API

8 actions 8 updates phrasing extends openapi/zendesk-workspaces-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 8

$.info

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

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

$.paths['/api/v2/workspaces/{workspace_id}'].get

$.paths['/api/v2/workspaces/{workspace_id}'].put

$.paths['/api/v2/workspaces/{workspace_id}'].delete

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

$.paths['/api/v2/workspaces/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 Workspaces API
  version: 1.0.0
extends: openapi/zendesk-workspaces-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: 7
- target: $.paths['/api/v2/workspaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List contextual workspaces
      effect: read
      questions:
      - What contextual workspaces are configured for our agents?
      - Where can I see all agent workspaces and their conditions?
      instructions:
      - text: List all contextual workspaces.
      - text: Show every workspace agents can be shown.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/workspaces'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a contextual workspace
      effect: write
      questions:
      - How do I set up a workspace that shows certain macros and apps for billing tickets?
      - Can I create a contextual workspace through the API?
      instructions:
      - text: Create workspace {workspace}.
        slots:
          workspace: requestBody.workspace
      - text: Add a Billing workspace that applies to tickets in the Billing form.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/workspaces/{workspace_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a contextual workspace
      effect: read
      questions:
      - How do I view one workspace's conditions and macros?
      - What does a single contextual workspace include?
      instructions:
      - text: Show the Billing workspace.
      - text: Get that workspace's configuration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/workspaces/{workspace_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a contextual workspace
      effect: write
      questions:
      - Can I change the conditions or apps on an existing workspace?
      - How do I deactivate a workspace without deleting it?
      instructions:
      - text: Update the Billing workspace with {workspace}.
        slots:
          workspace: requestBody.workspace
      - text: Change the macros shown in that workspace.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/workspaces/{workspace_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a contextual workspace
      effect: destructive
      questions:
      - Can I delete a single workspace we don't use anymore?
      - Who is allowed to remove a contextual workspace?
      instructions:
      - text: Delete the old Returns workspace.
      - text: Remove that one workspace.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/workspaces/destroy_many'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several workspaces at once
      effect: destructive
      questions:
      - Can I bulk delete multiple workspaces by id?
      - How do I clean up a batch of unused workspaces in one call?
      instructions:
      - text: Delete workspaces {ids}.
        slots:
          ids: query.ids
      - text: Bulk remove the workspaces with ids {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/workspaces/reorder'].put
  update:
    x-apievangelist-phrasing:
      intent: Reorder contextual workspaces
      effect: write
      questions:
      - Does workspace order decide which one applies first, and can I change it?
      - How do I set the priority order of our workspaces?
      instructions:
      - text: Reorder workspaces to {ids}.
        slots:
          ids: requestBody.ids
      - text: Put the workspaces in the order {ids} so Billing is checked first.
        slots:
          ids: requestBody.ids
      method: generated
      generated: '2026-09-26'