Iterable offers several built-in merge parameters that you can use anywhere you want to insert dynamic content. No matter how you've set up your data in your project, these merge parameters are supported in Iterable templates, snippets, and data feeds.
In this article
Unsubscribe links
In order to comply with CAN-SPAM laws, you must include an easy way for message recipients to unsubscribe from any marketing message they receive from your brand. Iterable offers several merge parameters that you can use to add unsubscribe links to your messages.
If the Auto-append Unsubscribe Block{{unsubscribeUrl}} merge parameter, in email marketing
messages. If this setting is disabled, you must include either {{unsubscribeUrl}},
{{unsubscribeMessageTypeUrl}}, or {{hostedUnsubscribeUrl}} in email messages
sent through a marketing channel.
To learn more about configuring your project's subscription settings, see Message Channels and Message Types Overview.
NOTE
By default, any merge parameters whose names include Url render as raw links
when used in a message template. If you want them to render as hyperlinked text,
either place the merge parameter in an href along with your preferred display
text, or use the Insert Link option in the Drag and Drop or WYSIWYG editor
to set up your preferred display text and link options.
unsubscribeUrl
{{unsubscribeUrl}} inserts a link that recipients can click to unsubscribe
from the message channel associated with the message.
hostedUnsubscribeUrl
{{hostedUnsubscribeUrl}} inserts a link to your hosted unsubscribe page or
subscription preferences center
NOTE
If you want to add parameters to the end of your hosted unsubscribe URL, it's
best to set them up on the project settings
page instead of in the body of a message template. However, if you do add the
parameters in the message template, we recommend using & as the first
character instead of ?.
unsubscribeMessageTypeUrl
{{unsubscribeMessageTypeUrl}} inserts a link that recipients can click to
unsubscribe from the message type associated with the message.
unsubscribeByPhoneUrl
When you use Iterable SMS{{unsubscribeByPhoneUrl}}) in the opt-out instructions. This
personalized link takes recipients to a webpage where they can opt out of
receiving SMS messages.
You can set up your {{unsubscribeByPhoneUrl}} on your Global SMS Settings
To learn more, see SMS Unsubscribes and Resubscribes.
Campaign metadata
campaignName
{{campaignName}} inserts the name of the campaign associated with the message.
campaignId
{{campaignId}} inserts the ID of the campaign associated with the message.
recurringCampaignId
If the template is associated with a recurring campaign, {{recurringCampaignId}}
inserts the name of the parent campaign associated with the message.
templateName
{{templateName}} inserts the name of the template associated with the message.
templateId
{{templateId}} inserts the ID of the template associated with the campaign.
Iterable automatically generates a unique ID for each template you create.
clientTemplateId
{{clientTemplateId}} inserts the client ID of the template associated with the
campaign. The client ID is a custom identifier that you can set for one or more
templates that you create using Iterable's API:
POST /api/templates/email/upsertPOST /api/templates/push/upsertPOST /api/templates/sms/upsertPOST /api/templates/inapp/upsert
When you update templates with these endpoints, all existing templates in your
project with the specified clientTemplateId are updated.
channelId
{{channelId}} inserts the ID of the message's associated message channel
messageTypeId
{{messageTypeId}} inserts the ID of the message's associated message type
workflowId
{{workflowId}} inserts the ID of the journey
NOTE
Journeys were previously called "Workflows" in Iterable. Be sure to use the
correct parameter name ({{workflowId}}) to reference journey IDs wherever you
use Handlebars in Iterable.
sendListIds
{{sendListIds}} inserts the audience lists
TIP
To make the output easier to read, consider using the Handlebars join helper
to add a comma between each list ID like this:
Your brand details
brandName
The merge parameter {{brandName}} displays your brand's name in the
confirmation and legal disclaimer messages for SMS double opt-in message types.
The value for this merge parameter is configured in the settings for your SMS double opt-in message type, and can be up to 50 characters long.
Example confirmation message:
{{brandName}}: Reply Y to subscribe to text messages about:
{{messagingInitiative}}
Example legal disclaimer message:
{{brandName}}: Msg & data rates may apply. Msg frequency varies.
Reply HELP for help, STOP to cancel. Disclaimer: {{smsDisclaimerLink}}
To learn more about SMS Double Opt-In, see SMS Double Opt-In Overview.
companyName
{{companyName}} inserts the name of your brand or company. You can set up or
edit your company name on your project settings
physicalAddress
{{physicalAddress}} inserts your company's physical mailing address. You can
set up or edit your company's physical address on your project settings
You must include a physical address in email messages in order to comply with
CAN-SPAM{{physicalAddress}} to your
unsubscribe code block.
Recipient details
email
{{email}} inserts the recipient's email address.
To avoid blank spaces in rendered messages, it's a good idea to include a
fallback option
in case a recipient's email user profile field is blank or invalid.
userId
{{userId}} inserts the recipient's user ID
To avoid blank spaces in rendered messages, it's a good idea to include a
fallback option
in case a recipient's userId user profile field is blank or invalid.
Other
messagingInitiative
The messaging initiative describes the content associated with a SMS double opt-in message type. It tells your users what kind of content they're subscribing to.
The value for this merge parameter is configured in the settings for the SMS double opt-in message type, and can be up to 100 characters long.
Iterable includes this field in the double opt-in confirmation message with the
merge parameter {{messagingInitiative}}.
Example confirmation message:
{{brandName}}: Reply Y to subscribe to text messages about:
{{messagingInitiative}}
To learn more about SMS Double Opt-In, see SMS Double Opt-In Overview. :::
now
{{now}} inserts the current date (generated at send time), in the following
format: MMM DD, YYYY (example: Oct 24, 2024)
To learn more about how to use {{now}}, see
Personalizing Templates with Handlebars
smsDisclaimerLink
The SMS disclaimer link is a valid URL that begins with https:// and should
direct recipients to your brand's terms and conditions or privacy policy.
The value for this merge parameter is configured in the settings for the SMS double opt-in message type, and can be up to 100 characters long.
Iterable includes this link in the legal disclaimer message for the SMS double
opt-in message type with the merge parameter {{smsDisclaimerLink}}.
Example legal disclaimer message:
{{brandName}}: Msg & data rates may apply. Msg frequency varies.
Reply HELP for help, STOP to cancel. Disclaimer: {{smsDisclaimerLink}}
To learn more about SMS Double Opt-In, see SMS Double Opt-In Overview.
viewInBrowserUrl
{{viewInBrowserUrl}} inserts a link to a web version of an email message.
When you add this to a message template for an email, at send time, it renders
as a link recipients can click to view the message in their web browser.
NOTE
When you preview a template that uses locales, the View this email in your browser
link in your message proof reflects the template's default locale.