---
description: Configuration details for Iterable integration.
---

# Iterable

Via the Iterable destination, Hightouch can create and sync users.

## Setup

Navigate to Integrations > API Keys and create a new API key with standard permissions.

![](https://1454996985-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MHsth_4gateO06TTdt4%2F-MR-H4b_Np7s3GcoJKF_%2F-MR-HGGtRZyVPcylwfJc%2FScreen%20Shot%202021-01-14%20at%205.44.16%20PM.png?alt=media\&token=b699a252-4acd-4c54-a803-a74039237d9f)

Use the API key generated to create a new Iterable destination in the Destinations tab of Hightouch.

![](https://1454996985-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MHsth_4gateO06TTdt4%2F-MR-H4b_Np7s3GcoJKF_%2F-MR-HTbkD2ykb8Krb0Rg%2FScreen%20Shot%202021-01-14%20at%205.45.41%20PM.png?alt=media\&token=37e1c778-f77c-449d-a989-faadac29148e)

Now that you have a new Iterable destination, you can start piping data!

## Modes

### Upsert

In this mode, new users will be inserted into Iterable and all designated users will be kept up-to-date within Iterable. Upsert is currently the only mode available for use with the Iterable destination.

This mode is good for the following scenarios:

* You want to push objects into Iterable and want to keep the data up-to-date

Upsert has three configuration parameters:

| Name                                         | Details                                                                                                                                            |
| -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| Hightouch Column Containing Iterable Email   | The name of the column on the Hightouch query that will map to the email field for users in Iterable. This is used as the primary key in Iterable. |
| Hightouch Column Containing Iterable User ID | The name of the column (id, created\_at, first\_name, etc..) that will map to the userId field for users in Iterable.                              |
| Hightouch to Iterable Field Mappings         | A list of fields that will be pushed to new users in Iterable. Each time a sync occurs in Hightouch these users will be updated.                   |

Here is an example:

![](https://1454996985-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MHsth_4gateO06TTdt4%2F-MR-H4b_Np7s3GcoJKF_%2F-MR-HsOHKGlr1IhixFJX%2FScreen%20Shot%202021-01-14%20at%205.47.48%20PM.png?alt=media\&token=91f0a2eb-0c50-432e-8ba0-57665f3049fa)

{% hint style="info" %}
Only the email column is required, all other mappings are completely optional.
{% endhint %}
