Articles in this section

Universal Merge Parameters

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

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 project setting is enabled, Iterable automatically inserts an unsubscribe block, which includes the {{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.

Using {{unsubscribeUrl}} in the Side by Side editor

Using {{unsubscribeUrl}} in the Drag and Drop editor

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. You can set up or edit your brand's Hosted Unsubscribe URL on your project settings page.

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 to send internationally from an alphanumeric sender ID, Iterable includes an unsubscribe link ({{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 page.

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:

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 from which the message send was triggered.

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 to which the campaign was sent.

TIP

To make the output easier to read, consider using the Handlebars join helper to add a comma between each list ID like this:

{{join sendListIds ","}}

Your brand details

companyName

{{companyName}} inserts the name of your brand or company. You can set up or edit your company name on your project settings page.

physicalAddress

{{physicalAddress}} inserts your company's physical mailing address. You can set up or edit your company's physical address on your project settings page.

You must include a physical address in email messages in order to comply with CAN-SPAM laws. When the Auto-append Unsubscribe Block project setting is enabled, Iterable automatically appends an unsubscribe block in email messages, which includes the physical address from your project settings page. If the Auto-append Unsubscribe Block project setting is disabled, you must add {{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

viewInBrowserUrl

{{viewInBrowserUrl}} inserts a link to a web version of your message. When you add this to a message template, 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.

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.

Related articles