Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Slas SLA Policies API

8 actions 8 updates phrasing extends openapi/zendesk-sla-policies-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/slas/policies'].get

$.paths['/api/v2/slas/policies'].post

$.paths['/api/v2/slas/policies/{sla_policy_id}'].get

$.paths['/api/v2/slas/policies/{sla_policy_id}'].put

$.paths['/api/v2/slas/policies/{sla_policy_id}'].delete

$.paths['/api/v2/slas/policies/definitions'].get

$.paths['/api/v2/slas/policies/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 Slas SLA Policies API
  version: 1.0.0
extends: openapi/zendesk-sla-policies-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/slas/policies'].get
  update:
    x-apievangelist-phrasing:
      intent: List SLA policies
      effect: read
      questions:
      - What service level agreements are set up in my account?
      - Which plans include SLA policies?
      instructions:
      - text: List all SLA policies.
      - text: Show the service level policies we have defined.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/slas/policies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an SLA policy
      effect: write
      questions:
      - Can I set a first reply target for urgent tickets?
      - What does a new service level policy need?
      instructions:
      - text: Create an SLA policy with a one hour first reply for urgent tickets.
      - text: Add a new service level policy for enterprise customers.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/slas/policies/{sla_policy_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an SLA policy
      effect: read
      questions:
      - Where can I see the targets and filter of one SLA policy?
      - Can I read a single service level policy's details?
      instructions:
      - text: Show this SLA policy.
      - text: Get the targets of the enterprise SLA policy.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/slas/policies/{sla_policy_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an SLA policy
      effect: write
      questions:
      - Can I change the response targets of an existing SLA?
      - Is editing an SLA policy admin-only?
      instructions:
      - text: Update this SLA policy's reply targets.
      - text: Tighten the resolution time on the enterprise SLA.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/slas/policies/{sla_policy_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an SLA policy
      effect: destructive
      questions:
      - Can I remove an SLA policy we no longer use?
      - What happens to tickets when their SLA policy is deleted?
      instructions:
      - text: Delete this SLA policy.
      - text: Remove the old holiday SLA policy.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/slas/policies/definitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List SLA policy filter definitions
      effect: read
      questions:
      - What conditions can I use to decide which tickets an SLA applies to?
      - Which filter fields are available for SLA policies?
      instructions:
      - text: List the filter definitions for SLA policies.
      - text: Show what conditions an SLA policy filter can use.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/slas/policies/reorder'].put
  update:
    x-apievangelist-phrasing:
      intent: Reorder SLA policies
      effect: write
      questions:
      - Can I change which SLA policy takes precedence?
      - Does SLA policy order decide which one applies to a ticket?
      instructions:
      - text: Reorder SLA policies to {sla_policy_ids}.
        slots:
          sla_policy_ids: query.sla_policy_ids
      - text: Set the SLA precedence order as {sla_policy_ids}.
        slots:
          sla_policy_ids: query.sla_policy_ids
      method: generated
      generated: '2026-09-26'