How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Iterable Templates API

Manage email, push, SMS, and in-app message templates. Retrieve template content and metadata.

Iterable Templates API is one of 30 APIs that Iterable publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Templates. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 29 operations across 29 paths, and defines 41 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 3 base URLs: https://api.iterable.com/, https://api.iterable.com/api, https://api.eu.iterable.com/api.

29 operations 29 paths 41 schemas 11 GET18 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.iterable.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Iterable Templates API declares 2 security schemes for authenticating requests. An API key is passed in the header as Api-Key (api_key). An API key is passed in the header as Api-Key (apiKeyAuth).

  • apiKeyAuth — Iterable API key passed in the Api-Key header. API keys can be created and managed in the Iterable project settings.

Paths & Operations 29

Across 29 paths, the API surfaces 29 operations — 11 GET, 18 POST. Each is listed below with its method, path, parameters, and response codes.

templates 29
GET
/api/templates
Get project templates
getTemplates 7 params → 200400401
POST
/api/templates/bulkDelete
Bulk delete templates
bulk delete templates body → 200400401403500
GET
/api/templates/email/get
Get an email template by templateId
getEmailTemplate 2 params → 200400401404
POST
/api/templates/email/preview
Preview email template with custom data
previewEmailTemplate 2 params body → 200400401404
POST
/api/templates/email/proof
Send a proof of an email template
emailProof body → 200400401
POST
/api/templates/email/update
Update email template
updateEmailTemplate body → 200400401
POST
/api/templates/email/upsert
Create email template
upsertEmailTemplate body → 200400401
GET
/api/templates/embedded/get
Get an embedded message template
getEmbeddedTemplate 2 params → 200400401404
POST
/api/templates/embedded/update
Update embedded message template
updateEmbeddedTemplate body → 200400401
POST
/api/templates/embedded/upsert
Create an embedded message template
upsertEmbeddedTemplate body → 200400401
GET
/api/templates/getByClientTemplateId
Get an email template by clientTemplateId
getByClientTemplateId 1 param → 200400401
GET
/api/templates/inapp/get
Get an in-app template
getInAppTemplate 2 params → 200400401404
POST
/api/templates/inapp/preview
Preview in-app template with custom data
previewInAppTemplate 2 params body → 200400401404
POST
/api/templates/inapp/proof
Send a proof of an in-app template
inappProof body → 200400401
POST
/api/templates/inapp/update
Update in-app template
updateInAppTemplate body → 200400401
POST
/api/templates/inapp/upsert
Create an in-app template
upsertInAppTemplate body → 200400401
GET
/api/templates/push/get
Get a push template
getPushTemplate 2 params → 200400401404
POST
/api/templates/push/proof
Send a proof of a push template
pushProof body → 200400401
POST
/api/templates/push/update
Update push template
updatePushTemplate body → 200400401
POST
/api/templates/push/upsert
Create a push template
upsertPushTemplate body → 200400401
GET
/api/templates/sms/get
Get an SMS template
getSMSTemplate 2 params → 200400401404
POST
/api/templates/sms/proof
Send a proof of an SMS template
smsProof body → 200400401
POST
/api/templates/sms/update
Update SMS template
updateSMSTemplate body → 200400401
POST
/api/templates/sms/upsert
Create an SMS template
upsertSMSTemplate body → 200400401
GET
/templates/email/get
Get an email template
getEmailTemplate 1 param → 200401404
POST
/templates/email/update
Update an email template
updateEmailTemplate body → 200400401
GET
/templates/push/get
Get a push notification template
getPushTemplate 1 param → 200401404
GET
/templates/sms/get
Get an SMS template
getSmsTemplate 1 param → 200401404
GET
/templates/inApp/get
Get an in-app message template
getInAppTemplate 1 param → 200401404

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are ApiPushTemplateModel (25 properties), ApiEmailTemplateModel (24 properties), UpsertEmailTemplateModel (22 properties), UpsertPushTemplateModel (22 properties). Each schema is shown below with its type and property counts.

PushAction
object
2 properties
PushActionButton
object
9 properties 3 required
InboxMetadata
object
3 properties
ApiTemplateEntry
object
3 properties 1 required
ApiPushTemplateModel
object
25 properties 1 required
JsObject
object
1 property 1 required
Action
object
2 properties
InAppDisplaySetting
object
ApiTemplateResponse
object
8 properties 6 required
TemplateProofRequest
object
Template proof request
5 properties 1 required
ClientTemplateIdResponse
object
1 property 1 required
UpsertInAppTemplateModel
object
14 properties 1 required
Elements
object
5 properties
BgColor
object
2 properties
ApiInAppTemplateModel
object
15 properties 1 required
UpsertSMSTemplateModel
object
11 properties 1 required
UpsertEmbeddedTemplateModel
object
12 properties 1 required
WebInAppDisplaySettings
object
1 property
TemplatePreviewRequest
object
3 properties
JsValue
object
ApiSMSTemplateModel
object
15 properties 1 required
IterableApiResponse
object
3 properties 2 required
RichMediaURL
object
2 properties
PositionOption
object
ApiEmbeddedTemplateModel
object
13 properties 1 required
UpsertPushTemplateModel
object
22 properties 1 required
GetTemplatesResponse
object
4 properties 1 required
DeeplinkURI
object
2 properties
ActionIcon
object
2 properties 2 required
ActionIconType
object
BulkDeleteTemplatesRequest
object
1 property 1 required
Text
object
2 properties
LinkParam
object
2 properties 2 required
Button
object
3 properties
InAppDisplaySettings
object
6 properties
UpsertEmailTemplateModel
object
22 properties 1 required
ApiEmailTemplateModel
object
24 properties 1 required
string
object
2 properties 2 required
EmailTemplate
object
An email template
11 properties
EmailTemplateUpdate
object
Request body for updating an email template
8 properties 1 required
IterableResponse
object
Standard Iterable API response indicating success or failure
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

iterable-templates-api-openapi.yml Raw ↑

Other APIs Iterable publishes across the network.

Iterable Export API
Iterable Web SDK
Iterable iOS SDK
Iterable Android SDK
Iterable React Native SDK
Iterable Campaigns API
Iterable Catalogs API
Iterable Channels API
Iterable Commerce API
Iterable Email API
Iterable Events API
Iterable Experiments API
Where this information came from

This is an independent, third-party profile of Iterable Templates API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.