# Iterable Export Integration

Iterable is a complete cross-channel customer engagement platform. Use it to message your customers via email, SMS, embedded messages, in-app messages, push notifications, and web push notifications—and to grow your customer base, boost engagement, and increase user lifetime value.

This integration enables Treasure Data users to add or remove subscribers from an Iterable list.

- [Use Audience Studio to Schedule and View your Activation](/int/iterable-export-integration#h1__1239026014)
- [Optionally Schedule the Query Export Jobs](/int/iterable-export-integration#h1__761307651)


## Prerequisites

- Basic Knowledge of Treasure Data
- Basic knowledge of Iterable


## Obtaining API Key

See [Iterable Import Integration](/int/iterable-import-integration)

## Use the TD Console to Create Your Connection

### Using existed Connection

Authentications created for Iterable can be reused across input and output connectors. Search for existing authentications from **Integrations Hub** > **Authentications**.

### Create a New Connection

See [Iterable Import Integration](/int/iterable-import-integration) for creating new connections to Iterable using an API Key.

## Define your Query

### Example Query


```
SELECT email, user_id FROM table my_table
```

### Add users to audience lists.

The table below describes columns that can be included in your query results and how those will be sent to Iterable.

| Name | Type | Description |
|  --- | --- | --- |
| email | String |  |
| user_id | String | Will be transformed to **userId** |
| prefer_user_id | Boolean | Prefer user_id over email |
| merge_nested_objects | Boolean |  |


The preserved columns **email**, **user_id**, **prefer_user_id**, and **merge_nested_objects**will be used to build the respective **email**, **userId**, **preferUserId**, and **mergeNestedObjects** in the payload before sending it to Iterable.  Fields outside of preserved columns will automatically be built into the **data fields** in the payload before sending to Iterable.

### Remove users from audience lists

The connector only supports these fields.

| Name | Type | Description |
|  --- | --- | --- |
| email | String |  |
| user_id | String |  |


## Use Query Export Result to export data

Set the following parameters:

![](/assets/screen-shot-2024-09-09-at-15.12.02.2108b447c894b5262ef80fb7d5b2a9fee0db33feeb9b3fb6ce72efd1c5fa7c8c.94a4ad06.png)

| Parameter | Values | Description |
|  --- | --- | --- |
| **action** | String | add/remove |
| **list_id** | Number |  |
| **campaign_id** | Number |  |
| **channel_unsubscribe** | Boolean |  |
| `skip_invalid_data` | Boolean |  |


### (Optional) Schedule Query Export Jobs

You can use Scheduled Jobs with Result Export to periodically write the output result to a target destination that you specify.

Treasure Data's scheduler feature supports periodic query execution to achieve high availability.

When two specifications provide conflicting schedule specifications, the specification requesting to execute more often is followed while the other schedule specification is ignored.

For example, if the cron schedule is `'0 0 1 * 1'`, then the 'day of month' specification and 'day of week' are discordant because the former specification requires it to run every first day of each month at midnight (00:00), while the latter specification requires it to run every Monday at midnight (00:00). The latter specification is followed.

#### Scheduling your Job Using TD Console

1. Navigate to **Data Workbench > Queries**
2. Create a new query or select an existing query.
3. Next to **Schedule**, select None.
![](/assets/image2021-1-15_17-28-51.f1b242f6ecc7666a0097fdf37edd1682786ec11ef80eff68c66f091bc405c371.0f87d8d4.png)
4. In the drop-down, select one of the following schedule options:
![](/assets/image2021-1-15_17-29-47.45289a1c99256f125f4d887e501e204ed61f02223fde0927af5f425a89ace0c0.0f87d8d4.png)
| Drop-down Value | Description |
|  --- | --- |
| Custom cron... | Review [Custom cron... details](#custom-cron-details). |
| @daily (midnight) | Run once a day at midnight (00:00 am) in the specified time zone. |
| @hourly (:00) | Run every hour at 00 minutes. |
| None | No schedule. |


#### Custom cron... Details

![](/assets/image2021-1-15_17-30-23.0f94a8aa5f75ea03e3fec0c25b0640cd59ee48d1804a83701e5f2372deae466c.0f87d8d4.png)

| **Cron Value** | **Description** |
|  --- | --- |
| `0 * * * *` | Run once an hour. |
| `0 0 * * *` | Run once a day at midnight. |
| `0 0 1 * *` | Run once a month at midnight on the morning of the first day of the month. |
| "" | Create a job that has no scheduled run time. |



```
 *    *    *    *    *
 -    -    -    -    -
 |    |    |    |    |
 |    |    |    |    +----- day of week (0 - 6) (Sunday=0)
 |    |    |    +---------- month (1 - 12)
 |    |    +--------------- day of month (1 - 31)
 |    +-------------------- hour (0 - 23)
 +------------------------- min (0 - 59)
```

The following named entries can be used:

- Day of Week: sun, mon, tue, wed, thu, fri, sat.
- Month: jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec.


A single space is required between each field. The values for each field can be composed of:

| Field Value | Example | Example Description |
|  --- | --- | --- |
| A single value, within the limits displayed above for each field. |  |  |
| A wildcard `'*'` to indicate no restriction based on the field. | `'0 0 1 * *'` | Configures the schedule to run at midnight (00:00) on the first day of each month. |
| A range `'2-5'`, indicating the range of accepted values for the field. | `'0 0 1-10 * *'` | Configures the schedule to run at midnight (00:00) on the first 10 days of each month. |
| A list of comma-separated values `'2,3,4,5'`, indicating the list of accepted values for the field. | `0 0 1,11,21 * *'` | Configures the schedule to run at midnight (00:00) every 1st, 11th, and 21st day of each month. |
| A periodicity indicator `'*/5'` to express how often based on the field's valid range of values a schedule is allowed to run. | `'30 */2 1 * *'` | Configures the schedule to run on the 1st of every month, every 2 hours starting at 00:30. `'0 0 */5 * *'` configures the schedule to run at midnight (00:00) every 5 days starting on the 5th of each month. |
| A comma-separated list of any of the above except the `'*'` wildcard is also supported `'2,*/5,8-10'`. | `'0 0 5,*/10,25 * *'` | Configures the schedule to run at midnight (00:00) every 5th, 10th, 20th, and 25th day of each month. |


1. (Optional) You can delay the start time of a query by enabling the Delay execution.


### Execute the Query

Save the query with a name and run, or just run the query. Upon successful completion of the query, the query result is automatically exported to the specified destination.

Scheduled jobs that continuously fail due to configuration errors may be disabled on the system side after several notifications.

(Optional) You can delay the start time of a query by enabling the Delay execution.

## Activate a Segment in Audience Studio

You can also send segment data to the target platform by creating an activation in the Audience Studio.

1. Navigate to **Audience Studio**.
2. Select a parent segment.
3. Open the target segment, right-mouse click, and then select **Create Activation.**
4. In the **Details** panel, enter an Activation name and configure the activation according to the previous section on Configuration Parameters.
5. Customize the activation output in the **Output Mapping** panel.


![](/assets/ouput.b2c7f1d909c4f98ed10f5300df858a4b19f71a3b0834df952f5fb24018a5ea78.8ebdf569.png)

- Attribute Columns
  - Select **Export All Columns** to export all columns without making any changes.
  - Select **+ Add Columns** to add specific columns for the export. The Output Column Name pre-populates with the same Source column name. You can update the Output Column Name. Continue to select **+ Add Columns**to add new columns for your activation output.
- String Builder
  - **+ Add string** to create strings for export. Select from the following values:
    - String: Choose any value; use text to create a custom value.
    - Timestamp: The date and time of the export.
    - Segment Id: The segment ID number.
    - Segment Name: The segment name.
    - Audience Id: The parent segment number.


1. Set a **Schedule**.


![](/assets/snippet-output-connector-on-audience-studio-2024-08-28.a99525173709da1eb537f839019fa7876ffae95045154c8f2941b030022f792c.8ebdf569.png)

- Select the values to define your schedule and optionally include email notifications.


1. Select **Create**.


If you need to create an activation for a batch journey, review [Creating a Batch Journey Activation](/products/customer-data-platform/journey-orchestration/batch/creating-a-batch-journey-activation).

## (Optional) Export Integration Using the CLI

You can also use CLI(Toolbelt) for Result Export to Iterable.

You need to specify the information for export to your Iterable server as the `--result` option of `td query` command. About `td query` command, you can refer to [this article](https://docs.treasuredata.com/display/PD/TD+Toolbelt+Job+and+Query+Command+Reference).

The format of the option is JSON and the general structure is as follows.


```
{  "type" : "iterable"  "api_key" : "xxxxxxxxxxxxxx"  region : "us" # or eu  action: "remove" # or add  list_id: "xxxxxxxxxxx"  channel_unsubscribe: "false"  skip_invalid_data: "true"}
```

### Parameters

| Name | Description | Value | Default Value | Required |
|  --- | --- | --- | --- | --- |
| type | Describe the name of the service as the destination of export. | Iterable | N/A | Yes |
| api_key | The API Key to access the Data Center | API Key | N/A | Yes |
| region | The region of the Data Center | Region | US | No |
| action | The action to export data | Add or remove | N/A | Yes |
| list_id | The list ID | List ID | N/A | Yes |
| skip_on_invalid_records | Skip invalid records and don't fail the job | true or false | false | No |
| channel_unsubcribe​ | The channel unsubscribe | true or false | false | ​ No |


### Example for Usage


```
$ td query --result '{"type":"iterable","api_key":"xxx","region":"us","action":"remove","list_id":"xxxx", "skip_on_invalid_records":true,"channel_unsubscribe": "false"}' -d sample_datasets "select * from www_access" -T presto
```

## Example Workflow for Iterable

The action accepts the following values:

- Add
- Remove



```
_export:  td:  database: td.database+iterable_export_task:  td>: export_iterable.sql  database: ${td.database}  result_connection: iterable  result_settings:    type: iterable    region : us # or eu    action: add    list_id: 769207    skip_invalid_data: false
```

## References

- API Overview: [https://api.iterable.com/api/docs](https://api.iterable.com/api/docs)