# Iterable Lists (Actions) Destination

The Iterable Lists destination allows users to upload lists of users to Iterable as audiences. For more information on this destination's features, visit [Iterable's lists documentation](https://support.iterable.com/hc/en-us/articles/115000770906-Adding-Users-and-Creating-Lists).

This is an [Engage destination](/docs/segment/engage/using-engage-data/#engage-destination-types-event-vs-list), which means it can be used to send data to Iterable Lists from Twilio Engage Audiences.

## How it works

When you create an audience in Engage and connect it to the Iterable Lists destination, Segment automatically:

1. Creates a new list in Iterable using the audience key as the list name.
2. Adds users to the list in Iterable when they enter the audience.
3. Removes users from the list in Iterable when they exit the audience.

> \[!NOTE]
>
> Real-time audience syncs may take six or more hours for the initial sync to complete. Upon completion, a sync frequency of two to three hours is expected.

## Prerequisites

Before you begin, make sure you have:

* An Iterable API Key, which you can find in your Iterable account under **Settings > API Keys**.
* Know which Iterable Project your Iterable Lists will belong to. See the [the Iterable Project Type Settings FAQ](#iterable-project-type-settings) below for further instructions.
* A configured [Engage Audience](/docs/segment/engage/audiences/) that you want to connect to this destination.

## Getting started

To set up your Iterable Lists destination in the Segment app, you'll need to:

1. [Connect Iterable Lists to Twilio Engage](#connect-iterable-lists-to-twilio-engage).
2. [Set up the Sync Action in your Iterable Lists (Actions) Destination](#set-up-the-sync-action-in-your-iterable-lists-actions-destination).
3. [Connect Iterable Lists to your Audience](#connect-iterable-lists-to-your-audience).

### Connect Iterable Lists to Twilio Engage

1. In Segment, go to **Engage > Engage Settings**.
2. Click **Destinations**, then click **Add Destination**.
3. Search for **Iterable Lists (Actions)** and click on it.
4. Click **Add destination**, then click **Confirm Source**.
5. Under Basic Settings, enter a name for your destination (for instance, "Iterable Lists Prod Space"), your Iterable API Key, select your Iterable Project Type, then enable the destination and click on **Save**.
6. Turn on the **Enable Destination** toggle.

### Set up the Sync Action in your Iterable Lists (Actions) Destination

1. Navigate to **Connections > Destinations** then search for the **Iterable Lists (Actions)** destination you just created and click on it.
2. Navigate to **Mappings > New Mapping** and click on the **Sync To Iterable Lists** tile.

* Optional: if you plan to sync additional user traits or identifiers to Iterable, you should configure mappings for these using the **Additional traits or identifiers** field.

4. Click **Save**.
5. Back on the Mappings tab, enable the **Sync to Iterable Lists** Action.

### Connect Iterable Lists to your Audience

1. Navigate to **Engage > Audiences**, then select the Audience you'd like to sync to Iterable.
2. Click **Add Destination** then select the **Iterable Lists (Actions)** destination you created in previous steps.

* *Optional*: Configure the **Campaign ID**, **Channel Unsubscribe**, and **Update existing users only** settings if needed.
* *Optional*: Click **Customized Setup** if you want Engage to sync additional user traits or identifiers to the destination. This requires you to also map these traits or identifiers.

3. This destination supports the Identify and Track methods. Both work in the same way. If using Track, there's no need to set an event name as the destination ignores any set event name.
4. Click **Save** to apply the changes, then click **Add 1 Destination** to save the destination configuration. Segment starts to sync your audience to Iterable.

## FAQs

### Iterable Project Type Settings

Iterable projects can be configured to use either **userId**, **email**, or both **userId and email** as user identifiers. You can check which identifiers your Iterable project is configured to use by opening your Iterable app and navigating to **Settings > Project Settings > Unique identifier**.

The table below outlines which **Iterable Project Type** destination setting you should set in the Segment app, based on your Iterable project type:

| Your Iterable project type                      | The correct Segment setting to use |
| ----------------------------------------------- | ---------------------------------- |
| Email-based project (unique email)              | Hybrid Project                     |
| Hybrid project (unique userId and unique email) | Hybrid Project                     |
| UserID-based project (unique userId)            | User ID Based Project              |