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.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Zendesk Email Notifications API
version: 1.0.0
extends: openapi/zendesk-email-notifications-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: 3
- target: $.paths['/api/v2/email_notifications'].get
update:
x-apievangelist-phrasing:
intent: List email notifications with a filter
effect: read
questions:
- Which outbound emails were sent for a particular ticket?
- Why does listing email notifications require a filter?
instructions:
- text: List the email notifications sent for ticket {ticket_id}.
slots:
ticket_id: query.filter[ticket_id]
- text: List email notifications produced by comment {comment_id}.
slots:
comment_id: query.filter[comment_id]
- text: List the email notifications matching notification {notification_id}.
slots:
notification_id: query.filter[notification_id]
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v2/email_notifications/{notification_id}'].get
update:
x-apievangelist-phrasing:
intent: Show an email notification
effect: read
questions:
- Can I see delivery details for one outbound email notification?
- Where do I get the notification ID to look up a sent email?
instructions:
- text: Show the details of that email notification.
- text: Fetch one outbound email notification by its notification ID.
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v2/email_notifications/show_many'].get
update:
x-apievangelist-phrasing:
intent: Show many email notifications
effect: read
questions:
- Can I look up several email notifications at once by ticket or comment IDs?
- Is there a way to get details of many sent emails in a single call?
instructions:
- text: Show the email notifications for a list of ticket IDs.
- text: Get details of several email notifications by their IDs.
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.