> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Iterable

The Iterable connector lets your AI agent act in each user's Iterable account. Each user connects their own Iterable API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 62 tools.

**Authentication:** API Key
**Categories:** Marketing, Communication
**Tools:** 62: 22 read, 30 write, 10 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=ITERABLE)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Iterable connection

   In **AgentKit > Connections**, create an Iterable connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'iterable'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Iterable:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'iterable_campaigns_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "iterable"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Iterable:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="iterable_campaigns_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Iterable credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'iterable_campaign_get',
  toolInput: {
    id: 12345,
  },
  connector: 'iterable',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="iterable_campaign_get",
    tool_input={
        "id": 12345,
    },
    connection_name="iterable",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `iterable_campaign_get`

Get a campaign · Read-only

Get a campaign by ID. Rate limit: 100 requests/second, per project.
Returns an object with campaignState, createdAt, createdByUserId, endedAt, id, labelIds, labels, listIds, messageMedium, name, recurringCampaignId, sendSize and more.
Use this when you have the ID. Use iterable_campaigns_list to find one.
Needs id from iterable_campaigns_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Campaign ID. Example: 12345

Example input: `{"id":12345}`

### `iterable_campaigns_list`

List campaign metadata · Read-only

Get metadata about campaigns in a project. Use page and pageSize parameters to paginate results.
Returns an object with campaigns, nextPageUrl, previousPageUrl, totalCampaignsCount.
Use this to browse. Use iterable_campaign_get when you already have the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `campaignState` (`array`, optional): Filter campaigns by state. Can be specified multiple times to filter by multiple states. Valid states: Draft, Ready, Scheduled, Running, Finished, Starting, Aborted, Recurring, Archived. Example: ?campaignState=Ready&campaignState=Running
- `page` (`integer`, optional): Page number (starting at 1). Example: 1
- `pageSize` (`integer`, optional): Number of results to return per page (defaults to 20, maximum of 1000). Example: 10
- `sort` (`string`, optional): Field to sort campaigns by, with optional direction prefix. Use - for descending, + or no prefix for ascending. Campaigns can be sorted by id, name, createdAt, updatedAt, or startAt. Examples: -createdAt, +name, id

Example input: `{}`

### `iterable_catalog_field_mappings_get`

Get field mappings for a catalog · Read-only

Field mappings (field to data types) and undefined fields of a catalog
Returns an object with definedMappings, undefinedFields.
Needs catalogName from iterable_catalogs_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `catalogName` (`string`, required): Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]. Example: products

Example input: `{"catalogName":"<catalogName>"}`

### `iterable_catalog_item_get`

Get a specific catalog item · Read-only

Get a specific catalog item from the given catalog.
Returns an object with catalogName, itemId, lastModified, size, value.
Use this when you have the ID. Use iterable_catalog_items_list to find one.
Needs catalogName from iterable_catalogs_list; itemId from iterable_catalog_items_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `catalogName` (`string`, required): Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]. Example: products
- `itemId` (`string`, required): Catalog item id [Alphanumeric, dashes, case sensitive, 255 characters max]. Example: sku-1

Example input: `{"catalogName":"<catalogName>","itemId":"<itemId>"}`

### `iterable_catalog_items_list`

Get the catalog items for a catalog · Read-only

Get the catalog items for a catalog. Rate limit: 100 requests/second, per API key.
Returns an object with catalogItemsWithProperties, nextPageUrl, previousPageUrl, totalItemsCount.
Use this to browse. Use iterable_catalog_item_get when you already have the ID.
Needs catalogName from iterable_catalogs_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `catalogName` (`string`, required): Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]. Example: products
- `orderBy` (`string`, optional): Field by which results should be ordered. To also use the sortAscending parameter, this field must have a defined type. Example: itemId
- `page` (`integer`, optional): Page number to list (starting at 1). Example: 1
- `pageSize` (`integer`, optional): Number of results to display per page (defaults to 10). Example: 10
- `sortAscending` (`boolean`, optional): Sort results by ascending (Defaults to false). Example: false

Example input: `{"catalogName":"<catalogName>"}`

### `iterable_catalogs_list`

Get catalog names · Read-only

Get catalog names. Rate limit: 100 requests/second, per API key.
Returns an object with catalogNames, nextPageUrl, previousPageUrl, totalCatalogsCount.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page number to list (starting at 1). Example: 1
- `pageSize` (`integer`, optional): Number of results to display per page (defaults to 10). Example: 10

Example input: `{}`

### `iterable_channels_list`

Get channels · Read-only

Get all message channels within the project. Rate limit: 100 requests/second, per project.
Returns channels, an array of items with channelType, id, messageMedium, name.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `iterable_email_template_get`

Get an email template by templateId · Read-only

Get an email template by templateId, including subject, HTML, sender details and data feed settings.
Returns an object with bccEmails, cacheDataFeed, campaignDataFields, ccEmails, clientTemplateId, creatorUserId, dataFeedId, dataFeedIds, fromEmail, fromName, googleAnalyticsCampaignName, html and more.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `templateId` (`integer`, required): Template ID. Example: 12345
- `locale` (`string`, optional): Locale of content to get. Example: en-US

Example input: `{"templateId":12345}`

### `iterable_inapp_template_get`

Get In-App Template · Read-only

Get an in-app template.
Returns an object with campaignDataFields, campaignId, clientTemplateId, expirationDateTime, expirationDuration, html, inAppDisplaySettings, inboxMetadata, isDefaultLocale, locale, messageTypeId, name and more.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `templateId` (`integer`, required): Template ID. Example: 12345
- `locale` (`string`, optional): Locale of content to get. Example: en-US

Example input: `{"templateId":12345}`

### `iterable_journeys_list`

Get journeys (workflows) · Read-only

Get a list of the journeys within your project.
Returns an object with journeys, nextPageUrl, previousPageUrl, totalJourneysCount.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page number (starting at 1). Example: 1
- `pageSize` (`integer`, optional): Number of results to return per page (defaults to 10, maximum of 50). Example: 10
- `sort` (`string`, optional): Sort field with optional direction prefix. Use - for descending, + or no prefix for ascending. Examples: -createdAt, +name, id
- `state` (`array`, optional): Without this parameter, the endpoint returns all non-archived journeys. With state set to Archived, the endpoint only returns archived journeys. Example: ["Running"]

Example input: `{}`

### `iterable_list_size_get`

Get List Size · Read-only

Get the number of users within a list. Rate limit: 5 requests/minute, per project.
Returns the JSON response from Iterable.
Needs listId from iterable_lists_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `listId` (`integer`, required): list id. Example: 12345

Example input: `{"listId":12345}`

### `iterable_lists_list`

Get lists · Read-only

Get all lists within a project. Rate limit: 100 requests/second, per project.
Returns an object with lists.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `iterable_message_types_list`

List message types · Read-only

List all message types within a project. Rate limit: 100 requests/second, per project.
Returns an object with messageTypes.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `iterable_push_template_get`

Get a push template · Read-only

Get a push template by templateId, including title, message, buttons and deep links.
Returns an object with badge, buttons, cacheDataFeed, campaignDataFields, campaignId, clientTemplateId, createdAt, dataFeedIds, deeplink, defaultAction, interruptionLevel, isDefaultLocale and more.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `templateId` (`integer`, required): Template ID. Example: 12345
- `locale` (`string`, optional): Locale of content to get. Example: en-US

Example input: `{"templateId":12345}`

### `iterable_sms_template_get`

Get an SMS template · Read-only

Get an SMS template by templateId, including the message and sender number.
Returns an object with campaignDataFields, campaignId, clientTemplateId, createdAt, fromPhoneNumberId, googleAnalyticsCampaignName, imageUrl, isDefaultLocale, linkParams, locale, message, messageTypeId and more.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `templateId` (`integer`, required): Template ID. Example: 12345
- `locale` (`string`, optional): Locale of content to get. Example: en-US

Example input: `{"templateId":12345}`

### `iterable_templates_list`

Get project templates · Read-only

Get templates for a project. Use page and pageSize parameters to paginate results.
Returns templates, an array of items with campaignId, clientTemplateId, createdAt, creatorUserId, messageTypeId, name, templateId, updatedAt, plus nextPageUrl, previousPageUrl, totalTemplatesCount.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `endDateTime` (`string`, optional): Get templates created before this date time (yyyy-MM-dd HH:mm:ss [ZZ]) Example: 2026-01-15T09:30:00Z
- `messageMedium` (`string`, optional): Only retrieve templates associated with this message medium. Example: Email. One of: `Email`, `Push`, `InApp`, `SMS`.
- `page` (`integer`, optional): Page number (starting at 1). Example: 1
- `pageSize` (`integer`, optional): Number of results to return per page (defaults to 20, maximum of 1000). Example: 20
- `sort` (`string`, optional): Field to sort templates by, with optional direction prefix. Use - for descending, + or no prefix for ascending. Templates can be sorted by id, name, createdAt, or updatedAt. Examples: -createdAt, +name, id
- `startDateTime` (`string`, optional): Get templates created at or after this date time (yyyy-MM-dd HH:mm:ss [ZZ]) Example: 2026-01-15T09:30:00Z
- `templateType` (`string`, optional): Only retrieve templates associated with this template type. Example: Base. One of: `Base`, `Blast`, `Triggered`, `Workflow`.

Example input: `{}`

### `iterable_user_events_by_email_get`

Get User Events by Email · Read-only

Get events for a specific user, by email. On Iterable's API Documentation page, this endpoint does not work for email values that contain a / character.
Returns an object with events.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `email` (`string`, required): Email of the user whose events you are retrieving. Example: jane@example.com
- `limit` (`integer`, optional): The number of events to retrieve. (Max is 200) Example: 30

Example input: `{"email":"<email>"}`

### `iterable_user_events_by_user_id_get`

Get User Events by User ID · Read-only

Get events for a specific user, by userId. On Iterable's API Documentation page, this endpoint does not work for userId values that contain a / character.
Returns an object with events.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `userId` (`string`, required): UserId of the user whose events you are retrieving. Example: 12345
- `limit` (`integer`, optional): The number of events to retrieve. (Max is 200) Example: 30

Example input: `{"userId":"<userId>"}`

### `iterable_user_fields_list`

List User Fields · Read-only

Get all user fields within a project. Rate limit: 3 requests/second, per project.
Returns an object with fields.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `iterable_user_get_by_email`

Get User by Email · Read-only

Get a user by email address (passed as a query parameter).
Returns an object with user.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `email` (`string`, optional): The user's email address. Example: jane@example.com

Example input: `{}`

### `iterable_user_get_by_user_id`

Get User by User ID · Read-only

Get a user by userId (passed as a query parameter).
Returns an object with user.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `userId` (`string`, optional): The user's userId in your Iterable project. Example: user-123

Example input: `{}`

### `iterable_user_sent_messages_list`

List Messages Sent to User · Read-only

Get messages sent to a user, by email address or userId.
Returns messages, an array of items with campaignId, createdAt, messageId, templateId.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `campaignIds` (`array`, optional): only include messages from these campaigns. Example: [12345]
- `email` (`string`, optional): user's email, either email or userId must be specified. Example: jane@example.com
- `endDateTime` (`string`, optional): end date time (yyyy-MM-dd HH:mm:ss ZZ) Example: 2026-01-15T09:30:00Z
- `excludeBlastCampaigns` (`boolean`, optional): exclude results coming from blast campaigns (ignored if campaignId is set) Example: false
- `limit` (`integer`, optional): max number of messages to return (default: 10, max limit: 1000) Example: 10
- `messageMedium` (`string`, optional): only include messages of this type. Example: Email. One of: `Email`, `Push`, `InApp`, `SMS`.
- `startDateTime` (`string`, optional): start date time (yyyy-MM-dd HH:mm:ss ZZ) Example: 2026-01-15T09:30:00Z
- `userId` (`string`, optional): user's userId, either email or userId must be specified. Example: 12345

Example input: `{}`

### `iterable_campaign_create`

Create a campaign · Write

Create a new blast or triggered campaign from an existing template.
Returns an object with campaignId.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `listIds` (`array`, required): To create a blast campaign, set listIds to a non-empty array of list IDs to which the campaign should be sent. To create a triggered campaign, omit listIds from the request body. Example: [12345]
- `name` (`string`, required): The name to use in Iterable for the new campaign. Example: Scalekit test
- `templateId` (`number`, required): The ID of a template to associate with the new campaign. The new campaign receives a copy of this template. Example: 12345
- `campaignDataFields` (`object`, optional): A JSON object containing campaign-level data fields that are available as merge parameters (for example, {{field}}) during message rendering. These fields are available in templates, data feed URLs, and all other contexts where merge parameters are supported. Campaign-level fields are overridden by user and event data fields of the same name. Example: {"promo_code": "SPRING25"}
- `dataFields` (`object`, optional): A JSON object containing data to be statically rendered into the base template at creation time using double square brackets (for example, [[field]]). These values replace the placeholders in the base template and are baked into the campaign template, and cannot be changed later. Supported by email campaigns only. Example: {"orderId": "A-1001", "firstName": "Jane"}
- `defaultTimeZone` (`string`, optional): For a scheduled blast campaign, when sendMode is RecipientTimeZone, defaultTimeZone specifies the time zone to use when sending to recipients without a known time zone. IANA format (for example, America/Los_Angeles). For more details, see our API Overview.
- `labelIds` (`array`, optional): An optional array of label IDs to associate with the new campaign. Labels must exist in the project. Maximum 50 labels allowed. Example: [12345]
- `scheduleSend` (`boolean`, optional): Whether to immediately schedule the blast campaign for sending. Defaults to true. Set to false to create the campaign without scheduling it (the campaign can be scheduled later using POST /api/campaigns/{campaignId}/schedule). Only applies to blast campaigns. Example: false
- `sendAt` (`string`, optional): A scheduled send time for a new blast campaign, up to 21 days in the future. Format: YYYY-MM-DD HH:MM:SS (UTC). For more details, see our API Overview. Example: 2026-12-01 15:00:00 +00:00
- `sendMode` (`string`, optional): When creating a blast campaign, set sendMode to RecipientTimeZone to have Iterable send the campaign to each recipient at a given local time in their own time zone — the same local time associated with sendAt (UTC) in startTimeZone. Or set sendMode to ProjectTimeZone (default value) to have Iterable send the campaign to all recipients at the UTC time specified by sendAt, regardless of local time zone. For more details, see our API Overview. Example: ProjectTimeZone. One of: `ProjectTimeZone`, `RecipientTimeZone`.
- `shortenLinks` (`boolean`, optional): Whether links in the campaign template should be shortened. Returns HTTP 400 if true when link shortening is not enabled for the project. Omitted or false is ignored. Example: false
- `startTimeZone` (`string`, optional): For a scheduled blast campaign, when sendMode is RecipientTimeZone, Iterable sends the campaign at the same local time in all recipient time zones — starting with startTimeZone. Recipients in time zones to the east of startTimeZone receive the campaign simultaneously with recipients in startTimeZone, and recipients in time zones to the west of startTimeZone receive the campaign when the same local time arrives in their own time zone. IANA format (for example, America/New_York). For more details, see our API Overview.
- `suppressionListIds` (`array`, optional): An array of suppression list IDs to associate with a new blast campaign. Example: [12345]

Example input: `{"listIds":[12345],"name":"<name>","templateId":12345}`

### `iterable_campaign_schedule`

Schedule existing campaign to be sent · Write

Schedule existing campaign to be sent.
Returns an object with code, msg, params.
Needs campaignId from iterable_campaigns_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `campaignId` (`integer`, required): The campaign ID to attribute this to, or to act on. Example: 12345
- `sendAt` (`string`, required): When to send up to 7 days in the future. ISO-8601 date time format (e.g. 2007-12-03T10:15:30.00Z) Example: 2026-12-01 15:00:00 +00:00
- `recipientTimeZone` (`object`, optional): If provided, send campaign based on recipient time zone. If not, default to the project time zone. Example: {"defaultTimeZone": "America/New_York", "startTimeZone": "America/New_York"}

Example input: `{"campaignId":12345,"sendAt":"<sendAt>"}`

### `iterable_campaign_send`

Send existing campaign now · Write

Send existing campaign now.
Returns an object with code, msg, params.
Needs campaignId from iterable_campaigns_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `campaignId` (`integer`, required): The campaign ID to attribute this to, or to act on. Example: 12345

Example input: `{"campaignId":12345}`

### `iterable_campaign_trigger`

Trigger a campaign · Write

Trigger a triggered campaign to send to one or more lists, with optional dataFields.
Returns an object with code, msg, params.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `campaignId` (`integer`, required): The campaign ID to attribute this to, or to act on. Example: 12345
- `listIds` (`array`, required): A non-empty array of list IDs to send to. Example: [12345]
- `allowRepeatMarketingSends` (`boolean`, optional): Allow repeat marketing sends? Defaults to true. Example: false
- `dataFields` (`object`, optional): Fields to merge into handlebars context. Example: {"orderId": "A-1001", "firstName": "Jane"}
- `suppressionListIds` (`array`, optional): Lists to suppress. Example: [12345]

Example input: `{"campaignId":12345,"listIds":[12345]}`

### `iterable_campaigns_archive`

Archive Campaigns · Write

Archive one or more campaigns. This endpoint behaves the same as the archive feature in the UI.
Returns an empty response on success (HTTP 200).

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `campaignIds` (`array`, required): Campaign IDs to archive. Example: [12345]

Example input: `{"campaignIds":[12345]}`

### `iterable_cart_update`

Update a user's shopping cart items · Write

Update the shoppingCartItems field on the user profile with shopping cart items.
Returns an object with code, msg, params.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `items` (`array`, required): The items in the purchase or cart, each with id, name, price and quantity. Example: [{"id": "sku-1", "name": "T-shirt", "price": 25, "quantity": 1}]
- `user` (`object`, required): The user making the purchase or owning the cart: email or userId, and optional dataFields. Example: {"email": "jane@example.com"}

Example input: `{"items":[{"id":"sku-1","name":"T-shirt","price":25,"quantity":1}],"user":{"email":"jane@example.com"}}`

### `iterable_catalog_create`

Create a catalog · Write

Create a catalog. Each catalog in a project must have a unique name.
Returns an object with code, msg, params.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `catalogName` (`string`, required): Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]. Example: products

Example input: `{"catalogName":"<catalogName>"}`

### `iterable_catalog_field_mappings_update`

Set a catalog's field mappings (data types) · Write

Set a catalog's field mappings (data types). After being set, a given field's data type may not be changed.
Returns an empty response on success (HTTP 200).
The request replaces the stored value with what you send.
Needs catalogName from iterable_catalogs_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `catalogName` (`string`, required): Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]. Example: products
- `mappingsUpdates` (`array`, required): mappingsUpdates. Example: [{"fieldName": "price", "fieldType": "double"}]

Example input: `{"catalogName":"<catalogName>","mappingsUpdates":[{"fieldName":"price","fieldType":"double"}]}`

### `iterable_catalog_item_replace`

Create or Replace Catalog Item · Write

Create or replace a catalog item. Asynchronous. Create or replace the specified catalog item in the given catalog.
Returns an object with code, msg, params.
The request replaces the stored value with what you send.
Needs catalogName from iterable_catalogs_list; itemId from iterable_catalog_items_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `catalogName` (`string`, required): Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]. Example: products
- `itemId` (`string`, required): Catalog item id [Alphanumeric, dashes, case sensitive, 255 characters max]. Example: sku-1
- `value` (`object`, required): JSON representation of the catalog item. Max size is is 30kb. Example: {"name": "T-shirt", "price": 25}

Example input: `{"catalogName":"<catalogName>","itemId":"<itemId>","value":{"name":"T-shirt","price":25}}`

### `iterable_catalog_item_update`

Create or Update Catalog Item · Write

Create or update a catalog item. Asynchronous. Create or update the specified catalog item in the given catalog.
Returns an object with code, msg, params.
Only the fields you pass change; omitted fields keep their current values.
Needs catalogName from iterable_catalogs_list; itemId from iterable_catalog_items_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `catalogName` (`string`, required): The catalog name. Example: products
- `itemId` (`string`, required): The catalog item ID. Example: sku-1
- `update` (`object`, required): JSON representation of the catalog item fields to update. Max size is is 30kb. Example: {"price": 22}

Example input: `{"catalogName":"<catalogName>","itemId":"<itemId>","update":{"price":22}}`

### `iterable_email_send`

Send Email to User · Write

Send an email from an existing email campaign to one user, identified by email or userId, with optional dataFields for the template and an optional sendAt time.
Returns msg, code and params; code Success means Iterable accepted the send.
Use this for a transactional one-to-one send. The campaign must be a triggered email campaign; use iterable_campaign_trigger to send a campaign to a list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `campaignId` (`integer`, required): Campaign ID. Example: 12345
- `allowRepeatMarketingSends` (`boolean`, optional): Allow repeat marketing sends? Defaults to true. Example: false
- `dataFields` (`object`, optional): Fields to merge into email template. Example: {"orderId": "A-1001", "firstName": "Jane"}
- `metadata` (`object`, optional): Metadata to pass back via webhooks. Not used for rendering. Example: {"source": "scalekit"}
- `recipientEmail` (`string`, optional): An email address that identifies a user profile in Iterable. Provide a recipientEmail or a recipientUserId (but not both), depending on how your project identifies users. Example: jane@example.com
- `recipientUserId` (`string`, optional): A user ID that identifies a user profile in Iterable. Provide a recipientEmail or a recipientUserId (but not both), depending on how your project identifies users. Example: 12345
- `sendAt` (`string`, optional): Schedule the message for up to 365 days in the future. If set in the past, email is sent immediately. Format is YYYY-MM-DD HH:MM:SS in UTC. Example: 2026-12-01 15:00:00 +00:00

Example input: `{"campaignId":12345}`

### `iterable_email_template_proof_send`

Send Email Template Proof · Write

Send a proof of an email template to a specific user.
Returns an object with code, msg, params.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `templateId` (`integer`, required): Template ID to send proof for. Example: 12345
- `dataFields` (`object`, optional): Fields to merge into template for proof. Example: {"orderId": "A-1001", "firstName": "Jane"}
- `locale` (`string`, optional): Locale for the proof message. If provided, must be a valid locale for the project. If not provided, falls back to the user's locale, then to the project's default locale. Example: en-US
- `recipientEmail` (`string`, optional): An email address that identifies a user profile in Iterable. Provide a recipientEmail or a recipientUserId (but not both), depending on how your project identifies users. Example: jane@example.com
- `recipientUserId` (`string`, optional): A user ID that identifies a user profile in Iterable. Provide a recipientEmail or a recipientUserId (but not both), depending on how your project identifies users. Example: 12345

Example input: `{"templateId":12345}`

### `iterable_email_template_update`

Update email template · Write

Update email template.
Returns an object with code, msg, params.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `templateId` (`integer`, required): Email Template ID. Example: 12345
- `bccEmails` (`array`, optional): BCC emails. Example: ["audit@example.com"]
- `cacheDataFeed` (`object`, optional): Cache data feed lookups for 1 hour. Example: {"enabled": false}
- `campaignDataFields` (`object`, optional): Campaign-level data fields available as {{field}} merge parameters during message rendering. These fields are overridden by user and event data fields of the same name. Example: {"promo_code": "SPRING25"}
- `ccEmails` (`array`, optional): CC emails. Example: ["team@example.com"]
- `clientTemplateId` (`string`, optional): Client template ID. Used as a secondary key to reference the template. Example: 12345
- `creatorUserId` (`string`, optional): Creator User Id. Example: 12345
- `dataFeedId` (`number`, optional): [Deprecated - use dataFeedIds instead] Id for data feed used in template rendering. Example: 12345
- `dataFeedIds` (`array`, optional): Ids for data feeds used in template rendering. Example: [12345]
- `fromEmail` (`string`, optional): From email (must be an authorized sender) Example: orders@acme.example
- `fromName` (`string`, optional): From name. Example: Acme
- `googleAnalyticsCampaignName` (`string`, optional): Google analytics utm_campaign value. Example: spring_sale
- `html` (`string`, optional): HTML contents. Example: Hello from Scalekit

- `isDefaultLocale` (`boolean`, optional): Ask your Iterable CSM to enroll you in the beta for this feature. Identifies if the locale associated with the response is the template’s default. If empty or flexible default locales are not enabled for the project, the project’s default locale is assigned. Example: false
- `linkParams` (`array`, optional): Parameters to append to each URL in html contents. Example: [{"key": "utm_source", "value": "iterable"}]
- `locale` (`string`, optional): The locale for the content in this request. Leave empty for default locale. Iterable will automatically send the content with locale that matches a 'locale' field in the user profile. Example: en-US
- `mergeDataFeedContext` (`object`, optional): Merge data feed contents into user context, so fields be referenced by {{field}} instead of [[field]]. Example: {"enabled": false}
- `messageTypeId` (`number`, optional): Message Type Id. Example: 12345
- `name` (`string`, optional): Name of the template. Example: Scalekit test
- `plainText` (`string`, optional): Plain text contents. Example: Your order shipped.
- `preheaderText` (`string`, optional): Preheader text. Example: Tracking inside
- `replyToEmail` (`string`, optional): Reply to email. Example: support@acme.example
- `shortenLinks` (`boolean`, optional): Whether links in the template should be shortened. Returns HTTP 400 if true when link shortening is not enabled for the project. Example: false
- `subject` (`string`, optional): Subject. Example: Hello from Scalekit

Example input: `{"templateId":12345}`

### `iterable_email_template_upsert`

Create or Update Email Template · Write

Create email template if it doesn't exist already, otherwise update all email templates that match the name provided.
Returns an object with code, msg, params.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `clientTemplateId` (`string`, required): ID used by the client to identify a template. If multiple templates exist with the ID, all will be updated. Example: 12345
- `bccEmails` (`array`, optional): BCC emails. Example: ["audit@example.com"]
- `cacheDataFeed` (`object`, optional): Cache data feed lookups for 1 hour. Example: {"enabled": false}
- `campaignDataFields` (`object`, optional): Campaign-level data fields available as {{field}} merge parameters during message rendering. These fields are overridden by user and event data fields of the same name. Example: {"promo_code": "SPRING25"}
- `ccEmails` (`array`, optional): CC emails. Example: ["team@example.com"]
- `creatorUserId` (`string`, optional): Specify a specific creator user id (email). The email must be an existing member of the project. Defaults to the organization creator. Example: 12345
- `dataFeedId` (`integer`, optional): [Deprecated - use dataFeedIds instead] Id for data feed used in template rendering. Example: 12345
- `dataFeedIds` (`array`, optional): Ids for data feeds used in template rendering. Example: [12345]
- `fromEmail` (`string`, optional): From email (must be an authorized sender) Example: orders@acme.example
- `fromName` (`string`, optional): From name. Example: Acme
- `googleAnalyticsCampaignName` (`string`, optional): Google analytics utm_campaign value. Example: spring_sale
- `html` (`string`, optional): HTML contents. Example: Hello from Scalekit

- `isDefaultLocale` (`boolean`, optional): Ask your Iterable CSM to enroll you in the beta for this feature. Sets the locale associated with the request content as the template’s default. If empty or flexible default locales are not enabled for the project, the project’s default locale is assigned. Example: false
- `linkParams` (`array`, optional): Parameters to append to each URL in html contents. Example: [{"key": "utm_source", "value": "iterable"}]
- `locale` (`string`, optional): The locale for the content in this request. Iterable will automatically pick the content with locale that matches a 'locale' field in the user profile. Example: en-US
- `mergeDataFeedContext` (`boolean`, optional): Merge data feed contents into user context, so fields be referenced by {{field}} instead of [[field]]. Example: false
- `messageTypeId` (`integer`, optional): Message Type Id. Example: 12345
- `name` (`string`, optional): Name of the template. Example: Scalekit test
- `plainText` (`string`, optional): Plain text contents. Example: Your order shipped.
- `preheaderText` (`string`, optional): Preheader text. Example: Tracking inside
- `replyToEmail` (`string`, optional): Reply to email. Example: support@acme.example
- `shortenLinks` (`boolean`, optional): Whether links in the template should be shortened. Returns HTTP 400 if true when link shortening is not enabled for the project. Example: false
- `subject` (`string`, optional): Subject. Example: Hello from Scalekit

Example input: `{"clientTemplateId":"<clientTemplateId>"}`

### `iterable_event_track`

Track an event · Write

Track an event. Events are created asynchronously and processed separately from single event (non-bulk) endpoint.
Returns an object with code, msg, params.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `eventName` (`string`, required): Name of event. Example: order_shipped
- `campaignId` (`integer`, optional): Campaign tied to conversion. Example: 12345
- `createdAt` (`integer`, optional): Time event happened. Set to the time event was received if unspecified. Expects a unix timestamp. Example: 1767225600
- `createNewFields` (`boolean`, optional): Whether new fields should be ingested and added to the schema. Defaults to project's setting to allow or drop unrecognized fields. Example: false
- `dataFields` (`object`, optional): Additional data associated with event (i.e. item amount, item quantity). For events of the same name, identically named data fields must be of the same type. Example: {"orderId": "A-1001", "firstName": "Jane"}
- `email` (`string`, optional): An email address that identifies a user profile in Iterable. Provide an email or a userId (but not both), depending on how your project identifies users. Example: jane@example.com
- `id` (`string`, optional): Optional event id. If an event exists with that id, the event will be updated. If none is specified, a new id will automatically be generated and returned. Note that this ID cannot be longer than 512 bytes. Example: 12345
- `templateId` (`integer`, optional): Template id. Example: 12345
- `userId` (`string`, optional): A user ID that identifies a user profile in Iterable. Provide an email or a userId (but not both), depending on how your project identifies users. Example: 12345

Example input: `{"eventName":"<eventName>"}`

### `iterable_events_bulk_track`

Bulk Track Events · Write

Bulk track events. Events are created asynchronously and processed separately from single event (non-bulk) endpoint.
Returns an object with createdFields, disallowedEventNames, failCount, failedUpdates, filteredOutFields, invalidEmails, invalidUserIds, successCount.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `events` (`array`, required): The events to track, each with eventName, email or userId, and optional dataFields and createdAt. Example: [{"eventName": "order_shipped", "email": "jane@example.com"}]

Example input: `{"events":[{"eventName":"order_shipped","email":"jane@example.com"}]}`

### `iterable_inapp_send`

Send In-App Message to User · Write

Send an in-app message from an existing in-app campaign to one user, identified by email or userId, with optional dataFields for the template and an optional sendAt time.
Returns msg, code and params; code Success means Iterable accepted the send.
Use this for a transactional one-to-one send. The campaign must be a triggered in-app campaign; use iterable_campaign_trigger to send a campaign to a list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `campaignId` (`integer`, required): Campaign ID. Example: 12345
- `allowRepeatMarketingSends` (`boolean`, optional): Allow repeat marketing sends? Defaults to true. Example: false
- `dataFields` (`object`, optional): Fields to merge into email template. Example: {"orderId": "A-1001", "firstName": "Jane"}
- `recipientEmail` (`string`, optional): An email address that identifies a user profile in Iterable. Provide a recipientEmail or a recipientUserId (but not both), depending on how your project identifies users. Example: jane@example.com
- `recipientUserId` (`string`, optional): A user ID that identifies a user profile in Iterable. Provide a recipientEmail or a recipientUserId (but not both), depending on how your project identifies users. Example: 12345
- `sendAt` (`string`, optional): Schedule the message for up to 365 days in the future. If set in the past, message is sent immediately. Format is YYYY-MM-DD HH:MM:SS in UTC. Example: 2026-12-01 15:00:00 +00:00

Example input: `{"campaignId":12345}`

### `iterable_journey_trigger`

Trigger Journey · Write

Trigger a journey (formerly known as workflow). Triggering with a list is asynchronous.
Returns an object with code, msg, params.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `workflowId` (`integer`, required): ID of journey (workflow) to trigger. Example: 12345
- `dataFields` (`object`, optional): Additional data associated triggering event. Example: {"orderId": "A-1001", "firstName": "Jane"}
- `email` (`string`, optional): An email address that identifies a user profile in Iterable. Provide an email or a userId (but not both), depending on how your project identifies users. Example: jane@example.com
- `listId` (`integer`, optional): (Optional) Trigger the journey for all users in a list (standard or dynamic) Example: 12345
- `userId` (`string`, optional): A user ID that identifies a user profile in Iterable. Provide an email or a userId (but not both), depending on how your project identifies users. Example: 12345

Example input: `{"workflowId":12345}`

### `iterable_list_create`

Create a static list · Write

Create a new static list.
Returns an object with listId.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): The list name. Example: January signups
- `description` (`string`, optional): A description of the list. Example: Customers who joined in January

Example input: `{"name":"<name>"}`

### `iterable_list_subscribe`

Add Subscribers to List · Write

Add specific subscribers to a list. Learn about identifying users by userId and email.
Returns an object with createdFields, failCount, failedUpdates, filteredOutFields, invalidEmails, invalidUserIds, successCount.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `listId` (`integer`, required): The ID of the list (from iterable_lists_list). Example: 12345
- `subscribers` (`array`, required): The users to add or remove, each with email or userId and optional dataFields. Example: [{"email": "jane@example.com"}]
- `updateExistingUsersOnly` (`boolean`, optional): Whether to skip operation when the request includes a userId or email that doesn't yet exist in the Iterable project. When true, Iterable ignores requests with unknown userIds and email addresses. When false, Iterable creates new users. Defaults to false. Only respected in API calls for userID-based and hybrid projects. Example: false

Example input: `{"listId":12345,"subscribers":[{"email":"jane@example.com"}]}`

### `iterable_purchase_track`

Track a purchase · Write

Track purchase events. shoppingCartItems field on the user profile is cleared.
Returns an object with code, msg, params.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `items` (`array`, required): The items in the purchase or cart, each with id, name, price and quantity. Example: [{"id": "sku-1", "name": "T-shirt", "price": 25, "quantity": 1}]
- `total` (`number`, required): Total order dollar amount. Example: 25.0
- `user` (`object`, required): The user making the purchase or owning the cart: email or userId, and optional dataFields. Example: {"email": "jane@example.com"}
- `campaignId` (`integer`, optional): The campaign ID to attribute this to, or to act on. Example: 12345
- `createdAt` (`integer`, optional): Time event happened. Set to the time event was received if unspecified. Expects a Unix timestamp. Example: 1767225600
- `dataFields` (`object`, optional): Additional fields to be tracked. Example: {"orderId": "A-1001", "firstName": "Jane"}
- `id` (`string`, optional): Optional purchase id. If a purchase exists with that id, the purchase will be updated. If none is specified, a new id will automatically be generated and returned. Note that this ID cannot be longer than 512 bytes. Example: 12345
- `templateId` (`integer`, optional): Used in AB testing attribution. Example: 12345

Example input: `{"items":[{"id":"sku-1","name":"T-shirt","price":25,"quantity":1}],"total":25,"user":{"email":"jane@example.com"}}`

### `iterable_push_send`

Send Push to User · Write

Send a push notification from an existing push campaign to one user, identified by email or userId, with optional dataFields for the template and an optional sendAt time.
Returns msg, code and params; code Success means Iterable accepted the send.
Use this for a transactional one-to-one send. The campaign must be a triggered push campaign; use iterable_campaign_trigger to send a campaign to a list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `campaignId` (`integer`, required): Campaign ID. Example: 12345
- `allowRepeatMarketingSends` (`boolean`, optional): Allow repeat marketing sends? Defaults to true. Example: false
- `dataFields` (`object`, optional): JSON object containing fields to merge into template. Example: {"orderId": "A-1001", "firstName": "Jane"}
- `metadata` (`object`, optional): Metadata to pass back via system webhooks. Not used for rendering. Example: {"source": "scalekit"}
- `recipientEmail` (`string`, optional): An email address that identifies a user profile in Iterable. Provide a recipientEmail or a recipientUserId (but not both), depending on how your project identifies users. Example: jane@example.com
- `recipientUserId` (`string`, optional): A user ID that identifies a user profile in Iterable. Provide a recipientEmail or a recipientUserId (but not both), depending on how your project identifies users. Example: 12345
- `sendAt` (`string`, optional): Schedule the message for up to 365 days in the future. If set in the past, message is sent immediately. Format is YYYY-MM-DD HH:MM:SS in UTC. Example: 2026-12-01 15:00:00 +00:00

Example input: `{"campaignId":12345}`

### `iterable_sms_send`

Send SMS to User · Write

Send an SMS from an existing SMS campaign to one user, identified by email or userId, with optional dataFields for the template and an optional sendAt time.
Returns msg, code and params; code Success means Iterable accepted the send.
Use this for a transactional one-to-one send. The campaign must be a triggered SMS campaign; use iterable_campaign_trigger to send a campaign to a list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `campaignId` (`integer`, required): Campaign ID. Example: 12345
- `allowRepeatMarketingSends` (`boolean`, optional): Allow repeat marketing sends? Defaults to true. Example: false
- `dataFields` (`object`, optional): Fields to merge into template. Example: {"orderId": "A-1001", "firstName": "Jane"}
- `recipientEmail` (`string`, optional): An email address that identifies a user profile in Iterable. Provide a recipientEmail or a recipientUserId (but not both), depending on how your project identifies users. Example: jane@example.com
- `recipientUserId` (`string`, optional): A user ID that identifies a user profile in Iterable. Provide a recipientEmail or a recipientUserId (but not both), depending on how your project identifies users. Example: 12345
- `sendAt` (`string`, optional): Schedule the message for up to 365 days in the future. If set in the past, message is sent immediately. Format is YYYY-MM-DD HH:MM:SS in UTC. Example: 2026-12-01 15:00:00 +00:00

Example input: `{"campaignId":12345}`

### `iterable_subscription_user_subscribe`

Subscribe User to Subscription Group · Write

Subscribe a user to the specified subscription group.
Returns an object with code, msg, params.
Only the fields you pass change; omitted fields keep their current values.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `subscriptionGroup` (`string`, required): Subscription group (i.e.: emailList, messageType, messageChannel) [Alphanumeric, case insensitive]. Example: emailList
- `subscriptionGroupId` (`integer`, required): Subscription Group Id [Numeric]. Example: 12345
- `userEmail` (`string`, required): User's Email [Alphanumeric]. Example: jane@example.com

Example input: `{"subscriptionGroup":"<subscriptionGroup>","subscriptionGroupId":12345,"userEmail":"<userEmail>"}`

### `iterable_user_email_update`

Update User Email · Write

Update a user's email. Use this endpoint with email-based projects.
Returns an object with code, msg, params.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `newEmail` (`string`, required): The new email address to assign to the specified user. Example: jane.doe@example.com
- `currentEmail` (`string`, optional): An email address that identifies a user profile in Iterable. Provide a currentEmail or a currentUserId (but not both), depending on how your project identifies users. Example: jane@example.com
- `currentUserId` (`string`, optional): A user ID that identifies a user profile in Iterable. Provide a currentEmail or a currentUserId (but not both), depending on how your project identifies users. Example: 12345

Example input: `{"newEmail":"<newEmail>"}`

### `iterable_user_subscriptions_update`

Update User Subscriptions · Write

Update user subscriptions. IMPORTANT: This endpoint overwrites (does not merge) existing data for any non-null fields specified in the request.
Returns an object with code, msg, params.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `campaignId` (`integer`, optional): Campaign to attribute unsubscribes. Example: 12345
- `email` (`string`, optional): An email address that identifies a user profile in Iterable. For each user in your request, provide an email or a userId (but not both), depending on how your project identifies users. Example: jane@example.com
- `emailListIds` (`array`, optional): Lists that a user is subscribed to. Example: [12345]
- `subscribedMessageTypeIds` (`array`, optional): Individual message type IDs to subscribe (does not impact channel subscriptions). To set a value for this field, first have your CSM enable the opt-in message types feature. Otherwise, attempting to set this field causes an error. Example: [12345]
- `templateId` (`integer`, optional): Template to attribute unsubscribes. Example: 12345
- `unsubscribedChannelIds` (`array`, optional): Email channel ids to unsubscribe from. Example: [12345]
- `unsubscribedMessageTypeIds` (`array`, optional): Individual message type IDs to unsubscribe (does not impact channel subscriptions). Example: [12345]
- `userId` (`string`, optional): A user ID that identifies a user profile in Iterable. For each user in your request, provide an email or a userId (but not both), depending on how your project identifies users. Example: 12345
- `validateChannelAlignment` (`boolean`, optional): Defaults to true (validation enabled). When false, allows subscribing users to message types that belong to unsubscribed channels. By default, Iterable validates that subscribed message types belong to subscribed channels. Setting this to false bypasses this validation, allowing you to save message type preferences even when the parent channel is unsubscribed. Users won't receive messages from these types while the channel remains unsubscribed, but their preferences are preserved for when the channel becomes subscribed. Example: false

Example input: `{}`

### `iterable_user_update`

Update User · Write

Update user data or adds a user if none exists. Data is merged - missing fields are not deleted.
Returns an object with code, msg, params.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `createNewFields` (`boolean`, optional): Whether new fields should be ingested and added to the schema. Defaults to project's setting to allow or drop unrecognized fields. Example: false
- `dataFields` (`object`, optional): Data to store on the user profile identified by userId or email. Example: {"orderId": "A-1001", "firstName": "Jane"}
- `email` (`string`, optional): An email address that identifies a user profile in Iterable. Provide an email or a userId (but not both), depending on how your project identifies users. Example: jane@example.com
- `mergeNestedObjects` (`boolean`, optional): Merge top-level objects instead of overwriting them. Defaults to false. For example, if a user profile has data {"mySettings":{"mobile":true}} and the request has data {"mySettings":{"email":true}}, merging results in {"mySettings":{"mobile":true,"email":true}}. Example: false
- `preferUserId` (`boolean`, optional): Whether or not a new user should be created if the request includes a userId that doesn't yet exist in the Iterable project. Defaults to false. Only respected in API calls for email-based projects. Example: false
- `userId` (`string`, optional): A user ID that identifies a user profile in Iterable. Provide an email or a userId (but not both), depending on how your project identifies users. Example: 12345

Example input: `{}`

### `iterable_users_bulk_update`

Bulk Update Users · Write

Bulk updates user data. This endpoint adds and overwrites user profile fields as needed.
Returns an object with createdFields, failCount, failedUpdates, filteredOutFields, invalidEmails, invalidUserIds, successCount.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `users` (`array`, required): The users to create or update, each with email or userId and optional dataFields. Up to 1000 per call. Example: [{"email": "jane@example.com", "dataFields": {"plan": "pro"}}]
- `createNewFields` (`boolean`, optional): Whether new fields should be ingested and added to the schema. Defaults to project's setting to allow or drop unrecognized fields. Added fields will be included in the response's createdFields. Dropped fields will be included in filteredOutFields and not added to user profiles. Example: false

Example input: `{"users":[{"email":"jane@example.com","dataFields":{"plan":"pro"}}]}`

### `iterable_web_push_send`

Send Web Push to User · Write

Send a web push notification from an existing web push campaign to one user, identified by email or userId, with optional dataFields for the template and an optional sendAt time.
Returns msg, code and params; code Success means Iterable accepted the send.
Use this for a transactional one-to-one send. The campaign must be a triggered web push campaign; use iterable_campaign_trigger to send a campaign to a list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `campaignId` (`integer`, required): The campaign ID to attribute this to, or to act on. Example: 12345
- `allowRepeatMarketingSends` (`boolean`, optional): Allow repeat marketing sends? Defaults to true. Example: false
- `dataFields` (`object`, optional): Fields to merge into template. Example: {"orderId": "A-1001", "firstName": "Jane"}
- `recipientEmail` (`string`, optional): An email address that identifies a user profile in Iterable. Provide a recipientEmail or a recipientUserId (but not both), depending on how your project identifies users. Example: jane@example.com
- `recipientUserId` (`string`, optional): A user ID that identifies a user profile in Iterable. Provide a recipientEmail or a recipientUserId (but not both), depending on how your project identifies users. Example: 12345
- `sendAt` (`string`, optional): Schedule the message for up to 365 days in the future. If set in the past, message is sent immediately. Format is YYYY-MM-DD HH:MM:SS in UTC. Example: 2026-12-01 15:00:00 +00:00

Example input: `{"campaignId":12345}`

### `iterable_whatsapp_send`

Send WhatsApp Message to User · Write

Send a WhatsApp message from an existing WhatsApp campaign to one user, identified by email or userId, with optional dataFields for the template and an optional sendAt time.
Returns msg, code and params; code Success means Iterable accepted the send.
Use this for a transactional one-to-one send. The campaign must be a triggered WhatsApp campaign; use iterable_campaign_trigger to send a campaign to a list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `campaignId` (`integer`, required): Campaign ID. Example: 12345
- `allowRepeatMarketingSends` (`boolean`, optional): Allow repeat marketing sends? Defaults to true. Example: false
- `dataFields` (`object`, optional): Data fields that can be referenced in the template or campaign content. Example: {"orderId": "A-1001", "firstName": "Jane"}
- `recipientEmail` (`string`, optional): An email address that identifies a user profile in Iterable. Provide a recipientEmail or a recipientUserId (but not both), depending on how your project identifies users. Example: jane@example.com
- `recipientUserId` (`string`, optional): A user ID that identifies a user profile in Iterable. Provide a recipientEmail or a recipientUserId (but not both), depending on how your project identifies users. Example: 12345
- `sendAt` (`string`, optional): Schedule the message for up to 365 days in the future. If set in the past, message is sent immediately. Format is YYYY-MM-DD HH:MM:SS (UTC). Example: 2026-12-01 15:00:00 +00:00

Example input: `{"campaignId":12345}`

### `iterable_campaign_abort`

Abort a campaign · Destructive

Abort a campaign that is currently sending, stopping any remaining sends.
Returns an object with code, msg, params.

Read only: no. Destructive: yes. Idempotent (safe to retry): no.

Inputs:

- `campaignId` (`number`, required): The campaign ID to attribute this to, or to act on. Example: 12345

Example input: `{"campaignId":12345}`

### `iterable_campaign_cancel`

Cancel a scheduled or recurring campaign · Destructive

Cancel a scheduled or recurring campaign before it sends.
Returns an object with code, msg, params.

Read only: no. Destructive: yes. Idempotent (safe to retry): no.

Inputs:

- `campaignId` (`number`, required): The campaign ID to attribute this to, or to act on. Example: 12345

Example input: `{"campaignId":12345}`

### `iterable_catalog_delete`

Delete a catalog · Destructive

Delete the catalog with the specified name. Also deletes all collections that reference the specified catalog.
Returns an object with code, msg, params.
Needs catalogName from iterable_catalogs_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `catalogName` (`string`, required): Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]. Example: products

Example input: `{"catalogName":"<catalogName>"}`

### `iterable_catalog_item_delete`

Delete a catalog item · Destructive

Delete a catalog item. Asynchronous. Deletes the specified item from the catalog.
Returns an object with code, msg, params.
Needs catalogName from iterable_catalogs_list; itemId from iterable_catalog_items_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `catalogName` (`string`, required): Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]. Example: products
- `itemId` (`string`, required): Catalog item id [Alphanumeric, dashes, case sensitive, 255 characters max]. Example: sku-1

Example input: `{"catalogName":"<catalogName>","itemId":"<itemId>"}`

### `iterable_list_delete`

Delete a list · Destructive

Delete a list by listId.
Returns an object with code, msg, params.
Needs listId from iterable_lists_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `listId` (`integer`, required): list id. Example: 12345

Example input: `{"listId":12345}`

### `iterable_list_unsubscribe`

Remove Users from List · Destructive

Remove specific users from a list. Learn about identifying users by userId and email.
Returns an object with createdFields, failCount, failedUpdates, filteredOutFields, invalidEmails, invalidUserIds, successCount.

Read only: no. Destructive: yes. Idempotent (safe to retry): no.

Inputs:

- `listId` (`integer`, required): The ID of the list (from iterable_lists_list). Example: 12345
- `subscribers` (`array`, required): The users to add or remove, each with email or userId and optional dataFields. Example: [{"email": "jane@example.com"}]
- `campaignId` (`integer`, optional): attribute unsubscribe to a campaign. Example: 12345
- `channelUnsubscribe` (`boolean`, optional): Unsubscribe email from list's associated channel - essentially a global unsubscribe. (default: false) Example: false

Example input: `{"listId":12345,"subscribers":[{"email":"jane@example.com"}]}`

### `iterable_subscription_user_unsubscribe`

Unsubscribe User from Subscription Group · Destructive

Unsubscribe a user from the specified subscription group.
Returns an object with code, msg, params.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `subscriptionGroup` (`string`, required): Subscription group (i.e.: emailList, messageType, messageChannel) [Alphanumeric, case insensitive]. Example: emailList
- `subscriptionGroupId` (`integer`, required): Subscription Group Id [Numeric]. Example: 12345
- `userEmail` (`string`, required): User's Email [Alphanumeric]. Example: jane@example.com

Example input: `{"subscriptionGroup":"<subscriptionGroup>","subscriptionGroupId":12345,"userEmail":"<userEmail>"}`

### `iterable_user_delete_by_email`

Delete User by Email · Destructive

Delete a user by email. Asynchronous. Deletes a specific user by email. Does not prevent future data collection about the user.
Returns an object with code, msg, params.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `email` (`string`, required): email. Example: jane@example.com

Example input: `{"email":"<email>"}`

### `iterable_user_delete_by_user_id`

Delete User by User ID · Destructive

Delete user by userId. Asynchronous. Deletes a specific user by userId. Does not prevent future data collection about the user.
Returns an object with code, msg, params.
Needs userId from iterable_user_get_by_user_id.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `userId` (`string`, required): The user's userId in your Iterable project. Example: user-123

Example input: `{"userId":"<userId>"}`

### `iterable_user_forget`

Forget User (GDPR) · Destructive

Forget a user for GDPR: delete their data and block Iterable from storing new data for that email or userId.
Returns msg, code and params.
Use this only for privacy requests. Use iterable_user_delete_by_email or iterable_user_delete_by_user_id for an ordinary delete.

Read only: no. Destructive: yes. Idempotent (safe to retry): no.

Inputs:

- `email` (`string`, optional): An email address that identifies a user profile in Iterable. Provide an email or a userId (but not both), depending on how your project identifies users. Example: jane@example.com
- `userId` (`string`, optional): A user ID that identifies a user profile in Iterable. Provide an email or a userId (but not both), depending on how your project identifies users. Example: 12345

Example input: `{}`

## Related

Other Marketing connectors ([all 190](/agentkit/connectors/?category=marketing)):

- [HubSpot](/agentkit/connectors/hubspot/): Scalekit connector, OAuth, 457 tools
- [Mailchimp](/agentkit/connectors/mailchimp/): Scalekit connector, OAuth, 73 tools
- [Twitter / X](/agentkit/connectors/twitteroauth/): Scalekit connector, OAuth, 92 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
