Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Automations API

10 actions 10 updates phrasing extends openapi/zendesk-automations-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/automations'].get

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

$.paths['/api/v2/automations/{automation_id}'].get

$.paths['/api/v2/automations/{automation_id}'].put

$.paths['/api/v2/automations/{automation_id}'].delete

$.paths['/api/v2/automations/active'].get

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

$.paths['/api/v2/automations/search'].get

$.paths['/api/v2/automations/update_many'].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 Automations API
  version: 1.0.0
extends: openapi/zendesk-automations-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/automations'].get
  update:
    x-apievangelist-phrasing:
      intent: List automations
      effect: read
      questions:
      - What automations are set up in my Zendesk account?
      - Can I filter the automations list with optional parameters?
      instructions:
      - text: List all automations.
      - text: Show every automation in the account, active or inactive.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/automations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an automation
      effect: write
      questions:
      - Can I create a time-based automation through the API?
      - What rules must a new automation's conditions follow?
      instructions:
      - text: Create an automation that closes tickets solved for 4 days.
      - text: Add a new automation with these conditions and actions.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/automations/{automation_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an automation
      effect: read
      questions:
      - How do I see the conditions and actions of a single automation?
      - Where can I look up one automation by id?
      instructions:
      - text: Show this automation.
      - text: Get one automation's conditions and actions.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/automations/{automation_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an automation
      effect: write
      questions:
      - Can I change the conditions of an existing automation?
      - Is it possible to deactivate one automation?
      instructions:
      - text: Update this automation to run after 48 hours instead.
      - text: Change the actions on an existing automation.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/automations/{automation_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an automation
      effect: destructive
      questions:
      - Can I delete a single automation?
      - Why might I be blocked from deleting a default automation?
      instructions:
      - text: Delete this automation.
      - text: Remove one automation I no longer need.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/automations/active'].get
  update:
    x-apievangelist-phrasing:
      intent: List active automations
      effect: read
      questions:
      - Which automations are currently active?
      - Can I list only the automations that are switched on?
      instructions:
      - text: List only active automations.
      - text: Show the automations currently running.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/automations/destroy_many'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several automations at once
      effect: destructive
      questions:
      - Can I bulk delete a list of automations?
      - What happens to restricted default automations in a bulk delete?
      instructions:
      - text: Delete the automations {ids}.
        slots:
          ids: query.ids
      - text: 'Bulk remove these automations: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/automations/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search automations
      effect: read
      questions:
      - Can I search automations by title?
      - Is automation search limited to offset pagination?
      instructions:
      - text: Search automations for ones about pending tickets.
      - text: Find automations whose title matches a keyword.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/automations/update_many'].put
  update:
    x-apievangelist-phrasing:
      intent: Update several automations at once
      effect: write
      questions:
      - Can I reorder or activate many automations in one request?
      - Which automations get skipped in a bulk update?
      instructions:
      - text: Bulk update the positions of these automations.
      - text: Activate a batch of automations in one request.
      method: generated
      generated: '2026-09-26'