Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Group Slas Group SLA Policies API

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

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

$.paths['/api/v2/group_slas/policies/{group_sla_policy_id}'].get

$.paths['/api/v2/group_slas/policies/{group_sla_policy_id}'].put

$.paths['/api/v2/group_slas/policies/{group_sla_policy_id}'].delete

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

$.paths['/api/v2/group_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 Group Slas Group SLA Policies API
  version: 1.0.0
extends: openapi/zendesk-group-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/group_slas/policies'].get
  update:
    x-apievangelist-phrasing:
      intent: List group SLA policies
      effect: read
      questions:
      - What group SLA policies do we have configured?
      - Where can I see all the SLA targets set for groups?
      instructions:
      - text: List all group SLA policies.
      - text: Show every SLA policy that applies to groups.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/group_slas/policies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a group SLA policy
      effect: write
      questions:
      - How do I set a time target for how long a ticket can sit with one group?
      - Can I create an SLA policy that applies to groups rather than tickets overall?
      instructions:
      - text: Create a group SLA policy giving Tier 2 four hours per ticket.
      - text: Add a new group SLA policy for the Billing group.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/group_slas/policies/{group_sla_policy_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a group SLA policy
      effect: read
      questions:
      - How can I view the filters and targets of one group SLA policy?
      - What does a single group SLA policy contain?
      instructions:
      - text: Show the Tier 2 group SLA policy.
      - text: Get that group SLA policy's filter and metrics.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/group_slas/policies/{group_sla_policy_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a group SLA policy
      effect: write
      questions:
      - Can I change the target time on an existing group SLA policy?
      - How do I edit which tickets a group SLA policy applies to?
      instructions:
      - text: Change the Tier 2 group SLA policy target to two hours.
      - text: Update the filter on that group SLA policy.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/group_slas/policies/{group_sla_policy_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a group SLA policy
      effect: destructive
      questions:
      - Can I remove a group SLA policy we no longer need?
      - Who is allowed to delete a group SLA policy?
      instructions:
      - text: Delete the old Tier 2 group SLA policy.
      - text: Remove that group SLA policy.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/group_slas/policies/definitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List filter options for group SLA policies
      effect: read
      questions:
      - Which ticket conditions can I use to filter a group SLA policy?
      - What filter definitions are supported when building group SLAs?
      instructions:
      - text: List the filter definitions available for group SLA policies.
      - text: Show the conditions I can use in a group SLA filter.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/group_slas/policies/reorder'].put
  update:
    x-apievangelist-phrasing:
      intent: Reorder group SLA policies
      effect: write
      questions:
      - Does the order of group SLA policies matter, and can I change it?
      - How do I set which group SLA policy is evaluated first?
      instructions:
      - text: Reorder the group SLA policies to {group_sla_policy_ids}.
        slots:
          group_sla_policy_ids: query.group_sla_policy_ids
      - text: Put group SLA policies in the order {group_sla_policy_ids} so the urgent one runs first.
        slots:
          group_sla_policy_ids: query.group_sla_policy_ids
      method: generated
      generated: '2026-09-26'