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.
- Tools
- 62
- What they doRead · write · destructive
- 22 · 30 · 1022 read30 write10 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Iterable connection
In AgentKit > Connections, create an Iterable connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts 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.actionsconst connector = 'iterable'const identifier = 'user_123'// Generate an authorization link for the userconst { 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 callconst result = await actions.executeTool({connector,identifier,toolName: 'iterable_campaigns_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_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.actionsconnection_name = "iterable"identifier = "user_123"# Generate an authorization link for the userlink_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 callresult = actions.execute_tool(tool_input={},tool_name="iterable_campaigns_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Iterable credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_tooliterable_campaign_getGet a campaign by ID.Read-onlyGet a campaign
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.
Inputs
idintegerrequired- Campaign ID. Example: 12345
iterable_campaigns_listGet metadata about campaigns in a project.Read-onlyList campaign metadata
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.
Inputs
campaignStatearray- 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
pageinteger- Page number (starting at 1). Example: 1
pageSizeinteger- Number of results to return per page (defaults to 20, maximum of 1000). Example: 10
sortstring- 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
iterable_catalog_field_mappings_getField mappings (field to data types) and undefined fields of a catalog Returns an object with definedMappings, undefinedFields.Read-onlyGet field mappings for a catalog
Field mappings (field to data types) and undefined fields of a catalog Returns an object with definedMappings, undefinedFields. Needs catalogName from iterable_catalogs_list.
Inputs
catalogNamestringrequired- Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]. Example: products
iterable_catalog_item_getGet a specific catalog item from the given catalog.Read-onlyGet a specific catalog item
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.
Inputs
catalogNamestringrequired- Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]. Example: products
itemIdstringrequired- Catalog item id [Alphanumeric, dashes, case sensitive, 255 characters max]. Example: sku-1
iterable_catalog_items_listGet the catalog items for a catalog.Read-onlyGet the catalog items for a catalog
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.
Inputs
catalogNamestringrequired- Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]. Example: products
orderBystring- Field by which results should be ordered. To also use the sortAscending parameter, this field must have a defined type. Example: itemId
pageinteger- Page number to list (starting at 1). Example: 1
pageSizeinteger- Number of results to display per page (defaults to 10). Example: 10
sortAscendingboolean- Sort results by ascending (Defaults to false). Example: false
iterable_catalogs_listGet catalog names.Read-onlyGet catalog names
Get catalog names. Rate limit: 100 requests/second, per API key. Returns an object with catalogNames, nextPageUrl, previousPageUrl, totalCatalogsCount.
Inputs
pageinteger- Page number to list (starting at 1). Example: 1
pageSizeinteger- Number of results to display per page (defaults to 10). Example: 10
iterable_channels_listGet all message channels within the project.Read-onlyGet channels
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.
Inputs
This tool takes no inputs.
iterable_email_template_getGet an email template by templateId, including subject, HTML, sender details and data feed settings.Read-onlyGet an email template by templateId
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.
Inputs
templateIdintegerrequired- Template ID. Example: 12345
localestring- Locale of content to get. Example: en-US
iterable_inapp_template_getGet an in-app template.Read-onlyGet In-App Template
Get an in-app template. Returns an object with campaignDataFields, campaignId, clientTemplateId, expirationDateTime, expirationDuration, html, inAppDisplaySettings, inboxMetadata, isDefaultLocale, locale, messageTypeId, name and more.
Inputs
templateIdintegerrequired- Template ID. Example: 12345
localestring- Locale of content to get. Example: en-US
iterable_journeys_listGet a list of the journeys within your project.Read-onlyGet journeys (workflows)
Get a list of the journeys within your project. Returns an object with journeys, nextPageUrl, previousPageUrl, totalJourneysCount.
Inputs
pageinteger- Page number (starting at 1). Example: 1
pageSizeinteger- Number of results to return per page (defaults to 10, maximum of 50). Example: 10
sortstring- Sort field with optional direction prefix. Use - for descending, + or no prefix for ascending. Examples: -createdAt, +name, id
statearray- Without this parameter, the endpoint returns all non-archived journeys. With state set to Archived, the endpoint only returns archived journeys. Example: ["Running"]
iterable_list_size_getGet the number of users within a list.Read-onlyGet List Size
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.
Inputs
listIdintegerrequired- list id. Example: 12345
iterable_lists_listGet all lists within a project.Read-onlyGet lists
Get all lists within a project. Rate limit: 100 requests/second, per project. Returns an object with lists.
Inputs
This tool takes no inputs.
iterable_message_types_listList all message types within a project.Read-onlyList message types
List all message types within a project. Rate limit: 100 requests/second, per project. Returns an object with messageTypes.
Inputs
This tool takes no inputs.
iterable_push_template_getGet a push template by templateId, including title, message, buttons and deep links.Read-onlyGet a push template
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.
Inputs
templateIdintegerrequired- Template ID. Example: 12345
localestring- Locale of content to get. Example: en-US
iterable_sms_template_getGet an SMS template by templateId, including the message and sender number.Read-onlyGet an SMS template
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.
Inputs
templateIdintegerrequired- Template ID. Example: 12345
localestring- Locale of content to get. Example: en-US
iterable_templates_listGet templates for a project.Read-onlyGet project templates
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.
Inputs
endDateTimestring- Get templates created before this date time (yyyy-MM-dd HH:mm:ss [ZZ]) Example: 2026-01-15T09:30:00Z
messageMediumstring- Only retrieve templates associated with this message medium. Example: Emailone of
EmailPushInAppSMS pageinteger- Page number (starting at 1). Example: 1
pageSizeinteger- Number of results to return per page (defaults to 20, maximum of 1000). Example: 20
sortstring- 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
startDateTimestring- Get templates created at or after this date time (yyyy-MM-dd HH:mm:ss [ZZ]) Example: 2026-01-15T09:30:00Z
templateTypestring- Only retrieve templates associated with this template type. Example: Baseone of
BaseBlastTriggeredWorkflow
iterable_user_events_by_email_getGet events for a specific user, by email.Read-onlyGet User Events by Email
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.
Inputs
emailstringrequired- Email of the user whose events you are retrieving. Example: jane@example.com
limitinteger- The number of events to retrieve. (Max is 200) Example: 30
iterable_user_events_by_user_id_getGet events for a specific user, by userId.Read-onlyGet User Events by User ID
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.
Inputs
userIdstringrequired- UserId of the user whose events you are retrieving. Example: 12345
limitinteger- The number of events to retrieve. (Max is 200) Example: 30
iterable_user_fields_listGet all user fields within a project.Read-onlyList User Fields
Get all user fields within a project. Rate limit: 3 requests/second, per project. Returns an object with fields.
Inputs
This tool takes no inputs.
iterable_user_get_by_emailGet a user by email address (passed as a query parameter).Read-onlyGet User by Email
Get a user by email address (passed as a query parameter). Returns an object with user.
Inputs
emailstring- The user's email address. Example: jane@example.com
iterable_user_get_by_user_idGet a user by userId (passed as a query parameter).Read-onlyGet User by User ID
Get a user by userId (passed as a query parameter). Returns an object with user.
Inputs
userIdstring- The user's userId in your Iterable project. Example: user-123
iterable_user_sent_messages_listGet messages sent to a user, by email address or userId.Read-onlyList Messages Sent to User
Get messages sent to a user, by email address or userId. Returns messages, an array of items with campaignId, createdAt, messageId, templateId.
Inputs
campaignIdsarray- only include messages from these campaigns. Example: [12345]
emailstring- user's email, either email or userId must be specified. Example: jane@example.com
endDateTimestring- end date time (yyyy-MM-dd HH:mm:ss ZZ) Example: 2026-01-15T09:30:00Z
excludeBlastCampaignsboolean- exclude results coming from blast campaigns (ignored if campaignId is set) Example: false
limitinteger- max number of messages to return (default: 10, max limit: 1000) Example: 10
messageMediumstring- only include messages of this type. Example: Emailone of
EmailPushInAppSMS startDateTimestring- start date time (yyyy-MM-dd HH:mm:ss ZZ) Example: 2026-01-15T09:30:00Z
userIdstring- user's userId, either email or userId must be specified. Example: 12345
iterable_campaign_createCreate a new blast or triggered campaign from an existing template.WriteCreate a campaign
Create a new blast or triggered campaign from an existing template. Returns an object with campaignId.
Inputs
listIdsarrayrequired- 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]
namestringrequired- The name to use in Iterable for the new campaign. Example: Scalekit test
templateIdnumberrequired- The ID of a template to associate with the new campaign. The new campaign receives a copy of this template. Example: 12345
campaignDataFieldsobject- 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"}
dataFieldsobject- 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"}
defaultTimeZonestring- 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.
labelIdsarray- An optional array of label IDs to associate with the new campaign. Labels must exist in the project. Maximum 50 labels allowed. Example: [12345]
scheduleSendboolean- 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
sendAtstring- 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
sendModestring- 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: ProjectTimeZoneone of
ProjectTimeZoneRecipientTimeZone shortenLinksboolean- 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
startTimeZonestring- 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.
suppressionListIdsarray- An array of suppression list IDs to associate with a new blast campaign. Example: [12345]
iterable_campaign_scheduleSchedule existing campaign to be sent.WriteSchedule existing campaign to be sent
Schedule existing campaign to be sent. Returns an object with code, msg, params. Needs campaignId from iterable_campaigns_list.
Inputs
campaignIdintegerrequired- The campaign ID to attribute this to, or to act on. Example: 12345
sendAtstringrequired- 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
recipientTimeZoneobject- 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"}
iterable_campaign_sendSend existing campaign now.WriteSend existing campaign now
Send existing campaign now. Returns an object with code, msg, params. Needs campaignId from iterable_campaigns_list.
Inputs
campaignIdintegerrequired- The campaign ID to attribute this to, or to act on. Example: 12345
iterable_campaign_triggerTrigger a triggered campaign to send to one or more lists, with optional dataFields.WriteTrigger a campaign
Trigger a triggered campaign to send to one or more lists, with optional dataFields. Returns an object with code, msg, params.
Inputs
campaignIdintegerrequired- The campaign ID to attribute this to, or to act on. Example: 12345
listIdsarrayrequired- A non-empty array of list IDs to send to. Example: [12345]
allowRepeatMarketingSendsboolean- Allow repeat marketing sends? Defaults to true. Example: false
dataFieldsobject- Fields to merge into handlebars context. Example: {"orderId": "A-1001", "firstName": "Jane"}
suppressionListIdsarray- Lists to suppress. Example: [12345]
iterable_campaigns_archiveArchive one or more campaigns.WriteArchive Campaigns
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).
Inputs
campaignIdsarrayrequired- Campaign IDs to archive. Example: [12345]
iterable_cart_updateUpdate the shoppingCartItems field on the user profile with shopping cart items.WriteUpdate a user's shopping cart items
Update the shoppingCartItems field on the user profile with shopping cart items. Returns an object with code, msg, params.
Inputs
itemsarrayrequired- 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}]
userobjectrequired- The user making the purchase or owning the cart: email or userId, and optional dataFields. Example: {"email": "jane@example.com"}
iterable_catalog_createCreate a catalog.WriteCreate a catalog
Create a catalog. Each catalog in a project must have a unique name. Returns an object with code, msg, params.
Inputs
catalogNamestringrequired- Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]. Example: products
iterable_catalog_field_mappings_updateSet a catalog's field mappings (data types).WriteSet a catalog's field mappings (data types)
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.
- Idempotent
Inputs
catalogNamestringrequired- Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]. Example: products
mappingsUpdatesarrayrequired- mappingsUpdates. Example: [{"fieldName": "price", "fieldType": "double"}]
iterable_catalog_item_replaceCreate or replace a catalog item.WriteCreate or Replace Catalog Item
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.
- Idempotent
Inputs
catalogNamestringrequired- Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]. Example: products
itemIdstringrequired- Catalog item id [Alphanumeric, dashes, case sensitive, 255 characters max]. Example: sku-1
valueobjectrequired- JSON representation of the catalog item. Max size is is 30kb. Example: {"name": "T-shirt", "price": 25}
iterable_catalog_item_updateCreate or update a catalog item.WriteCreate or Update Catalog Item
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.
Inputs
catalogNamestringrequired- The catalog name. Example: products
itemIdstringrequired- The catalog item ID. Example: sku-1
updateobjectrequired- JSON representation of the catalog item fields to update. Max size is is 30kb. Example: {"price": 22}
iterable_email_sendSend 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.WriteSend Email to User
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.
Inputs
campaignIdintegerrequired- Campaign ID. Example: 12345
allowRepeatMarketingSendsboolean- Allow repeat marketing sends? Defaults to true. Example: false
dataFieldsobject- Fields to merge into email template. Example: {"orderId": "A-1001", "firstName": "Jane"}
metadataobject- Metadata to pass back via webhooks. Not used for rendering. Example: {"source": "scalekit"}
recipientEmailstring- 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
recipientUserIdstring- 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
sendAtstring- 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
iterable_email_template_proof_sendSend a proof of an email template to a specific user.WriteSend Email Template Proof
Send a proof of an email template to a specific user. Returns an object with code, msg, params.
Inputs
templateIdintegerrequired- Template ID to send proof for. Example: 12345
dataFieldsobject- Fields to merge into template for proof. Example: {"orderId": "A-1001", "firstName": "Jane"}
localestring- 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
recipientEmailstring- 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
recipientUserIdstring- 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
iterable_email_template_updateUpdate email template.WriteUpdate email template
Update email template. Returns an object with code, msg, params.
Inputs
templateIdintegerrequired- Email Template ID. Example: 12345
bccEmailsarray- BCC emails. Example: ["audit@example.com"]
cacheDataFeedobject- Cache data feed lookups for 1 hour. Example: {"enabled": false}
campaignDataFieldsobject- 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"}
ccEmailsarray- CC emails. Example: ["team@example.com"]
clientTemplateIdstring- Client template ID. Used as a secondary key to reference the template. Example: 12345
creatorUserIdstring- Creator User Id. Example: 12345
dataFeedIdnumber- [Deprecated - use dataFeedIds instead] Id for data feed used in template rendering. Example: 12345
dataFeedIdsarray- Ids for data feeds used in template rendering. Example: [12345]
fromEmailstring- From email (must be an authorized sender) Example: orders@acme.example
fromNamestring- From name. Example: Acme
googleAnalyticsCampaignNamestring- Google analytics utm_campaign value. Example: spring_sale
htmlstring- HTML contents. Example: <p>Hello from Scalekit</p>
isDefaultLocaleboolean- 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
linkParamsarray- Parameters to append to each URL in html contents. Example: [{"key": "utm_source", "value": "iterable"}]
localestring- 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
mergeDataFeedContextobject- Merge data feed contents into user context, so fields be referenced by {{field}} instead of [[field]]. Example: {"enabled": false}
messageTypeIdnumber- Message Type Id. Example: 12345
namestring- Name of the template. Example: Scalekit test
plainTextstring- Plain text contents. Example: Your order shipped.
preheaderTextstring- Preheader text. Example: Tracking inside
replyToEmailstring- Reply to email. Example: support@acme.example
shortenLinksboolean- Whether links in the template should be shortened. Returns HTTP 400 if true when link shortening is not enabled for the project. Example: false
subjectstring- Subject. Example: Hello from Scalekit
iterable_email_template_upsertCreate email template if it doesn't exist already, otherwise update all email templates that match the name provided.WriteCreate or Update Email Template
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.
Inputs
clientTemplateIdstringrequired- ID used by the client to identify a template. If multiple templates exist with the ID, all will be updated. Example: 12345
bccEmailsarray- BCC emails. Example: ["audit@example.com"]
cacheDataFeedobject- Cache data feed lookups for 1 hour. Example: {"enabled": false}
campaignDataFieldsobject- 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"}
ccEmailsarray- CC emails. Example: ["team@example.com"]
creatorUserIdstring- Specify a specific creator user id (email). The email must be an existing member of the project. Defaults to the organization creator. Example: 12345
dataFeedIdinteger- [Deprecated - use dataFeedIds instead] Id for data feed used in template rendering. Example: 12345
dataFeedIdsarray- Ids for data feeds used in template rendering. Example: [12345]
fromEmailstring- From email (must be an authorized sender) Example: orders@acme.example
fromNamestring- From name. Example: Acme
googleAnalyticsCampaignNamestring- Google analytics utm_campaign value. Example: spring_sale
htmlstring- HTML contents. Example: <p>Hello from Scalekit</p>
isDefaultLocaleboolean- 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
linkParamsarray- Parameters to append to each URL in html contents. Example: [{"key": "utm_source", "value": "iterable"}]
localestring- 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
mergeDataFeedContextboolean- Merge data feed contents into user context, so fields be referenced by {{field}} instead of [[field]]. Example: false
messageTypeIdinteger- Message Type Id. Example: 12345
namestring- Name of the template. Example: Scalekit test
plainTextstring- Plain text contents. Example: Your order shipped.
preheaderTextstring- Preheader text. Example: Tracking inside
replyToEmailstring- Reply to email. Example: support@acme.example
shortenLinksboolean- Whether links in the template should be shortened. Returns HTTP 400 if true when link shortening is not enabled for the project. Example: false
subjectstring- Subject. Example: Hello from Scalekit
iterable_event_trackTrack an event.WriteTrack an event
Track an event. Events are created asynchronously and processed separately from single event (non-bulk) endpoint. Returns an object with code, msg, params.
Inputs
eventNamestringrequired- Name of event. Example: order_shipped
campaignIdinteger- Campaign tied to conversion. Example: 12345
createdAtinteger- Time event happened. Set to the time event was received if unspecified. Expects a unix timestamp. Example: 1767225600
createNewFieldsboolean- Whether new fields should be ingested and added to the schema. Defaults to project's setting to allow or drop unrecognized fields. Example: false
dataFieldsobject- 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"}
emailstring- 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
idstring- 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
templateIdinteger- Template id. Example: 12345
userIdstring- 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
iterable_events_bulk_trackBulk track events.WriteBulk Track Events
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.
Inputs
eventsarrayrequired- The events to track, each with eventName, email or userId, and optional dataFields and createdAt. Example: [{"eventName": "order_shipped", "email": "jane@example.com"}]
iterable_inapp_sendSend 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.WriteSend In-App Message to User
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.
Inputs
campaignIdintegerrequired- Campaign ID. Example: 12345
allowRepeatMarketingSendsboolean- Allow repeat marketing sends? Defaults to true. Example: false
dataFieldsobject- Fields to merge into email template. Example: {"orderId": "A-1001", "firstName": "Jane"}
recipientEmailstring- 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
recipientUserIdstring- 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
sendAtstring- 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
iterable_journey_triggerTrigger a journey (formerly known as workflow).WriteTrigger Journey
Trigger a journey (formerly known as workflow). Triggering with a list is asynchronous. Returns an object with code, msg, params.
Inputs
workflowIdintegerrequired- ID of journey (workflow) to trigger. Example: 12345
dataFieldsobject- Additional data associated triggering event. Example: {"orderId": "A-1001", "firstName": "Jane"}
emailstring- 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
listIdinteger- (Optional) Trigger the journey for all users in a list (standard or dynamic) Example: 12345
userIdstring- 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
iterable_list_createCreate a new static list.WriteCreate a static list
Create a new static list. Returns an object with listId.
Inputs
namestringrequired- The list name. Example: January signups
descriptionstring- A description of the list. Example: Customers who joined in January
iterable_list_subscribeAdd specific subscribers to a list.WriteAdd Subscribers to List
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.
Inputs
listIdintegerrequired- The ID of the list (from iterable_lists_list). Example: 12345
subscribersarrayrequired- The users to add or remove, each with email or userId and optional dataFields. Example: [{"email": "jane@example.com"}]
updateExistingUsersOnlyboolean- 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
iterable_purchase_trackTrack purchase events.WriteTrack a purchase
Track purchase events. shoppingCartItems field on the user profile is cleared. Returns an object with code, msg, params.
Inputs
itemsarrayrequired- 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}]
totalnumberrequired- Total order dollar amount. Example: 25.0
userobjectrequired- The user making the purchase or owning the cart: email or userId, and optional dataFields. Example: {"email": "jane@example.com"}
campaignIdinteger- The campaign ID to attribute this to, or to act on. Example: 12345
createdAtinteger- Time event happened. Set to the time event was received if unspecified. Expects a Unix timestamp. Example: 1767225600
dataFieldsobject- Additional fields to be tracked. Example: {"orderId": "A-1001", "firstName": "Jane"}
idstring- 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
templateIdinteger- Used in AB testing attribution. Example: 12345
iterable_push_sendSend 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.WriteSend Push to User
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.
Inputs
campaignIdintegerrequired- Campaign ID. Example: 12345
allowRepeatMarketingSendsboolean- Allow repeat marketing sends? Defaults to true. Example: false
dataFieldsobject- JSON object containing fields to merge into template. Example: {"orderId": "A-1001", "firstName": "Jane"}
metadataobject- Metadata to pass back via system webhooks. Not used for rendering. Example: {"source": "scalekit"}
recipientEmailstring- 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
recipientUserIdstring- 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
sendAtstring- 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
iterable_sms_sendSend 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.WriteSend SMS to User
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.
Inputs
campaignIdintegerrequired- Campaign ID. Example: 12345
allowRepeatMarketingSendsboolean- Allow repeat marketing sends? Defaults to true. Example: false
dataFieldsobject- Fields to merge into template. Example: {"orderId": "A-1001", "firstName": "Jane"}
recipientEmailstring- 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
recipientUserIdstring- 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
sendAtstring- 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
iterable_subscription_user_subscribeSubscribe a user to the specified subscription group.WriteSubscribe User to Subscription Group
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.
Inputs
subscriptionGroupstringrequired- Subscription group (i.e.: emailList, messageType, messageChannel) [Alphanumeric, case insensitive]. Example: emailList
subscriptionGroupIdintegerrequired- Subscription Group Id [Numeric]. Example: 12345
userEmailstringrequired- User's Email [Alphanumeric]. Example: jane@example.com
iterable_user_email_updateUpdate a user's email.WriteUpdate User Email
Update a user's email. Use this endpoint with email-based projects. Returns an object with code, msg, params.
Inputs
newEmailstringrequired- The new email address to assign to the specified user. Example: jane.doe@example.com
currentEmailstring- 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
currentUserIdstring- 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
iterable_user_subscriptions_updateUpdate user subscriptions.WriteUpdate User Subscriptions
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.
Inputs
campaignIdinteger- Campaign to attribute unsubscribes. Example: 12345
emailstring- 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
emailListIdsarray- Lists that a user is subscribed to. Example: [12345]
subscribedMessageTypeIdsarray- 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]
templateIdinteger- Template to attribute unsubscribes. Example: 12345
unsubscribedChannelIdsarray- Email channel ids to unsubscribe from. Example: [12345]
unsubscribedMessageTypeIdsarray- Individual message type IDs to unsubscribe (does not impact channel subscriptions). Example: [12345]
userIdstring- 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
validateChannelAlignmentboolean- 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
iterable_user_updateUpdate user data or adds a user if none exists.WriteUpdate User
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.
Inputs
createNewFieldsboolean- Whether new fields should be ingested and added to the schema. Defaults to project's setting to allow or drop unrecognized fields. Example: false
dataFieldsobject- Data to store on the user profile identified by userId or email. Example: {"orderId": "A-1001", "firstName": "Jane"}
emailstring- 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
mergeNestedObjectsboolean- 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
preferUserIdboolean- 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
userIdstring- 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
iterable_users_bulk_updateBulk updates user data.WriteBulk Update Users
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.
Inputs
usersarrayrequired- 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"}}]
createNewFieldsboolean- 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
iterable_web_push_sendSend 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.WriteSend Web Push to User
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.
Inputs
campaignIdintegerrequired- The campaign ID to attribute this to, or to act on. Example: 12345
allowRepeatMarketingSendsboolean- Allow repeat marketing sends? Defaults to true. Example: false
dataFieldsobject- Fields to merge into template. Example: {"orderId": "A-1001", "firstName": "Jane"}
recipientEmailstring- 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
recipientUserIdstring- 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
sendAtstring- 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
iterable_whatsapp_sendSend 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.WriteSend WhatsApp Message to User
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.
Inputs
campaignIdintegerrequired- Campaign ID. Example: 12345
allowRepeatMarketingSendsboolean- Allow repeat marketing sends? Defaults to true. Example: false
dataFieldsobject- Data fields that can be referenced in the template or campaign content. Example: {"orderId": "A-1001", "firstName": "Jane"}
recipientEmailstring- 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
recipientUserIdstring- 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
sendAtstring- 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
iterable_campaign_abortAbort a campaign that is currently sending, stopping any remaining sends.DestructiveAbort a campaign
Abort a campaign that is currently sending, stopping any remaining sends. Returns an object with code, msg, params.
Inputs
campaignIdnumberrequired- The campaign ID to attribute this to, or to act on. Example: 12345
iterable_campaign_cancelCancel a scheduled or recurring campaign before it sends.DestructiveCancel a scheduled or recurring campaign
Cancel a scheduled or recurring campaign before it sends. Returns an object with code, msg, params.
Inputs
campaignIdnumberrequired- The campaign ID to attribute this to, or to act on. Example: 12345
iterable_catalog_deleteDelete the catalog with the specified name.DestructiveDelete a catalog
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.
- Idempotent
Inputs
catalogNamestringrequired- Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]. Example: products
iterable_catalog_item_deleteDelete a catalog item.DestructiveDelete a catalog item
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.
- Idempotent
Inputs
catalogNamestringrequired- Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]. Example: products
itemIdstringrequired- Catalog item id [Alphanumeric, dashes, case sensitive, 255 characters max]. Example: sku-1
iterable_list_deleteDelete a list by listId.DestructiveDelete a list
Delete a list by listId. Returns an object with code, msg, params. Needs listId from iterable_lists_list.
- Idempotent
Inputs
listIdintegerrequired- list id. Example: 12345
iterable_list_unsubscribeRemove specific users from a list.DestructiveRemove Users from List
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.
Inputs
listIdintegerrequired- The ID of the list (from iterable_lists_list). Example: 12345
subscribersarrayrequired- The users to add or remove, each with email or userId and optional dataFields. Example: [{"email": "jane@example.com"}]
campaignIdinteger- attribute unsubscribe to a campaign. Example: 12345
channelUnsubscribeboolean- Unsubscribe email from list's associated channel - essentially a global unsubscribe. (default: false) Example: false
iterable_subscription_user_unsubscribeUnsubscribe a user from the specified subscription group.DestructiveUnsubscribe User from Subscription Group
Unsubscribe a user from the specified subscription group. Returns an object with code, msg, params.
- Idempotent
Inputs
subscriptionGroupstringrequired- Subscription group (i.e.: emailList, messageType, messageChannel) [Alphanumeric, case insensitive]. Example: emailList
subscriptionGroupIdintegerrequired- Subscription Group Id [Numeric]. Example: 12345
userEmailstringrequired- User's Email [Alphanumeric]. Example: jane@example.com
iterable_user_delete_by_emailDelete a user by email.DestructiveDelete User by Email
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.
- Idempotent
Inputs
emailstringrequired- email. Example: jane@example.com
iterable_user_delete_by_user_idDelete user by userId.DestructiveDelete User by User ID
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.
- Idempotent
Inputs
userIdstringrequired- The user's userId in your Iterable project. Example: user-123
iterable_user_forgetForget a user for GDPR: delete their data and block Iterable from storing new data for that email or userId.DestructiveForget User (GDPR)
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.
Inputs
emailstring- 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
userIdstring- 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
No tools match.