Configure destinations for Iterable

Iterable enables brands to create, execute and optimize campaigns across email, push, SMS, in-app and more with unparalleled data flexibility.

Use Amperity to manage audience lists in Iterable. Build a query using the email or userId field, and then send the results of that query to Iterable or build a segment that matches specific criteria, and then send the identifiers for customers who belong to that audience. You may extend the audience using custom attributes.

Note

This destination uses the Iterable API .

Get details

Review the following details before configuring credentials for Iterable and before configuring Amperity to send email lists to Iterable.

	Credential settings API Key Required The server-side API key for your Iterable account. Base URL Required The base URL for your Iterable data center. Use https://api.iterable.com for US accounts or https://api.eu.iterable.com for EU accounts. Tip You can find the API key in Iterable by navigating to Integrations > API Keys after logging in to your account.
	Required configuration settings User identifier Required The field used to identify users in Iterable. Select email for email-based projects or userId for user ID-based projects. Audience name Required The name of the list in Iterable to which the audience will be sent. The list will be created if it does not already exist. Update existing profiles only? When enabled, only existing user profiles in Iterable will be updated. When disabled, new user profiles will be created if they do not already exist. Behavior varies by Iterable project type; in hybrid projects, new users may be created even when this setting is enabled.
	A query that outputs the fields that must be mapped to the Iterable audience.

Configure credentials

Configure credentials for Iterable before adding a destination.

An individual with access to Iterable should use SnapPass to securely share “API Key” and “Base URL” details with the individual who configures Amperity.

To configure credentials for Iterable

	From the Settings page, select the Credentials tab, and then click the Add credential button.
	In the Credentials settings dialog box, do the following: From the Plugin dropdown, select Iterable. Assign the credential a name and description that ensures other users of Amperity can recognize when to use this destination.
	The settings that are available for a credential vary by credential type. For the “iterable” credential type, configure settings, and then click Save. API Key Required The server-side API key for your Iterable account. Base URL Required The base URL for your Iterable data center. Use https://api.iterable.com for US accounts or https://api.eu.iterable.com for EU accounts.

Add destination

Use a sandbox to configure a destination for Iterable. Before promoting your changes, send a sample audience, and then verify the results in Iterable. After verifying the end-to-end workflow, push the destination from the sandbox to production.

To add a destination for Iterable

	Open the Destinations page, select the New destinations button, and then select Orchestration. To configure a destination for Iterable, do one of the following: Click the row in which Iterable is located. Destinations list alphabetically and you can scroll up and down the list. Search for Iterable. Start typing “ite”. The list filters to show only matching destinations. Select “Iterable”.
	Select the credential for Iterable from the Credential dropdown, and then click Continue. Tip Amperity validates the connection when the destination is saved. If the connection cannot be validated, an error is shown and the destination is not saved.
	In the “Destination settings” dialog box, assign the destination a name and description that ensures other users of Amperity can recognize when to use this destination. Configure business user access By default a destination is available to all users who have permission to view personally identifiable information (PII). Enable the Admin only checkbox to restrict access to only users assigned to the Datagrid Operator and Datagrid Administrator policies. Enable the PII setting checkbox to allow limited access to PII for this destination. Use the Restrict PII access policy option to prevent users from viewing data marked as PII anywhere in Amperity and from sending data to downstream workflows.
	Configure the following settings, and then click “Save”. User identifier The field used to identify users in Iterable. Select email for email-based projects or userId for user ID-based projects. Audience name (Required at orchestration) The name of the list in Iterable to which the audience will be sent. The list will be created if it does not already exist. Update existing profiles only? When enabled, only existing user profiles in Iterable will be updated. When disabled, new user profiles will be created if they do not already exist. Behavior varies by Iterable project type; in hybrid projects, new users may be created even when this setting is enabled.
	After configuring this destination users may use: Orchestrations to send query results Orchestrations and campaigns to send audiences Orchestrations and campaigns to send events
	Validate the audience with Iterable by using a sample audience with a very small membership. For example: 10 or 100 members or the minimum audience size recommended by Iterable. Send the sample audience to Iterable and verify the sample audience is correct in Iterable. Make adjustments if necessary. Only send full audiences after validation is complete.

Extended profile attributes

You can extend audiences that are sent to Iterable by including extended profile attributes.

The following SQL query shows how to return results that include custom data fields for Iterable:

SELECT
  email
  ,given_name AS firstName
  ,surname AS lastName
  ,city
  ,state
  ,postal AS zipCode
  ,phone AS phoneNumber
  ,birthdate
FROM Customer360

Note

Iterable custom data fields are stored in the dataFields object and can be used for personalization and segmentation. Review the user profile fields that are supported by Iterable.