Generated by API Evangelist
Written by API Evangelist tooling for Plunk's API. It is a proposal applied on top of the contract, not a document Plunk publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Plunk Public API
version: 1.0.0
extends: openapi/plunk-public-api-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['/v1/send'].post
update:
x-apievangelist-phrasing:
intent: Send a transactional email
effect: write
questions:
- How do I send a password reset email through Plunk?
- Can I send a transactional email using a saved template instead of a subject and body?
- What's the attachment size limit for a transactional email?
instructions:
- text: Email {to} with subject {subject} and body {body}.
slots:
to: requestBody.to
subject: requestBody.subject
body: requestBody.body
- text: Send template {template} to {to} with variables {data}.
slots:
template: requestBody.template
to: requestBody.to
data: requestBody.data
- text: Send {to} an email from {from} with idempotency key {key}, subject {subject}, body {body}.
slots:
to: requestBody.to
from: requestBody.from
key: header.Idempotency-Key
subject: requestBody.subject
body: requestBody.body
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/track'].post
update:
x-apievangelist-phrasing:
intent: Track an event for a contact
effect: write
questions:
- How do I log a custom event like a purchase against a contact?
- Which event names are reserved and will be rejected?
- Can I stop a retried event from being recorded twice?
instructions:
- text: Track event {event} for contact {email}.
slots:
event: requestBody.event
email: requestBody.email
- text: Record {event} for {email} with data {data}.
slots:
event: requestBody.event
email: requestBody.email
data: requestBody.data
- text: Track {event} for {email} once, using idempotency key {key}.
slots:
event: requestBody.event
email: requestBody.email
key: header.Idempotency-Key
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/verify'].post
update:
x-apievangelist-phrasing:
intent: Verify an email address
effect: read
questions:
- Can I check whether an email address is valid before I add it?
- Is there a way to detect disposable email addresses or typos in a domain?
instructions:
- text: Verify the email address {email}.
slots:
email: requestBody.email
- text: Check whether {email} has valid MX records and is not disposable.
slots:
email: requestBody.email
method: generated
generated: '2026-09-26'
Discovery needs no key. Ratings and market analysis are Pro.
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.