Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Recipient Addresses Support Addresses API

7 actions 7 updates phrasing extends openapi/zendesk-support-addresses-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 7

$.info
$.paths['/api/v2/recipient_addresses'].get
$.paths['/api/v2/recipient_addresses'].post
$.paths['/api/v2/recipient_addresses/{support_address_id}'].get
$.paths['/api/v2/recipient_addresses/{support_address_id}'].put
$.paths['/api/v2/recipient_addresses/{support_address_id}'].delete
$.paths['/api/v2/recipient_addresses/{support_address_id}/verify'].put

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Zendesk Recipient Addresses Support Addresses API
  version: 1.0.0
extends: openapi/zendesk-support-addresses-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: 6
- target: $.paths['/api/v2/recipient_addresses'].get
  update:
    x-apievangelist-phrasing:
      intent: List support addresses
      effect: read
      questions:
      - Which email addresses receive support requests in my account?
      - Can I see all my support addresses?
      instructions:
      - text: List all support addresses.
      - text: Show every email address set up for support.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/recipient_addresses'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a support address
      effect: write
      questions:
      - Can I add a new Zendesk or external support email address?
      - What format does a Zendesk support address use?
      instructions:
      - text: Add the support address sales-team@example.zendesk.com.
      - text: Create an external support address for our billing inbox.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/recipient_addresses/{support_address_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a support address
      effect: read
      questions:
      - How do I check the forwarding status of one support address?
      - Can I look up a support address by id?
      instructions:
      - text: Show this support address.
      - text: Get one support address's settings.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/recipient_addresses/{support_address_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a support address
      effect: write
      questions:
      - Can I change the name or brand of a support address?
      - Why can't I update a support address's email?
      instructions:
      - text: Update this support address's display name.
      - text: Change the brand on one support address.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/recipient_addresses/{support_address_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a support address
      effect: destructive
      questions:
      - Can I remove a support address I don't use?
      - Who is allowed to delete support addresses?
      instructions:
      - text: Delete this support address.
      - text: Remove one support email address.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/recipient_addresses/{support_address_id}/verify'].put
  update:
    x-apievangelist-phrasing:
      intent: Verify support address forwarding
      effect: write
      questions:
      - How can I check that email forwarding works for an external support address?
      - Does an external support address work before it's verified?
      instructions:
      - text: Send a verification test email to this support address.
      - text: Verify forwarding for one external support address.
      method: generated
      generated: '2026-09-26'