latestSwagger 2.02026-08-10148196271.0 KB

afaab604b58c

templates

Create email template

Create email template if it doesn't exist already, otherwise update all email templates that match the name provided.

post/api/templates/email/upsert

Request body

bccEmailsstring[]

BCC emails

cacheDataFeedobject

Cache data feed lookups for 1 hour

campaignDataFieldsobject

Campaign-level data fields available as {{field}} merge parameters during message rendering. These fields are overridden by user and event data fields of the same name.

ccEmailsstring[]

CC emails

clientTemplateIdstring required

ID used by the client to identify a template. If multiple templates exist with the ID, all will be updated

creatorUserIdstring

Specify a specific creator user id (email). The email must be an existing member of the project. Defaults to the organization creator.

dataFeedIdinteger

[Deprecated - use dataFeedIds instead] Id for data feed used in template rendering

dataFeedIdsnumber[]

Ids for data feeds used in template rendering

fromEmailstring

From email (must be an authorized sender)

fromNamestring

From name

googleAnalyticsCampaignNamestring

Google analytics utm_campaign value

htmlstring

HTML contents

isDefaultLocaleboolean

Ask your Iterable CSM to enroll you in the beta for this feature.

Sets the locale associated with the request content as the template’s default. If empty or flexible default locales are not enabled for the project, the project’s default locale is assigned.

localestring

The locale for the content in this request. Iterable will automatically pick the content with locale that matches a 'locale' field in the user profile.

mergeDataFeedContextboolean

Merge data feed contents into user context, so fields be referenced by {{field}} instead of [[field]]

messageTypeIdinteger

Message Type Id

namestring

Name of the template

plainTextstring

Plain text contents

preheaderTextstring

Preheader text

replyToEmailstring

Reply to email

subjectstring

Subject

Response

successful operation