Iterable Templates API
Manage email, push, SMS, and in-app message templates. Retrieve template content and metadata.
Operations 29
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“Can I list only my SMS templates, or only blast templates?”
“Which templates were created in a certain date range?”
Tell an agent
List {messageMedium} templates of type {templateType}.
List templates created between {startDateTime} and {endDateTime}, page {page}.
Ask an LLM
“Can I delete several templates at once?”
“Will templates attached to a campaign be deleted in a bulk delete?”
Tell an agent destructive · confirm first
Delete templates {ids}.
Bulk remove base templates {ids} that aren't used by campaigns.
GET
/api/templates/email/get
Get an email template in a locale · Get an email template by templateId
#
Ask an LLM
“Can I fetch the Spanish version of an email template?”
“What's the rate limit for reading email templates under /api/templates?”
Tell an agent
Get email template {templateId} in locale {locale}.
Fetch /api email template {templateId}.
POST
/api/templates/email/preview
Render an email template preview with custom data · Preview email template with custom data
#
Ask an LLM
“Can I see the rendered HTML of an email template with sample data before sending?”
“Will the email preview pull in data feeds?”
Tell an agent
Preview email template {templateId} with data {dataFields}.
Render email template {templateId} in {locale}, fetching data feeds {fetchDataFeeds}.
Ask an LLM
“How do I send myself a test email of a template?”
“Can I send a proof email with custom data fields to a teammate?”
Tell an agent
Send a proof of email template {templateId} to {recipientEmail}.
Email a proof of template {templateId} to user {recipientUserId} with data {dataFields}.
Ask an LLM
“Can I change an email template's CC, BCC and reply-to addresses?”
“Is it possible to attach data feeds or a message type when updating an email template?”
Tell an agent
Set the subject of email template {templateId} to {subject}.
Update email template {templateId} to reply to {replyToEmail} and BCC {bccEmails}.
POST
/api/templates/email/upsert
Create or update an email template by client ID · Create email template
#
Ask an LLM
“How do I create an email template that updates if it already exists?”
“Will upserting an email template update every template with the same name?”
Tell an agent
Upsert email template {clientTemplateId} named {name} with subject {subject}.
Create email template {clientTemplateId} with HTML {html} from {fromEmail}.
GET
/api/templates/embedded/get
Get an embedded message template · Get an embedded message template
#
Ask an LLM
“Can I fetch an embedded message template by ID?”
“Is there a localized version of my embedded template?”
Tell an agent
Get embedded template {templateId}.
Fetch embedded template {templateId} in locale {locale}.
POST
/api/templates/embedded/update
Update an embedded message template · Update embedded message template
#
Ask an LLM
“Can I change the title, body or placement of an embedded template?”
“Is it possible to update an embedded template's buttons and elements?”
Tell an agent
Set embedded template {templateId} title to {title}.
Update embedded template {templateId} body to {body} and placement {placementId}.
POST
/api/templates/embedded/upsert
Create or update an embedded template by client ID · Create an embedded message template
#
Ask an LLM
“How do I create an embedded message template that updates if it already exists?”
“Can a new embedded template target a specific placement?”
Tell an agent
Upsert embedded template {clientTemplateId} titled {title}.
Create embedded template {clientTemplateId} for placement {placementId} with body {body}.
GET
/api/templates/getByClientTemplateId
Find email templates by client template ID · Get an email template by clientTemplateId
#
Ask an LLM
“Can I look up an email template using my own client template ID?”
“Which Iterable template matches the ID my system assigned?”
Tell an agent
Find the template with client template ID {clientTemplateId}.
Look up templates by my ID {clientTemplateId}.
Ask an LLM
“Can I fetch a localized in-app template under /api/templates?”
“Where do I read an in-app template's content in another language?”
Tell an agent
Get in-app template {templateId} in locale {locale}.
Fetch /api in-app template {templateId}.
POST
/api/templates/inapp/preview
Render an in-app template preview with custom data · Preview in-app template with custom data
#
Ask an LLM
“Can I preview how an in-app message renders with sample data?”
“Does the in-app preview support pulling data feeds?”
Tell an agent
Preview in-app template {templateId} with data {dataFields}.
Render in-app template {templateId} using data feed {dataFeed}.
POST
/api/templates/inapp/proof
Send an in-app template proof · Send a proof of an in-app template
#
Ask an LLM
“How do I send a test in-app message of a template to my device?”
“Can I send an in-app proof with custom data to a test user?”
Tell an agent
Send a proof of in-app template {templateId} to {recipientEmail}.
Send in-app proof of template {templateId} to user {recipientUserId} in locale {locale}.
Ask an LLM
“Can I change when an in-app template expires?”
“Is it possible to update in-app display settings or inbox metadata?”
Tell an agent
Set in-app template {templateId} to expire at {expirationDateTime}.
Update in-app template {templateId} HTML to {html}.
POST
/api/templates/inapp/upsert
Create or update an in-app template by client ID · Create an in-app template
#
Ask an LLM
“How do I create an in-app template that updates if it already exists?”
“Can a new in-app template set its expiration duration?”
Tell an agent
Upsert in-app template {clientTemplateId} named {name} with HTML {html}.
Create in-app template {clientTemplateId} expiring after {expirationDuration}.
Ask an LLM
“Can I fetch a localized push template under /api/templates?”
“What's the rate limit on reading push templates?”
Tell an agent
Get push template {templateId} in locale {locale}.
Fetch /api push template {templateId}.
Ask an LLM
“How do I send a test push of a template to my phone?”
“Can a push proof use custom data fields?”
Tell an agent
Send a proof of push template {templateId} to {recipientEmail}.
Send push proof of template {templateId} to user {recipientUserId} with data {dataFields}.
Ask an LLM
“Can I change a push template's deep link, sound or badge?”
“Is it possible to make a push template silent or set its interruption level?”
Tell an agent
Set push template {templateId} message to {message} with title {title}.
Update push template {templateId} deep link to {deeplink}.
POST
/api/templates/push/upsert
Create or update a push template by client ID · Create a push template
#
Ask an LLM
“How do I create a push template that updates if one with that name exists?”
“Can a new push template include buttons and rich media?”
Tell an agent
Upsert push template {clientTemplateId} with message {message}.
Create push template {clientTemplateId} titled {title} with rich media {richMedia}.
Ask an LLM
“Can I fetch a localized SMS template under /api/templates?”
“Where do I read an SMS template's text in another language?”
Tell an agent
Get SMS template {templateId} in locale {locale}.
Fetch /api SMS template {templateId}.
Ask an LLM
“How do I text myself a test of an SMS template?”
“Can an SMS proof go to a test user with custom data?”
Tell an agent
Send a proof of SMS template {templateId} to {recipientEmail}.
Text a proof of template {templateId} to user {recipientUserId} with data {dataFields}.
Ask an LLM
“Can I change the text or image on an SMS template?”
“Is it possible to set a tracking domain on an SMS template?”
Tell an agent
Set SMS template {templateId} message to {message}.
Update SMS template {templateId} image to {imageUrl} and tracking domain {trackingDomain}.
POST
/api/templates/sms/upsert
Create or update an SMS template by client ID · Create an SMS template
#
Ask an LLM
“How do I create an SMS template that updates if one with that name exists?”
“Can a new SMS template include an image?”
Tell an agent
Upsert SMS template {clientTemplateId} with message {message}.
Create SMS template {clientTemplateId} named {name} with image {imageUrl}.
Ask an LLM
“Is there a plain /templates/email/get call to read an email template by ID?”
“Which basic endpoint returns an email template's content and metadata?”
Tell an agent
Get email template {templateId} from the plain /templates endpoint.
Read email template {templateId} via the simple endpoint.
POST
/templates/email/update
Update an email template's content (simple) · Update an email template
#
Ask an LLM
“Can I update just an email template's subject, HTML and sender via the basic /templates path?”
“Which simple call edits an email template's preheader text?”
Tell an agent
Using /templates/email/update, set template {templateId} subject to {subject}.
Via the simple endpoint, update template {templateId} HTML to {html} and preheader to {preheaderText}.
Ask an LLM
“Is there a plain /templates/push/get call to read a push notification template?”
“Which basic endpoint returns a push template's content?”
Tell an agent
Get push template {templateId} from the plain /templates endpoint.
Read push notification template {templateId} via the simple endpoint.
Ask an LLM
“Is there a plain /templates/sms/get call to read an SMS template?”
“Which basic endpoint returns an SMS template's text and metadata?”
Tell an agent
Get SMS template {templateId} from the plain /templates endpoint.
Read SMS template {templateId} via the simple endpoint.
Ask an LLM
“Is there a plain /templates/inApp/get call to read an in-app template?”
“Which basic endpoint returns an in-app message template's content?”
Tell an agent
Get in-app template {templateId} from the plain /templates endpoint.
Read in-app message template {templateId} via the simple endpoint.