Generated by API Evangelist
Written by API Evangelist tooling for Iterable's API. It is a proposal applied on top of the contract, not a document Iterable publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Iterable SMS API
version: 1.0.0
extends: openapi/iterable-sms-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/api/sms/cancel'].post
update:
x-apievangelist-phrasing:
intent: Cancel an SMS to a user
effect: destructive
questions:
- Can I cancel a text message scheduled for one user?
- What do I need to identify an SMS I want to cancel?
instructions:
- text: Cancel the SMS from campaign {campaignId} to {email}.
slots:
campaignId: requestBody.campaignId
email: requestBody.email
- text: Cancel scheduled SMS {scheduledMessageId}.
slots:
scheduledMessageId: requestBody.scheduledMessageId
method: generated
generated: '2026-10-01'
- target: $.paths['/api/sms/target'].post
update:
x-apievangelist-phrasing:
intent: Send a campaign SMS to a user
effect: write
questions:
- Can I send a transactional text to one user and schedule it?
- Do data fields in the request override profile fields in an SMS?
instructions:
- text: Text campaign {campaignId} to {recipientEmail}.
slots:
campaignId: requestBody.campaignId
recipientEmail: requestBody.recipientEmail
- text: Send SMS campaign {campaignId} to user {recipientUserId} at {sendAt}.
slots:
campaignId: requestBody.campaignId
recipientUserId: requestBody.recipientUserId
sendAt: requestBody.sendAt
method: generated
generated: '2026-10-01'
- target: $.paths['/sms/target'].post
update:
x-apievangelist-phrasing:
intent: Send an SMS via the simple endpoint
effect: write
questions:
- Is there a plain /sms/target call that sends a templated text by email?
- How do I send a personalized SMS with just an email and campaign?
instructions:
- text: Using /sms/target, text campaign {campaignId} to {recipientEmail}.
slots:
campaignId: requestBody.campaignId
recipientEmail: requestBody.recipientEmail
- text: Send SMS campaign {campaignId} to {recipientEmail} with data {dataFields} via the simple endpoint.
slots:
campaignId: requestBody.campaignId
recipientEmail: requestBody.recipientEmail
dataFields: requestBody.dataFields
method: generated
generated: '2026-10-01'
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.