> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/iterable.md).

# Iterable

Iterable is a cross-channel marketing platform. Update user profiles, track custom events, send transactional email, manage list subscriptions, and trigger journeys from your AI workflows.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Iterable  | API Key        |

#### Iterable

Connect to Iterable to update users, track events, send email, and trigger journeys.

**Set up in Iterable**

1. Prepare the Iterable account or service that the workflow will access. Grant access to the required resources and operations.
2. Create or obtain the API credential identified in the fields below. Use the provider instructions linked with those fields to find its key-management page.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Iterable**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required                 | What to enter                                                                                                                                                                                                           |
| ------------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API Key       | Yes                      | A Server-side API key with Standard permissions (Integrations -> API Keys). Client-side (Mobile, Web, JavaScript) keys cannot call these endpoints. [Provider instructions](https://app.iterable.com/settings/apiKeys). |
| Data Center   | Optional / as applicable | 'us' (api.iterable.com, default) or 'eu' (api.eu.iterable.com). Keys only work against the data center that issued them.                                                                                                |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Iterable** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Update User Profile

Create or update an Iterable user's profile fields.

**Inputs**

| Field                  | Type    | Required | Description                                                               |
| ---------------------- | ------- | -------- | ------------------------------------------------------------------------- |
| Email                  | string  | No       | Email of the user to update. Provide email or user ID, not both.          |
| User ID                | string  | No       | Iterable userId of the user. Provide email or user ID, not both.          |
| Data Fields            | object  | Yes      | Profile fields to set, as a JSON object. Existing fields not listed stay. |
| Create User by User ID | boolean | No       | Create the user when the user ID does not exist yet. Default: true.       |
| Merge Nested Objects   | boolean | No       | Merge top-level objects instead of overwriting them. Default: false.      |
| Create New Fields      | boolean | No       | Add unknown fields to the schema. Defaults to the project setting.        |

**Outputs**

| Field      | Type   | Description                            |
| ---------- | ------ | -------------------------------------- |
| Code       | string | Iterable's response code.              |
| Message    | string | Iterable's response message.           |
| Identifier | string | The email or user ID that was updated. |

#### Track Custom Event

Track a custom event for an Iterable user.

**Inputs**

| Field             | Type            | Required | Description                                                                                  |
| ----------------- | --------------- | -------- | -------------------------------------------------------------------------------------------- |
| Event Name        | string          | Yes      | Name of the custom event.                                                                    |
| Email             | string          | No       | Email of the user. Provide email or user ID, not both.                                       |
| User ID           | string          | No       | Iterable userId of the user. Provide email or user ID, not both.                             |
| Data Fields       | object          | No       | Event properties, as a JSON object.                                                          |
| Event ID          | string          | No       | Optional unique ID. Reusing it updates the same event instead of duplicating it.             |
| Occurred At       | datetime        | No       | When the event happened. Defaults to when Iterable receives it.                              |
| Campaign          | select (string) | No       | Campaign to attribute this event (conversion) to. Options load from the selected connection. |
| Template ID       | integer         | No       | Template to attribute this event to.                                                         |
| Create New Fields | boolean         | No       | Add unknown fields to the schema. Defaults to the project setting.                           |

**Outputs**

| Field    | Type   | Description                              |
| -------- | ------ | ---------------------------------------- |
| Code     | string | Iterable's response code.                |
| Message  | string | Iterable's response message.             |
| Event ID | string | The event ID that was submitted, if any. |

#### Send Transactional Email

Send a triggered Iterable email campaign to one recipient.

**Inputs**

| Field                        | Type            | Required | Description                                                                              |
| ---------------------------- | --------------- | -------- | ---------------------------------------------------------------------------------------- |
| Triggered Campaign           | select (string) | Yes      | The triggered email campaign to send. Options load from the selected connection.         |
| Recipient Email              | string          | No       | Recipient email. Provide email or user ID, not both.                                     |
| Recipient User ID            | string          | No       | Recipient Iterable userId. Provide email or user ID, not both.                           |
| Data Fields                  | object          | No       | Values merged into the email template. They override profile fields.                     |
| Send At                      | datetime        | No       | Schedule the send up to 365 days ahead. Empty sends now.                                 |
| Allow Repeat Marketing Sends | boolean         | No       | Allow sending even if this user already received this marketing campaign. Default: true. |
| Metadata                     | object          | No       | Data passed back through Iterable webhooks. Not used for rendering.                      |

**Outputs**

| Field       | Type    | Description                                 |
| ----------- | ------- | ------------------------------------------- |
| Code        | string  | Iterable's response code.                   |
| Message     | string  | Iterable's response message.                |
| Campaign ID | integer | The campaign that was sent.                 |
| Recipient   | string  | The email or user ID the email was sent to. |

#### Subscribe Users to List

Add up to 1000 users to an Iterable static list.

**Inputs**

| Field               | Type            | Required | Description                                                                                  |
| ------------------- | --------------- | -------- | -------------------------------------------------------------------------------------------- |
| List                | select (string) | Yes      | The static list to add users to. Options load from the selected connection.                  |
| Subscribers         | array           | Yes      | Emails and/or user IDs to add. Entries containing '@' are treated as emails.                 |
| Existing Users Only | boolean         | No       | Skip identifiers that don't match an existing user instead of creating them. Default: false. |

**Outputs**

| Field          | Type    | Description                                 |
| -------------- | ------- | ------------------------------------------- |
| Success Count  | integer | Users added to the list.                    |
| Fail Count     | integer | Users that could not be added.              |
| Has Failures   | boolean | True when at least one user was not added.  |
| Failed Updates | object  | Identifiers that failed, grouped by reason. |

#### Trigger Journey

Enroll a user or a whole list in an Iterable journey.

**Inputs**

| Field       | Type            | Required | Description                                                                                                        |
| ----------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------ |
| Journey     | select (string) | Yes      | The journey to enroll users in. Options load from the selected connection.                                         |
| Email       | string          | No       | Email of the user to enroll. Provide one of email, user ID, or list.                                               |
| User ID     | string          | No       | Iterable userId to enroll. Provide one of email, user ID, or list.                                                 |
| List        | select (string) | No       | Enroll every user in this list. Provide one of email, user ID, or list. Options load from the selected connection. |
| Data Fields | object          | No       | Data available to the journey for this trigger, as a JSON object.                                                  |

**Outputs**

| Field      | Type    | Description                                       |
| ---------- | ------- | ------------------------------------------------- |
| Code       | string  | Iterable's response code.                         |
| Message    | string  | Iterable's response message.                      |
| Journey ID | integer | The journey that was triggered.                   |
| Target     | string  | The email, user ID, or list ID that was enrolled. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/iterable.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
