Universal merge parameters are parameters that are available for all clients regardless of setup. Below is a list of all universal parameters that can be used in your templates.
List of available merge parameters
- View in browser URL:
{{viewInBrowserUrl}}
- Unsubscribe URL :
{{unsubscribeUrl}}
- Hosted unsubscribe URL:
{{hostedUnsubscribeUrl}}
- Unsubscribe message type URL:
{{unsubscribeMessageTypeUrl}}
- Unsubscribe by phone URL:
{{unsubscribeByPhoneUrl}}
- Campaign name:
{{campaignName}}
- Campaign ID:
{{campaignId}}
- Recurring campaign ID:
{{recurringCampaignId}}
- Template name:
{{templateName}}
- Template ID:
{{templateId}}
- Client Template ID:
{{clientTemplateId}}
- Channel ID:
{{channelId}}
- Message type ID:
{{messageTypeId}}
- Workflow ID:
{{workflowId}}
- Recipient email:
{{email}}
- Company name:
{{companyName}}
- Company address:
{{physicalAddress}}
- Current date:
{{now}}
- For example, "Oct 5, 2018"
- Current date:
{{now format='MMMM dd, yyyy'}}
- For example, "October 5, 2018"
- Current date:
{{now format='MM/dd/yy'}}
- For example, "10/05/2018"
- Current year:
{{now format='yyyy'}}
- For example, "2018"
- Date, full format:
{{now format='full'}}
- For example, "Monday, December 12, 2016"
- Date, custom format:
{{now format='E, MMMM dd, yyyy'}}
- Sample output for this custom format: "Mon, December 10, 2018"
- Date five days from today:
{{dateMath "now" "+5d"}}
Example usage
viewInBrowserUrl
{{viewInBrowserUrl}}
provides a link to a web version of your email:
<a href="{{viewInBrowserUrl}}" target="_blank">View this email in your browser</a>
NOTE
If the template you are proofing uses locales, the View this email in your browser
link in your proof will be the default locale selected for the template.
unsubscribeUrl
{{unsubscribeUrl}}
inserts a link to unsubscribe from the channel associated
with the message. By default, Iterable auto-appends the unsubscribe
block. If this feature is disabled, you must include {{unsubscribeUrl}}
,
{{unsubscribeMessageTypeUrl}}
or {{hostedUnsubscribeUrl}}
in emails sent
through a marketing channel. To learn more, read
Message Channels and Message Types Overview
The following example shows {{unsubscribeUrl}}
being used in the WYSIWYG
editor:
The following example shows {{unsubscribeUrl}}
being used in source code:
<a href="{{unsubscribeUrl}}">unsubscribe</a>
hostedUnsubscribeUrl
{{hostedUnsubscribeUrl}}
inserts the link to your hosted unsubscribe page
or email preferences center. Set this up in your Iterable
project settings
The following example shows {{hostedUnsubscribeUrl}}
being used in the
WYSIWYG editor:
The following example shows {{hostedUnsubscribeUrl}}
being used in source
code:
<a href="{{hostedUnsubscribeUrl}}">Update subscription preferences</a>
NOTE
If you wish to add parameters to the end of the hosted unsubscribe URL, it is
best to type them in on the project settings
page instead of in the template body. However, if you do add the parameters
to the template body, use &
as the first character of your parameter
string instead of ?
.
unsubscribeMessageTypeUrl
{{unsubscribeMessageTypeUrl}}
inserts the link to unsubscribe from the
message type associated with the message. By default, Iterable will
auto-appends the unsubscribe block. If this feature is disabled,
you must include {{unsubscribeUrl}}
, {{unsubscribeMessageTypeUrl}}
or {{hostedUnsubscribeUrl}}
in emails sent through a marketing channel.
To learn more, read Message Channels and Message Types Overview
The following example shows {{unsubscribeMessageTypeUrl}}
being used
in the WYSIWYG editor:
The following screenshot shows {{unsubscribeMessageTypeUrl}}
being used
in source code:
<a href="{{unsubscribedMessageTypeUrl}}">Unsubscribe from Iterable's Newsletter Messages</a>
campaignId
{{campaignId}}
inserts the numerical ID of the campaign into the template.
The following example shows {{campaignId}}
being used in a template:
This example would render text similar to the following:
recurringCampaignId
{{recurringCampaignId}}
inserts the campaign ID of the recurring (parent)
campaign. This could be useful in a case where you want to include the parent
campaign ID in a custom link parameter for attribution purposes (for example,
if you want to attribute user engagement related to entire series of
newsletters instead of to a single month's).
{{email}}
inserts the recipient's email address into the template.
The following example shows {{email}}
in the template editor:
In an email, this would appear as follows:
companyName
{{companyName}}
inserts your company's name, which you set as the project
name in your project settings
physicalAddress
{{physicalAddress}}
inserts your company's physical mailing address, which you set in your project
settings{{physicalAddress}}
in your emails when coding your
unsubscribe block.
The following example shows {{physicalAddress}}
in the template editor:
In an email, this would appear as follows:
now
{{now}}
will give you current time at time of send. You can then format this
date according to your needs:
NOTE
If you are using the WYSIWYG editor, be sure to use single quotes. If you use double quotes around the format, it won't save properly.
The following example shows {{now}}
in the template editor:
In an email, this would appear as follows:
Comments
2 comments
I don't see the following anywhere:
Can we get that added?
Please sign in to leave a comment.