Learn about the different settings you can use to set up your Iterable project the way you want it.
# In this article
# Overview
Members who are org admins or have the Manage Settings permission can view and edit all of the settings for your Iterable project on the Settings > Project Settings screen.
The Project Settings page is divided into sections, each with its own settings.
Some settings are project-wide, while others are specific to certain channels or features. Your project may not reflect all of the settings described here, depending on your Iterable plan and the features you use.
# Project
# Name
The name of your project and value for the {{companyName}}
merge parameter.
A project's name is initially set when you create the project. You can change a project's name at any time by clicking in the field on the Settings > Project Settings screen and entering your changes.
Project names do not have a specific character limit and may contain special characters. A name should be easily recognizable for other team members in your organization, especially if they have access to multiple projects. A project's name may be truncated in the top navigation bar if it exceeds 20 characters.
Additionally, the project's name is used as the company name in certain content, such as the unsubscribe block and the subscribe success page.
Iterable displays the project's name in the following locations:
- In Iterable.
- As the company name when you use the merge parameter,
{{companyName}}
- In the following locations that your end-users can see:
- In default subscription-related pages hosted by Iterable, such as subscribe and unsubscribe success pages.
- In the default unsubscribe block appended to your emails, if enabled.
# Unique identifier
The type of project and the field(s) used to uniquely identify your users.
Project types can be:
- Email-based — The project uses
email
as the unique identifier. - UserID-based — The project uses
userId
as the unique identifier. - Hybrid - The project uses both
email
anduserId
as unique identifiers.
To learn more, see Project Types and Unique Identifiers.
# Logo
A logo for your project, which displays in the default subscription-related pages hosted by Iterable, such as subscribe and unsubscribe pages.
A logo must be under 3MB in size and in one of the following formats:
- PNG (image/png,
.png
) - JPEG (image/jpeg,
.jpg
,.jpeg
) - GIF (image/gif,
.gif
)
The ideal width for your project's logo image is 300px. This ensures that it displays well in the subscribe and unsubscribe pages for mobile and desktop users.
# Time zone
The default time zone for the project. This setting impacts the following:
- The default time zone used for sending campaigns and journeys, when you specify to use the project's time zone in the scheduling settings.
- The time zone for determining when frequency caps reset, if you use Frequency Management.
This setting does NOT impact:
The time zone used to determine the start and end of the day for billing purposes. Iterable billing is based on the Pacific time zone (PT) and cannot be changed.
The time zone stored in the
timeZone
field on the user profile.-
The time zone used for data captured by Iterable. Iterable captures data in UTC.
Example
date
fields generated by Iterable include:createdAt
,emailCreatedAt
,documentCreatedAt
,documentUpdatedAt
,profileUpdatedAt
,signupDate
,updatedAt
. The time zone of imported date-type fields (via the API or otherwise). This is determined by the values in the data you import. If the data doesn't indicate a time zone, Iterable assumes the time zone is UTC. To learn more, read Field Data Types: Date.
NOTE
Iterable automatically adjusts for daylight saving time (DST), — you don't need to manually edit your campaign send times when daylight saving time begins or ends. (Projects in time zones that don't observe daylight saving time are not affected.)
# Physical mailing address
Your business's physical mailing address. This data is displayed when you use
the {{physicalAddress}}
merge parameter in your templates.
This merge parameter must be included in marketing emails to comply with US CAN-SPAM laws. To automatically include this field in the footer of marketing emails, enable the auto-append unsubscribe block setting.
# Messaging
# Labels
Manage labels, which organize and filter campaigns and journeys. For more information, read Working with Labels.
# Group recurring campaigns
Group recurring campaigns underneath the parent campaign to reduce the number of visible campaigns in the Campaigns index page. When this setting is enabled, view child campaigns by clicking on the parent.
# ‘To Name’ field
To customize the To field in your emails and include your user's first
and/or last name in email message headers, enter the name for the user profile
fields that contains each user's first name (such as firstName
or
first_name
) and last name (such as lastName
or last_name
). Field names
are case-sensitive and do not need to be wrapped in any characters (such as
Handlebars) when entering them in this setting.
Here is an example email sent with the To Name
fields set, as shown in Gmail:
And here is an example of how it changes the message headers:
# Use dynamic sender emails
When enabled, you can assign different sender emails to each recipient of a campaign, rather than using the same sender for all users.
Additional setup is required to use this setting. For a complete guide, see Dynamic Sender Email Addresses.
# Custom sending domain for shared IPs
IMPORTANT
This setting only applies a custom sending domain when you're using Iterable's shared Amazon SES account as an ESP. If you're using any other ESP, leave this setting disabled and reach out to your Iterable account manager for assistance with setup.
Enable Custom sending domain for shared IPs to send email using Iterable's Amazon SES shared IPs from a custom sending domain.
Leave this setting disabled if:
You are using your own ESP account. To set up your own ESP account with Iterable, contact your customer success manager.
You are using Iterable's Amazon SES shared IPs, and sending from the domain associated with your organization's website. Ask your customer success manager if you're unsure about this setting.
The DNS records listed in Settings > DNS Setup are dependent on this domain, and all sender email addresses specified in Settings > Senders must be associated with it.
IMPORTANT
- When you enable this setting, you must also update your DNS records.
- Making changes to this field impacts existing DNS setup records and resets existing domain and sender verifications.
For full instructions to set up your custom sending domain with Iterable's default email services, see Amazon Simple Email Service (SES) + Iterable Integration.
# Auto-append unsubscribe block
When this option is enabled, Iterable appends an unsubscribe block only to marketing messages. (Unsubscribe blocks aren't required for transactional messages.)
The unsubscribe block doesn't display in the email editor or previews, but it is appended to the bottom of the email when you send a proof and when you send the campaign to your audience.
Disable this option if you want to customize unsubscribe blocks in your email templates. You'll need to add the following merge parameters to marketing message templates in order to pass Iterable's automated CAN-SPAM compliance check:
An unsubscribe link
, either {{unsubscribeUrl}}
,{{unsubscribeMessageTypeUrl}}
, or{{hostedUnsubscribeUrl}}
(if you're using a hosted unsubscribe page).Your company's physical mailing address,
{{physicalAddress}}
.
# Unsubscribe block example
Here is how Iterable's unsubscribe block appears in an email:
The unsubscribe block includes the following merge parameters:
-
{{email}}
- The user's email address. -
{{companyName}}
- Your project's name. -
{{unsubscribeUrl}}
- The default unsubscribe URL, which unsubscribes users from the entire message channelthat delivered the message. -
{{physicalAddress}}
- Your company's physical mailing address.
And here is the raw HTML for the unsubscribe block:
<table align="center" border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td valign="top"><span style="font-family:Arial;font-size:12px;line-height:20px;color:#8E8E8E;">This email was sent to <a href="mailto:{{email}}" target="_blank">{{email}}</a>. Don't want to receive these emails anymore? <a href="{{unsubscribeUrl}}" name="unsubscribe" target="_blank"><span style="color:#8E8E8E;text-decoration:underline;color:#8e8e8e">Unsubscribe</span></a></span></td> </tr> <tr> <td valign="top"> <span style="font-family:Arial;font-size:12px;line-height:12px;color:#8E8E8E;">{{companyName}}, {{physicalAddress}}</span> </td> </tr> </tbody> </table>
# Double opt-out for unsubscribes
When enabled, Iterable requires users to confirm unsubscribe requests coming from the email channel with an additional click on an unsubscribe landing page.
Double opt-out setups can negatively impact sender reputation by increasing the likelihood of spam complaints, however they can also help to reduce accidental unsubscribes.
When double opt-out is enabled, the List-Unsubscribe header in sent emails still uses the default single opt-out process because it is a requirement to support easy unsubscribe.
For more information about using double opt-out, read Double Opt-Out Email Unsubscribe.
# Custom unsubscribe HTML snippet
The setting Custom Unsubscribe HTML Snippet allows you to enter HTML to customize the double opt-out page. It appears in project settings only when double opt-out is enabled and applies to double opt-out unsubscribe requests only.
To learn more, read Double Opt-Out Email Unsubscribe.
# Hosted unsubscribe URL
You can host your own preference center that allows users to manage their Iterable subscriptions, including opting in and out of specific message channels and/or message types.
If you plan to use a custom subscription preference center, enter the URL for your preference center here.
When you enter a URL in this field:
- Make sure it starts with
HTTP
orHTTPS
(best practice). - The URL may contain query parameters and Handlebars expressions, such as
?email={{email}}
, to pass information to your preference center.
Use this URL in your templates as an opt-out link by adding the
{{hostedUnsubscribeUrl}}
merge parameter.
Clicks on this URL are tracked in Iterable as a hosted unsubscribe click event. This is a click event, not an unsubscribe event.
To learn how to set up a preference center and add your hosted unsubscribe URL to Iterable, read Creating a Subscription Preference Center.
IMPORTANT
When you use a custom preference center, make sure that your implementation is compliant with sender requirements
# Use as the 'List-Unsubscribe' mail header value
NOTE
List-Unsubscribe headers allow email clients to display an unsubscribe link that can opt-out the user in one click. This function is called easy unsubscribe, or one-click unsubscribe, and is required by most major email clients. To learn more, read Easy Unsubscribe and List-Unsubscribe Email Headers.
When enabled, Iterable uses your hosted unsubscribe URL
in the List-Unsubscribe email headers. For this link to comply with easy
unsubscribe requirements, it must be a URL that can accept a POST
request to
function as a one-click unsubscribe from the message type or channel.
By default, emails from Iterable use the Iterable-hosted default unsubscribe URL in the List-Unsubscribe headers, even for projects that have a hosted unsubscribe URL configured.
To fully enable this setting for your project, additional setup is required. In addition to turning on this setting in the Project Settings page, you must also:
- Add the hosted unsubscribe URL to your project
settings. It must have
HTTPS
protocol. - Update your hosted unsubscribe URL to support both
GET
andPOST
requests as required for the List-Unsubscribe header. - Contact Iterable to verify the setup and enable the feature for your project. Even when the project setting is enabled, you must also contact Iterable to enable the feature for your project. Turning on the setting alone does not automatically enable the feature.
For complete instructions, read Creating a Subscription Preference Center.
# Subscribe success redirect URL
Optionally enter a URL to redirect users after a successful signup through an Iterable-generated signup form.
When entering a URL, make sure it starts with HTTP
or HTTPS
(best practice).
By default, users are taken to a screen similar to the following:
(Make sure to upload a logo if you are using the default page.)
# SMS & WhatsApp
From the Project Settings page, you can manage the settings for SMS opt-out instructions and shortlinks that apply to your SMS and WhatsApp messages.
Thew SMS opt-out settings available in your project depend on the SMS service you use and whether you send SMS internationally:
- Only accounts that use Iterable SMS to send outside of US and Canada have
access to Global SMS settings to customize SMS opt-out instructions for each country. - All other accounts with SMS enabled have access to Include SMS opt-out instructions and SMS opt-out instructions text.
- All accounts have access to SMS shortlink character preference.
To learn more about how these settings work and how to update them, read Customizing SMS Opt-Out Instructions.
# Include SMS opt-out instructions
For all accounts EXCEPT those using Iterable SMS to send outside of US and Canada.
This setting controls whether or not Iterable includes opt-out instructions in every SMS campaign, or just the first one.
Only with the first SMS campaign to each contact - Opt-out instructions are included in the first SMS campaign sent to each user. Iterable doesn't include them in subsequent SMS campaigns.
With every SMS campaign - Opt-out instructions are included in every SMS campaign sent to each user.
# SMS opt-out instructions text
For all accounts EXCEPT those using Iterable SMS to send outside of US and Canada.
The text that appears in the SMS opt-out instructions. This text is included in every SMS campaign, unless you've set the Include SMS opt-out instructions setting to only include them in the first SMS campaign.
By default, Iterable includes this text: Msg&data rates may apply. Text 'STOP' to quit.
To update the opt-out instructions text to use your preferred message, enter your desired text in the field provided.
# Global SMS settings
For accounts using Iterable SMS to send outside of US and Canada. Currently not available for third-party SMS providers.
To view and edit your global SMS settings, click Global SMS Settings on the Project Settings page.
To learn more about how these settings work and how to update them, read Customizing SMS Opt-Out Instructions.
# Shortlink character preference for SMS and WhatsApp
Set a minimum character length for unique keys in shortlinks. Shorter links save space in your messages, while longer links are considered more secure.
This setting specifically controls the minimum length of the unique key in shortlinks for SMS and WhatsApp messages. By default, the minimum length of the unique key is five characters, but you can change it up to a minimum of 20 characters.
To update this setting, enter a number between 5 and 20 in the fields provided for transactional and marketing message channels.
This setting doesn't define the final length of shortlinks. Keep in mind that this is a minimum character length. When the unique key for a SMS shortlink is generated, Iterable appends up to six additional characters to the key until it creates a unique link.
The Shortlink character preference for SMS & WhatsApp defines the minimum length of the unique key, which is only one part of a shortlink.
The final length of a shortlink is always varies. When the shortlink is created, a unique key is generated which is at least the minimum length. To establish a unique key, Iterable appends up to six additional characters to the key until it is a unique shortlink.
The final and total length of a shortlink is the sum of all of these components:
- The characters used by the HTTP protocol (
http://
orhttps://
) - Your tracking domain (such as
xmpl.co/
) - The shortlink's unique key (at least the minimum length set in project settings, and up to 6 characters longer).
- If you're using Iterable's default tracking domain (
itbl.co
), the total length of a shortlink also includes 4 control characters that identify your project. Example:https://itbl.co/-KT~2NMwz
.
To learn more about shortlinks, read Link Shortening and Click Tracking for SMS and WhatsApp.
# Content
# Enable WYSIWYG editor
Use the WYSIWYG editor to create and edit templates in Iterable. This editor allows you to work on templates without needing to know HTML. You can still use the HTML editor for more advanced editing as-needed.
Disable this option to prevent use of the WYSIWYG template editor, and use only the HTML editor.
For more information, read Template Editors Overview.
WARNING
WYSIWYG editor may insert HTML for formatting purposes.
# HMAC secret
Enter a secret key to enable HMAC authentication and use HMACSHA1 Handlebars for your project.
This key is used to generate a HMACSHA1 hash, which is useful for authenticating data sent from Iterable to your server. Iterable does not generate HMAC secret keys for you, so you need to create your own key and provide the value here.
For more information, read Using HMACSHA1 Handlebars to generate authentication tokens.
# Locales
Use these settings to set up your project to support locales. When these settings are configured for your project, you and your team have the ability to create multiple versions of Iterable templates, which can be translated and/or localized (either by your own in-house team or with one of Iterable's supported third-party translation partners) and sent to users around the world according to their individual language and location preferences.
To start using locales in your templates, set up at least one locale code for your project. To learn more, see Setting Up Locales For Your Project.
# Set a locale default on a per-template basis
When this setting is on, you can adjust the default locale of each template you create or edit in the project. When this setting is off, Iterable applies your project's default locale to each template you create or edit in the project.
# Locale preferences
Specify whether Iterable should send marketing and/or transactional campaigns
to users when the value of their locale
field doesn't match any of the locales you've set up for a campaign.
For each channel type (marketing and transactional), you can choose to:
Send the default localization of the campaign - This option sends the default locale's version of the campaign to any users who have unsupported locales.
Don't send the campaign to the user - This option causes Iterable to skip sending the campaign to any users who have unsupported locales. Iterable registers a send skip event on their user profile, with the reason code
LocaleMismatch
.
# Audience
# Overwrite location fields
When enabled, changes to a user's ip
field trigger a lookup of the user's
location information. Iterable updates city
, region
, country
, and
timeZone
on a user's profile whenever the ip
field is updated to a valid IP
address.
When you turn on this setting, Iterable starts to look up the location
information for each user's IP address any time the ip
field is updated.
Iterable doesn't backfill this data for users who already had their ip
field
set before you turned on this setting. Only new updates can trigger location
updates.
Iterable uses a third-party geolocation database to look up location information based on the user's IP address. Fields are updated with the following specifications:
city
- The city name localized in English. Example value:New York
.region
- The region, province, or state code, as specified by the ISO 3166-2 standard. Country codes prefixes are omitted. Example value:NY
(notUS-NY
).country
- The country name localized in English, as specified by the ISO 3166-1 alpha-2 standard. Example value:United States
.timeZone
- The time zone associated with location, as specified by the IANA Time Zone Database. Example value:America/New_York
.
NOTE
To have Iterable automatically update the IP address (ip
) for users who
click on links in your emails, turn on the Overwrite IP field setting.
# Overwrite IP field
Whether Iterable updates a user's ip
field based on inbound email click (emailClick
) events. Enable this setting
for automatic updates to users' IP addresses when they click on links in your
emails.
NOTE
To update a user's city
, region
, country
and timeZone
fields based on
an update to their ip
, turn on the Overwrite location fields setting.
option, too.
# Insights
# Show revenue
Whether to display revenue metrics. Turn off to hide revenue and purchase metrics, and show custom conversions instead.
To learn more, read Tracking Conversions, Purchases, and Revenue.