SendPulse · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Sendpulse Emails API
11 actions
11 updates
phrasing
extends
openapi/sendpulse-emails-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for SendPulse's API. It is a proposal applied on top of the contract, not a document SendPulse publishes.
What the actions change
x-apievangelist-phrasing
Targets 11
$.info
$.paths['/companies/{companyId}/emails'].get
$.paths['/companies/{companyId}/emails'].post
$.paths['/companies/{companyId}/emails/batch'].post
$.paths['/companies/{companyId}/emails/{emailId}'].put
$.paths['/companies/{companyId}/emails/{emailId}'].delete
$.paths['/smtp/emails'].get
$.paths['/smtp/emails'].post
$.paths['/smtp/emails/total'].get
$.paths['/smtp/emails/{id}'].get
$.paths['/smtp/emails/info'].post
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 Sendpulse Emails API
version: 1.0.0
extends: openapi/sendpulse-emails-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-02'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 10
- target: $.paths['/companies/{companyId}/emails'].get
update:
x-apievangelist-phrasing:
intent: List a company's email addresses
effect: read
questions:
- What email addresses are stored for a CRM company?
- Can I see all emails recorded on a company record?
instructions:
- text: List the email addresses on {entityType} {entityId}.
slots:
entityType: path.entityType
entityId: path.entityId
- text: Show emails saved for company {companyId}.
slots:
companyId: path.companyId
method: generated
generated: '2026-10-02'
- target: $.paths['/companies/{companyId}/emails'].post
update:
x-apievangelist-phrasing:
intent: Add an email address to a company
effect: write
questions:
- How do I add one email address to a company in the CRM?
- Can I store an additional contact email on a company record?
instructions:
- text: Add email {data} to {entityType} {entityId}.
slots:
data: requestBody.data
entityType: path.entityType
entityId: path.entityId
- text: Save a new email address on company {companyId}.
slots:
companyId: path.companyId
method: generated
generated: '2026-10-02'
- target: $.paths['/companies/{companyId}/emails/batch'].post
update:
x-apievangelist-phrasing:
intent: Add several email addresses to a company
effect: write
questions:
- Can I add many email addresses to a company in one request?
- Is there a bulk way to load emails onto a company record?
instructions:
- text: Batch add emails {emails} to company {companyId}.
slots:
emails: requestBody.emails
companyId: path.companyId
- text: Add multiple email addresses to company {companyId} at once.
slots:
companyId: path.companyId
method: generated
generated: '2026-10-01'
- target: $.paths['/companies/{companyId}/emails/{emailId}'].put
update:
x-apievangelist-phrasing:
intent: Update a company's email address
effect: write
questions:
- How do I correct an email address saved on a company?
- Can I edit one specific email entry of a company?
instructions:
- text: Update email {emailId} on company {companyId} to {data}.
slots:
emailId: path.emailId
companyId: path.companyId
data: requestBody.data
- text: Fix company {companyId}'s email record {emailId}.
slots:
companyId: path.companyId
emailId: path.emailId
method: generated
generated: '2026-10-01'
- target: $.paths['/companies/{companyId}/emails/{emailId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a company's email address
effect: destructive
questions:
- Can I remove an outdated email address from a company?
- What's the way to delete one email entry from a company record?
instructions:
- text: Delete email {emailId} from company {companyId}.
slots:
emailId: path.emailId
companyId: path.companyId
- text: Remove company {companyId}'s email entry {emailId}.
slots:
companyId: path.companyId
emailId: path.emailId
method: generated
generated: '2026-10-01'
- target: $.paths['/smtp/emails'].get
update:
x-apievangelist-phrasing:
intent: List transactional emails sent via SMTP
effect: read
questions:
- Which transactional emails did I send through SMTP last week?
- Can I filter my sent SMTP emails by recipient or sender?
- Is it possible to see SMTP sends to a specific country?
instructions:
- text: List SMTP emails sent to {recipient}.
slots:
recipient: query.recipient
- text: Show SMTP emails sent between {from} and {to}.
slots:
from: query.from
to: query.to
method: generated
generated: '2026-10-01'
- target: $.paths['/smtp/emails'].post
update:
x-apievangelist-phrasing:
intent: Send a transactional email over SMTP
effect: write
questions:
- How do I send a transactional email through the SMTP service?
- Can I send a single email via API instead of a campaign?
instructions:
- text: 'Send this SMTP email: {email}.'
slots:
email: requestBody.email
- text: Send a transactional message {email} through SMTP.
slots:
email: requestBody.email
method: generated
generated: '2026-10-01'
- target: $.paths['/smtp/emails/total'].get
update:
x-apievangelist-phrasing:
intent: Count total SMTP emails sent
effect: read
questions:
- How many emails have I sent through SMTP in total?
- What's my overall SMTP send count?
instructions:
- text: Get the total number of SMTP emails I've sent.
- text: Show my SMTP sent-email total.
method: generated
generated: '2026-10-01'
- target: $.paths['/smtp/emails/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get details of one SMTP email
effect: read
questions:
- Can I look up the delivery details of one SMTP email?
- What happened to a specific transactional email I sent?
instructions:
- text: Get information about SMTP email {id}.
slots:
id: path.id
- text: Show the status of sent email {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/smtp/emails/info'].post
update:
x-apievangelist-phrasing:
intent: Get details for several SMTP emails
effect: read
questions:
- Can I check the status of several SMTP emails in one request?
- Is there a bulk lookup for a list of sent email IDs?
instructions:
- text: Get information for SMTP emails {emails}.
slots:
emails: requestBody.emails
- text: 'Look up delivery details for these sent emails: {emails}.'
slots:
emails: requestBody.emails
method: generated
generated: '2026-10-01'