Iterable

iterable

Cross-channel marketing platform for creating, executing, and optimizing campaigns

Marketing Web del proveedor

Acciones

116

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (116)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Abort CampaignITERABLE_ABORT_CAMPAIGNAcción

Abort a running campaign to stop all in-progress message deliveries. Use this action when you need to immediately halt an active campaign that is currently sending messages to recipients. This action is useful for emergency stops, such as when an issue is discovered in the campaign content or targeting. Note: Only campaigns in 'Running' state can be aborted. Campaigns that have already finished or were not started cannot be aborted.

Parámetros de entrada

campaignIdintegerObligatorio
The unique identifier of the campaign to abort. Use the campaign ID returned from campaign creation or list campaigns.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Activate a triggered campaignITERABLE_ACTIVATE_TRIGGERED_CAMPAIGNAcción

Activates a triggered campaign by its unique ID, allowing it to process events and send messages. Use this action when you need to start a triggered campaign that will send messages based on user events (e.g., cart abandonment, welcome series, re-engagement). The campaign must be in a valid state for activation (e.g., not already running or finished). Note: API triggered campaign activation must be enabled for your project.

Parámetros de entrada

campaignIdintegerObligatorio
The unique identifier of the triggered campaign to activate.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Archive CampaignsITERABLE_ARCHIVE_CAMPAIGNSAcción

Archives one or more campaigns. This endpoint behaves the same as the archive feature in the UI. Scheduled or recurring campaigns will be cancelled, and running campaigns will be aborted. Archived campaigns will be hidden from the Campaigns page, but can still be viewed in the Archived tab. Use this action when you need to remove campaigns from the active campaigns list while preserving them for historical reference. This action is irreversible — once archived, campaigns cannot be restored through this API (must be done manually through the UI). Rate limit: 5 requests/second, per API key.

Parámetros de entrada

campaignIdsinteger[]Obligatorio
List of campaign IDs to archive. Scheduled or recurring campaigns will be cancelled, and running campaigns will be aborted.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Bulk Update UsersITERABLE_BULK_UPDATE_USERSAcción

Bulk update user data in Iterable. Use this action when you need to update multiple user profiles at once. This endpoint adds and overwrites user profile fields as needed. It does not modify top-level fields omitted from the request body. If you'd like to merge (rather than overwrite) a user profile's top-level objects with the values provided, set mergeNestedObjects to true. When updating an existing field, you cannot change its data type (the new value must have the same data type as the old value). At least one of email or userId must be provided for each user in the users array.

Parámetros de entrada

usersobject[]Obligatorio
List of users to update. Each user must have at least an email or userId.
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.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Cancel CampaignITERABLE_CANCEL_CAMPAIGNAcción

Cancel a scheduled or recurring campaign in Iterable. Use when you need to stop a campaign that is scheduled for future sending or is part of a recurring campaign cycle. Once canceled, the campaign will not be sent to any recipients. Note: This action is irreversible for campaigns that are already in the process of sending. Only campaigns with a 'Scheduled' or 'Recurring' state can be canceled.

Parámetros de entrada

campaignIdintegerObligatorio
The unique identifier of the campaign to cancel. Use the campaign ID returned from the 'List campaigns' or 'Get campaign' endpoint.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Cancel EmailITERABLE_CANCEL_EMAILAcción

Cancel a scheduled email to a specific user in Iterable. Use when you need to stop an email that has been queued for a specific user but has not yet been sent. You can cancel by providing the scheduledMessageId alone, or by providing a campaignId along with the user's email or userId. Note: This action is irreversible — once an email is canceled, it cannot be sent again using this endpoint. The canceled message will not be delivered to the recipient.

Parámetros de entrada

emailstring
The email address identifying the user profile. Required if campaignId is provided.
userIdstring
The user ID identifying the user profile. Required if campaignId is provided instead of scheduledMessageId.
campaignIdinteger
The ID of the campaign associated with the scheduled message to cancel. If provided, must also include email or userId.
scheduledMessageIdinteger
The ID of the scheduled message to cancel. If provided, campaignId, email, and userId are not required.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Cancel ExportITERABLE_CANCEL_EXPORTAcción

Cancel a queued or running export created with the 'Start export' endpoint. Use when you need to abort an export job that is in progress or queued. Rate limit: 1 request/second, per project.

Parámetros de entrada

jobIdintegerObligatorio
The ID of the export job to cancel. Use the jobId returned from the 'Start export' endpoint.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Cancel In-App MessageITERABLE_CANCEL_IN_APPAcción

Cancel a scheduled in-app message to a specific user in Iterable. Use when you need to stop a scheduled in-app message that is queued for delivery to a specific user. This action cancels the in-app message for the specified user based on their email or userId. Note: This action is irreversible — once an in-app message is canceled, it will not be delivered to the user.

Parámetros de entrada

emailstring
The email address that identifies the user profile in Iterable. Required (alongside campaignId) unless scheduledMessageId is provided.
userIdstring
The user ID that identifies the user profile in Iterable. Required (alongside campaignId) unless scheduledMessageId is provided.
campaignIdinteger
The ID of the campaign associated with the scheduled message to cancel. If you provide a campaignId, you must also provide an email or userId. Omit when cancelling by scheduledMessageId alone.
scheduledMessageIdinteger
The ID of the scheduled message to cancel. Provide this to cancel a specific scheduled in-app instance without specifying campaignId/email/userId.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Cancel PushITERABLE_CANCEL_PUSHAcción

Cancel a scheduled push notification to a specific user in Iterable. Use when you need to stop a push notification that has been queued for a specific user but has not yet been sent. You can cancel by providing the scheduledMessageId alone, or by providing a campaignId along with the user's email or userId. Note: This action is irreversible — once a push notification is canceled, it cannot be resent using this endpoint. The canceled message will not be delivered to the recipient.

Parámetros de entrada

emailstring
The email address identifying the user profile. Required if campaignId is provided.
userIdstring
The user ID identifying the user profile. Required if campaignId is provided instead of scheduledMessageId.
campaignIdinteger
The ID of the campaign associated with the scheduled message to cancel. If provided, must also include email or userId.
scheduledMessageIdinteger
The ID of the scheduled message to cancel. If provided, campaignId, email, and userId are not required.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Cancel Web PushITERABLE_CANCEL_WEB_PUSHAcción

Cancel a scheduled web push notification to a specific user in Iterable. Use when you need to stop a web push notification that has been queued for a specific user but has not yet been sent. You can cancel by providing the scheduledMessageId alone, or by providing a campaignId along with the user's email or userId. Note: This action is irreversible — once a web push notification is canceled, it cannot be resent using this endpoint. The canceled message will not be delivered to the recipient.

Parámetros de entrada

emailstring
The email address identifying the user profile. Required if campaignId is provided.
userIdstring
The user ID identifying the user profile. Required if campaignId is provided instead of scheduledMessageId.
campaignIdinteger
The ID of the campaign associated with the scheduled message to cancel. If provided, must also include email or userId.
scheduledMessageIdinteger
The ID of the scheduled message to cancel. If provided, campaignId, email, and userId are not required.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Cancel WhatsAppITERABLE_CANCEL_WHATS_APPAcción

Cancel a scheduled WhatsApp message to a specific user in Iterable. Use when you need to stop a WhatsApp message that has been queued for a specific user but has not yet been sent. You can cancel by providing the scheduledMessageId alone, or by providing a campaignId along with the user's email or userId. Note: This action is irreversible — once a WhatsApp message is canceled, it cannot be resent using this endpoint. The canceled message will not be delivered to the recipient.

Parámetros de entrada

emailstring
The email address identifying the user profile. Required if campaignId is provided.
userIdstring
The user ID identifying the user profile. Required if campaignId is provided instead of scheduledMessageId.
campaignIdinteger
The ID of the campaign associated with the scheduled message to cancel. If provided, must also include email or userId.
scheduledMessageIdinteger
The ID of the scheduled message to cancel. If provided, campaignId, email, and userId are not required.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a new campaignITERABLE_CREATE_CAMPAIGNAcción

Creates a new blast or triggered campaign from an existing template. Use this action when you need to create email, push notification, web push notification, SMS, in-app message, and embedded message campaigns from an existing template. Note that global suppression lists are not automatically added to campaigns created from this endpoint; to include a global suppression list, include it in the suppressionListIds request parameter.

Parámetros de entrada

namestringObligatorio
The name to use in Iterable for the new campaign.
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).
listIdsinteger[]
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.
labelIdsinteger[]
An optional array of label IDs to associate with the new campaign. Labels must exist in the project. Maximum 50 labels allowed.
sendModestringenum
Send mode enumeration for campaign scheduling.
ProjectTimeZoneRecipientTimeZone
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.
templateIdintegerObligatorio
The ID of a template to associate with the new campaign. The new campaign receives a copy of this template.
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.
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. IANA format (for example, America/New_York).
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).
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.
suppressionListIdsinteger[]
An array of suppression list IDs to associate with a new blast campaign.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a catalogITERABLE_CREATE_CATALOGAcción

Create a catalog with the specified name in Iterable. Use this action when you need to create a new catalog to store and organize data such as products, users, or other entities. Each catalog in a project must have a unique name. Catalog names can be no longer than 255 characters and must contain only alphanumeric characters and dashes.

Parámetros de entrada

catalogNamestringObligatorio
Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Catalog ItemsITERABLE_CREATE_CATALOG_ITEMSAcción

Asynchronously creates or updates up to 1000 catalog items with a single request. Use this action when you need to bulk create or update catalog items efficiently. If an item with the same ID already exists, it will be completely overwritten, unless replaceUploadedFieldsOnly is set to true to merge fields instead. This operation is asynchronous — the API returns 202 Accepted when the request is queued for processing. The rate limit is 100 requests per second. Note: Each item ID must contain only alphanumeric characters and dashes (max 255 characters), and field names should not contain periods.

Parámetros de entrada

documentsobjectObligatorio
JSON map of item ID to item values. Maximum 1000 items per request. Maximum 30KB per item value. Item IDs must contain only alphanumeric characters and dashes (max 255 characters). Do not use periods in field names.
catalogNamestringObligatorio
The name of the catalog where items will be created. Alphanumeric with dashes, case-insensitive, maximum 255 characters.
replaceUploadedFieldsOnlyboolean
If true, only the fields included in the upload will be replaced for existing items, preserving other existing fields. If false (default), the entire item will be overwritten.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a new listITERABLE_CREATE_LISTAcción

Create a new static list in Iterable. Use this action when you need to create a new contact list that can be used for email campaigns, segmentation, or organizing contacts. Each list must have a unique name within the project. The newly created list starts empty and can be populated by adding contacts via other Iterable API actions.

Parámetros de entrada

namestringObligatorio
The name for the new list. List names must be unique within a project.
descriptionstring
An optional description for the list, providing context about its purpose.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create snippetITERABLE_CREATE_SNIPPETAcción

Creates a new code snippet in Iterable. Use this action when you need to create a reusable code snippet that can be referenced in campaigns, templates, or other Iterable features. The snippet name must be unique within the project and cannot be changed after creation.

Parámetros de entrada

namestringObligatorio
Name of the snippet. Must be unique within the project, up to 100 characters (a-z, A-Z, 0-9, hyphens (-), underscores (_), and spaces). Cannot be changed after snippet is created.
contentstringObligatorio
Content of the snippet. Handlebars must be valid. Disallowed content: script tags with JS sources or non-JSON content, inline JS event handlers (e.g., onload="..."), and javascript: in href or src attributes (anchors and iframes).
variablesstring[]
A list of variable names used in the content with a Handlebars expression such as {{#if (eq myVariable "someValue")}}. Variable names are case-sensitive and should be simple identifiers (letters, numbers, underscores).
descriptionstring
Description of the snippet.
createdByUserIdstring
User ID (email) of the creator. If not provided, defaults to the project creator.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Deactivate Triggered CampaignITERABLE_DEACTIVATE_TRIGGERED_CAMPAIGNAcción

Deactivate a triggered campaign in Iterable. Use when you need to stop a triggered campaign from firing based on user events. This action is irreversible — once a triggered campaign is deactivated, it cannot be reactivated through this API. Use the Iterable dashboard or the activate triggered campaign endpoint to reactivate it. Note: Only triggered campaigns can be deactivated. Regular blast campaigns cannot be deactivated using this endpoint.

Parámetros de entrada

campaignIdintegerObligatorio
The unique identifier of the triggered campaign to deactivate. Use the campaign ID returned from the 'List campaigns' or 'Get campaign' endpoint.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Bulk delete templatesITERABLE_DELETE_BULK_TEMPLATESAcción

Bulk delete one or more base templates from Iterable. Use this action when you need to permanently remove multiple templates that are no longer needed. This action is irreversible — templates cannot be recovered once deleted. Note: Templates associated with a campaign will not be deleted and will be skipped.

Parámetros de entrada

idsinteger[]Obligatorio
List of template IDs to delete. Templates associated with a campaign will not be deleted.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a catalogITERABLE_DELETE_CATALOGAcción

Delete a catalog by its name. This action also deletes all collections that reference the specified catalog. Use this action when you need to permanently remove a catalog and all its associated collections from Iterable. This action is irreversible — the catalog and all associated collections cannot be recovered once deleted.

Parámetros de entrada

catalogNamestringObligatorio
Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a Catalog ItemITERABLE_DELETE_CATALOG_ITEMAcción

Deletes the specified item from a catalog. This action is asynchronous — the data may not be deleted immediately. Use this action when you need to remove a specific item from a catalog by its unique identifier. This action is irreversible — once the item is deleted, it cannot be recovered unless a backup or re-sync mechanism is in place.

Parámetros de entrada

itemIdstringObligatorio
The unique identifier of the catalog item to delete. Alphanumeric with dashes, case sensitive, max 255 characters.
catalogNamestringObligatorio
The name of the catalog from which to delete the item. Alphanumeric with dashes, case insensitive, max 255 characters.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Catalog ItemsITERABLE_DELETE_CATALOG_ITEMSAcción

Asynchronously deletes catalog items from a specified catalog in Iterable. Use when you need to remove specific items from a catalog by their IDs. This action processes the deletion asynchronously — the API may return a 202 Accepted status indicating the request has been queued for processing. Important: This action is irreversible — the catalog items cannot be recovered once deleted. Note: This endpoint supports bulk deletion of multiple items at once. Ensure all item IDs in the request are valid and exist in the catalog to avoid partial deletions.

Parámetros de entrada

itemIdsstring[]Obligatorio
List of item IDs to delete from the catalog. Each ID should reference an existing item in the catalog.
catalogNamestringObligatorio
The name of the catalog from which to delete items. Alphanumeric with dashes, case-insensitive, max 255 characters.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a listITERABLE_DELETE_LISTAcción

Delete a list by its listId. Use this action when you need to permanently remove a contact list from Iterable. This action is irreversible — the list and all associated data cannot be recovered once deleted. Note: Lists that are currently in use (e.g., in active campaigns) may not be deletable and will return a 409 error.

Parámetros de entrada

listIdintegerObligatorio
The unique identifier of the list to delete.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Metadata TableITERABLE_DELETE_METADATA_TABLEAcción

Asynchronously deletes a metadata table by its table name. Use when you need to permanently remove a metadata table from Iterable. This action is asynchronous - a 200 response indicates a valid request that will be processed, but the table may not be deleted immediately. Use GET /api/metadata/{table} to verify that the deletion is complete. This action is irreversible — the table and all associated data cannot be recovered once deleted.

Parámetros de entrada

tablestringObligatorio
The name of the table to delete. Alphanumeric, case insensitive.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete snippetITERABLE_DELETE_SNIPPETAcción

Deletes a snippet by its ID (numeric) or name (string). Numeric identifiers are treated as snippet IDs, string identifiers as snippet names. Use this action when you need to remove a snippet that is no longer needed. This action is irreversible - the snippet cannot be recovered once deleted.

Parámetros de entrada

identifierstringObligatorio
Snippet identifier. Numeric identifiers are treated as snippet IDs, string identifiers are treated as snippet names.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete User By IDITERABLE_DELETE_USER_BY_IDAcción

Asynchronously deletes a user by userId from Iterable. Use when you need to remove a user from Iterable's system by their userId. This action does not prevent future data collection about the user. If multiple users share the same userId, they'll all be deleted. This endpoint can be used to delete users from email-based projects, userID-based projects, and hybrid projects. Important: This action is irreversible — the user data cannot be recovered once deleted. Note: userId values containing a '/' character are not supported by this endpoint.

Parámetros de entrada

userIdstringObligatorio
The unique identifier of the user to delete. Note: userId values containing a '/' character are not supported by this endpoint.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Export data to CSVITERABLE_EXPORT_DATA_CSVAcción

Export campaign analytics data in CSV format from Iterable. Use when you need to retrieve event data such as email sends, opens, clicks, push notifications, SMS messages, purchases, or custom events. Note: Either use the 'range' parameter (recommended for simple date filtering) OR use 'startDateTime' and 'endDateTime' together for custom date ranges. Using both will result in an error. Rate limit: 4 requests per minute per project.

Parámetros de entrada

rangestringenum
Predefined date range options for export.
TodayYesterdayBeforeTodayAll
delimiterstring
CSV file delimiter character.
campaignIdinteger
Filter export to only include data from this specific campaign ID.
omitFieldsstring
Comma-separated list of field names to omit from the export.
onlyFieldsstring
Comma-separated list of field names to include in the export. Only these fields will be returned.
endDateTimestring
Export ending at this datetime (<) in format yyyy-MM-dd HH:mm:ss [ZZ]. Cannot be used together with range.
dataTypeNamestringObligatorioenum
The type of data to export. Choose from various event types including email, push, SMS, in-app, web push, purchase, custom events, and user data.
emailSendemailOpenemailClickhostedUnsubscribeClickemailComplaintemailBounceemailSendSkippushSendpushOpenpushUninstallpushBouncepushSendSkip+39
startDateTimestring
Export starting from this datetime (>=) in format yyyy-MM-dd HH:mm:ss [ZZ]. Cannot be used together with range.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Export Campaign Data to JSONITERABLE_EXPORT_DATA_JSONAcción

Export campaign analytics data in JSON format with one entry per line. Use when you need to retrieve campaign metrics such as email sends, opens, clicks, purchases, or custom events. Rate limit: 4 requests per minute per project. Either 'range' OR 'startDateTime'/'endDateTime' must be provided.

Parámetros de entrada

rangestringenum
Valid date range values.
TodayYesterdayBeforeTodayAll
campaignIdinteger
Filter to only export data from a specific campaign ID.
omitFieldsstring
Comma-separated list of fields to exclude from the export.
onlyFieldsstring
Comma-separated list of field names to include in the export.
endDateTimestring
Export ending at this datetime (<). Format: yyyy-MM-dd HH:mm:ss [ZZ]. Use instead of 'range'.
dataTypeNamestringObligatorioenum
The type of data to export (e.g., 'emailSend', 'emailOpen', 'purchase')
emailSendemailOpenemailClickhostedUnsubscribeClickemailComplaintemailBounceemailSendSkippushSendpushOpenpushUninstallpushBouncepushSendSkip+39
startDateTimestring
Export starting from this datetime (>=). Format: yyyy-MM-dd HH:mm:ss [ZZ]. Use instead of 'range'.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Export User EventsITERABLE_EXPORT_USER_EVENTSAcción

Export all events for a user identified by email or userId. Returns events as JSON, one event per line. Use this action when you need to retrieve the complete event history for a specific user in Iterable. Either email or userId must be provided, but not both. Custom events are excluded by default unless includeCustomEvents is set to true.

Parámetros de entrada

emailstring
Export events for the user with this email address. Provide either email or userId, not both.
userIdstring
Export events for the user with this user ID. Provide either email or userId, not both.
includeCustomEventsboolean
Whether to include custom events in the export. Defaults to False.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Forget UserITERABLE_FORGET_USERAcción

Deletes the specified user's data from the Iterable project and prevents future data collection about them. This action is used for GDPR compliance. Use this action when you need to permanently remove a user's data from Iterable and ensure no future data is collected about them. In email-based projects, you must forget users by email. In userID-based projects, you must forget users by userId. In hybrid projects, you can forget users by either email or userId. Learn about identifying users by userId and email. Note: This action is irreversible - once a user is forgotten, their data cannot be recovered and future data collection about them is prevented.

Parámetros de entrada

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.
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.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get campaign by IDITERABLE_GET_CAMPAIGNAcción

Retrieves a campaign by its unique ID. Use this action when you need to fetch detailed information about a specific campaign from Iterable. The response includes campaign metadata such as state, type, timing, and associated lists or templates.

Parámetros de entrada

idintegerObligatorio
The unique identifier of the campaign to retrieve.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Campaign MetricsITERABLE_GET_CAMPAIGN_METRICSAcción

Retrieve performance metrics for one or more campaigns. Use when you need to analyze delivery, open, click, and conversion rates for your email, push, or SMS campaigns. This action allows filtering by specific campaign IDs and/or a date range. Note: Rate limited to 10 requests per minute per project.

Parámetros de entrada

campaignIdinteger[]Obligatorio
Campaign ID(s) to export. Specify multiple campaignId query parameters to export multiple campaigns.
endDateTimestring
Export ending at this datetime (<). Format: YYYY-MM-DD or ISO 8601 datetime. Defaults to 2018-07-25 if not specified.
startDateTimestring
Export starting from this datetime (>=). Format: YYYY-MM-DD or ISO 8601 datetime. Defaults to 2018-06-25 if not specified.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Catalog Field MappingsITERABLE_GET_CATALOG_FIELD_MAPPINGSAcción

Tool to retrieve field mappings (field to data type) and undefined fields for a catalog in Iterable. Use when you need to inspect the schema structure and data type definitions of a catalog.

Parámetros de entrada

catalogNamestringObligatorio
Name of the catalog to retrieve field mappings for. Maximum 255 characters; allowed character set is enforced by the Iterable API, not validated here.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get catalog item by IDITERABLE_GET_CATALOG_ITEMAcción

Retrieves a specific catalog item by its ID from the specified catalog. Use this action when you need to fetch a single item from a catalog using its unique identifier.

Parámetros de entrada

itemIdstringObligatorio
The unique identifier of the catalog item. Must be alphanumeric with dashes, case-sensitive, maximum 255 characters.
catalogNamestringObligatorio
The name of the catalog. Must be alphanumeric with dashes, case-insensitive, maximum 255 characters.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get email template by IDITERABLE_GET_EMAIL_TEMPLATEAcción

Get an email template by templateId. Use this action when you need to retrieve a specific email template from Iterable to view its content, settings, sender configuration, or metadata. The response includes the template's HTML and plain text content, sender information (from email, reply-to), subject line, and various rendering options like data feeds, link parameters, and analytics settings. Optionally, you can specify a locale parameter to retrieve localized content if available.

Parámetros de entrada

localestring
The locale for the content to retrieve. Leave empty for default locale. Iterable will automatically send the content with locale that matches a 'locale' field in the user profile.
templateIdintegerObligatorio
The unique identifier of the email template to retrieve.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Embedded MessagesITERABLE_GET_EMBEDDED_MESSAGESAcción

Retrieves embedded messages for which the specified user is eligible, grouped by placementId. Use this action when you need to fetch in-app embedded messages for a user based on their email or userId. By default, it returns data for all placements that have messages for the user. To constrain the response to specific placements, provide one or more placementIds query parameters.

Parámetros de entrada

emailstring
User identifier by email. Provide an email or a userId, but not both.
userIdstring
User identifier by userId. Provide a userId or an email, but not both.
platformstring
The platform of the app for which to retrieve embedded messages: iOS, Android, or Web (case-sensitive).
sdkVersionstring
Iterable SDK version (e.g., 6.5.0).
packageNamestring
The package name of the app for which to retrieve embedded messages.
placementIdsinteger[]
Placements to include in the response, even if they don't have embedded messages for the user. When no placementIds are specified, the response includes all embedded messages for which the user is eligible.
currentMessageIdsstring[]
IDs of embedded messages already retrieved by the device making the request. If the user is no longer eligible for a specified message, that message will be omitted from the API response. Otherwise, it will be present, but without an elements field.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Embedded TemplateITERABLE_GET_EMBEDDED_TEMPLATEAcción

Retrieves an embedded message template by its unique ID. Use this action when you need to fetch detailed information about a specific embedded message template from Iterable, including its content, visual elements, and metadata. Optionally filter by locale to retrieve localized content.

Parámetros de entrada

localestring
Locale of content to get. Leave empty for default locale. Iterable automatically sends the content with a locale that matches a user profile's locale field.
templateIdintegerObligatorio
The unique identifier of the embedded message template to retrieve.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Experiment MetricsITERABLE_GET_EXPERIMENT_METRICSAcción

Retrieve metrics for email experiments. Use when you need to analyze performance data for A/B tests or email experiments. This action allows filtering by specific experiment IDs, campaign IDs, and/or a date range. Currently only email experiment metrics are supported.

Parámetros de entrada

campaignIdstring[]
Campaign IDs whose experiments to export. Specify multiple campaignId query parameters to export multiple campaigns.
endDateTimestring
Export ending at this datetime (<=). Format: YYYY-MM-DD or ISO 8601 datetime.
experimentIdstring[]
Experiment IDs to export. Specify multiple experimentId query parameters to export multiple experiments.
startDateTimestring
Export starting from this datetime (>=). Format: YYYY-MM-DD or ISO 8601 datetime.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get In-App MessagesITERABLE_GET_IN_APP_MESSAGESAcción

Get a user's in-app messages from Iterable. This endpoint always returns the user's non-selective (not app-specific) in-app messages. To also fetch app-specific in-app messages, include a packageName and platform in the request. Use this action when you need to retrieve in-app messages for a user, including new messages and messages that have already been saved to a mobile inbox. Each message includes a read field to indicate whether it has been seen.

Parámetros de entrada

countintegerObligatorio
The number of in-app messages to fetch.
emailstring
The email address of the user for which to fetch in-app messages. Specify either an email or a userId.
userIdstring
The userId of the user for which to fetch in-app messages. Specify either an email or a userId.
platformstringenum
Platform enum for mobile apps.
iOSAndroidWebOTT
sdkVersionstring
Iterable SDK version (e.g., 6.2.17).
packageNamestring
The package name of the app for which to retrieve selective in-app messages.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get in-app template by IDITERABLE_GET_IN_APP_TEMPLATEAcción

Retrieves an in-app template by its unique ID. Use this action when you need to fetch detailed information about a specific in-app template from Iterable, including its content, display settings, and metadata. Optionally specify a locale to retrieve localized content.

Parámetros de entrada

localestring
The locale of content to get. If not specified, returns the default locale content.
templateIdintegerObligatorio
The unique identifier of the in-app template to retrieve.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get List SizeITERABLE_GET_LIST_SIZEAcción

Get the number of users within a list. Returns the count of users currently subscribed to the specified list. Use this action when you need to check how many users are in a specific list for reporting, list management, or campaign planning purposes.

Parámetros de entrada

listIdintegerObligatorio
The unique identifier of the list to get size for.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get push template by IDITERABLE_GET_PUSH_TEMPLATEAcción

Retrieves a push template by its unique ID. Use this action when you need to fetch a specific push template from Iterable to view its settings, content, or configuration. The response includes all template properties including message content, buttons, deeplinks, and metadata. Rate limit: 100 requests/second, per project.

Parámetros de entrada

localestring
Locale of content to get. If not specified, returns content for the default locale.
templateIdintegerObligatorio
The unique identifier of the push template to retrieve.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get SMS templateITERABLE_GET_SMS_TEMPLATEAcción

Retrieves an SMS template by its unique ID. Use this action when you need to fetch the content, metadata, and settings of a specific SMS template from Iterable. The response includes the template message content, locale information, tracking settings, and other configuration details. Rate limit: 100 requests/second, per project.

Parámetros de entrada

localestring
Locale of content to get. If not specified, returns content in the default locale.
templateIdintegerObligatorio
The unique identifier of the SMS template to retrieve.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get snippet by ID or nameITERABLE_GET_SNIPPETAcción

Retrieves a snippet by its ID (numeric) or name (string). Numeric identifiers are treated as snippet IDs, string identifiers as snippet names. Use this action when you need to retrieve a specific snippet by its identifier to view its content, metadata, or associated variables.

Parámetros de entrada

identifierstringObligatorio
Snippet identifier. Numeric identifiers are treated as snippet IDs, string identifiers are treated as snippet names.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get template by client template IDITERABLE_GET_TEMPLATE_BY_CLIENT_IDAcción

Retrieves an email template by its client-defined template ID. Use this action when you need to find templates using a client-specific identifier rather than the internal Iterable template ID. The response contains a list of templates that match the provided clientTemplateId. Rate limit: 100 requests/second, per project.

Parámetros de entrada

clientTemplateIdstringObligatorio
The client-defined template identifier to search for.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User By IDITERABLE_GET_USER_BY_IDAcción

Get a user by userId from Iterable. Use when you need to retrieve user information using a specific userId. This action fetches user data including email, userId, and any additional dataFields stored in Iterable. Unlike path-parameter endpoints, this query-parameter-based endpoint provides better support for special characters (such as '/') in the userId value. Rate limit: 100 requests/second per project.

Parámetros de entrada

userIdstringObligatorio
The unique identifier of the user to retrieve. This endpoint provides better support for special characters in userId values compared to path-parameter alternatives.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User By ID (Path)ITERABLE_GET_USER_BY_ID_PATHAcción

Get a user by userId (path parameter) from Iterable. Use when you need to retrieve user information using a specific userId as a path parameter. This action fetches user data including email, userId, and any additional dataFields stored in Iterable. Note: This endpoint does not work for userId values that contain a '/' character. For userIds with special characters, use the query-parameter-based GET /api/users/byUserId endpoint instead. Rate limit: 100 requests/second per project.

Parámetros de entrada

userIdstringObligatorio
The unique identifier of the user to retrieve. Note: userId values containing a '/' character are not supported by this path-parameter endpoint. Use the query-parameter based alternative in such cases.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User EventsITERABLE_GET_USER_EVENTSAcción

Get events for a specific user by userId. Use when you need to retrieve the event history for a particular user from Iterable. This action allows you to fetch a user's event data including campaign interactions, channel activity, and associated metadata. The results can be filtered using the limit parameter to control the number of events returned (max 200). Note: This endpoint does not support userId values containing a '/' character.

Parámetros de entrada

limitinteger
The maximum number of events to retrieve. Must be between 1 and 200. Defaults to 30 if not specified.
userIdstringObligatorio
The unique identifier of the user whose events you are retrieving. Note: userId values containing a '/' character are not supported by this endpoint.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User Sent MessagesITERABLE_GET_USER_SENT_MESSAGESAcción

Get messages sent to a user by email address or userId. Use when you need to retrieve the message history for a specific user in Iterable. This action returns messages sent to a user, with optional filtering by campaign, date range, and message type. Returns 10 messages by default, up to a maximum of 1000. Rate limit: 3 requests/second per project. Note: Either email or userId must be provided to identify the user, but not both.

Parámetros de entrada

emailstring
The email address of the user. Either email or userId must be provided, but not both.
limitinteger
The maximum number of messages to return. Defaults to 10, maximum is 1000.
userIdstring
The unique identifier of the user. Either email or userId must be provided, but not both.
campaignIdsinteger[]
Only include messages from these campaign IDs.
endDateTimestring
End date time in the format yyyy-MM-dd HH:mm:ss ZZ (e.g., '2024-01-31 23:59:59 -05:00').
messageMediumstring
Only include messages of this type. Must be one of: Email, Push, InApp, SMS.
startDateTimestring
Start date time in the format yyyy-MM-dd HH:mm:ss ZZ (e.g., '2024-01-15 10:30:00 -05:00').
excludeBlastCampaignsboolean
Whether to exclude results coming from blast campaigns. This is ignored if campaignIds is set.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Web In-App MessagesITERABLE_GET_WEB_IN_APP_MESSAGESAcción

Get a user's web in-app messages from Iterable. This endpoint always returns the user's non-selective (not app-specific) web in-app messages. To also fetch web app-specific in-app messages, include a packageName in the request. This endpoint returns new messages and messages that have already been saved to a mobile inbox, and each message has a read field to indicate whether or not it has already been seen. Use when you need to retrieve in-app messages for a user, such as displaying an inbox of notifications or checking unread message status.

Parámetros de entrada

countintegerObligatorio
The number of web in-app messages to fetch.
emailstring
The email address of the user for which to fetch in-app messages. Specify either an email or a userId.
userIdstring
The userId of the user for which to fetch in-app messages. Specify either an email or a userId.
SDKVersionstring
Iterable SDK version (e.g., 6.2.17).
packageNamestring
The package name of the app for which to retrieve selective web in-app messages.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all campaignsITERABLE_LIST_CAMPAIGNSAcción

Retrieves metadata about all campaigns in a project with optional pagination. Use this action when you need to enumerate all campaigns in a project, retrieve campaign IDs for subsequent operations, or paginate through large result sets. The response includes campaign metadata such as state, type, timing, and associated lists or templates. If no pagination parameters are provided, the unpaginated API returns all campaigns (deprecated behavior, may be removed in the future). Rate limit: 100 requests/second, per project.

Parámetros de entrada

pageinteger
Page number for pagination (starting at 1).
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
pageSizeinteger
Number of results to return per page (defaults to 20, maximum of 1000).
campaignStatestring[]
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.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Catalog ItemsITERABLE_LIST_CATALOG_ITEMSAcción

Get the catalog items for a catalog. Use when you need to retrieve items stored in a specific Iterable catalog, such as product catalogs, user preferences, or custom data sets. Supports pagination and sorting for large catalogs. Rate limit: 100 requests/second per API key.

Parámetros de entrada

pageinteger
Page number to retrieve (starting at 1). Use for pagination when results span multiple pages.
orderBystring
Field by which results should be ordered. Must have a defined type if used with sortAscending.
pageSizeinteger
Number of results to display per page. Defaults to 10 if not specified.
catalogNamestringObligatorio
Name of the catalog to retrieve items from. Alphanumeric with dashes, max 255 characters, case insensitive.
sortAscendingboolean
Sort results in ascending order. Defaults to false (descending).

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List CatalogsITERABLE_LIST_CATALOGSAcción

Tool to retrieve all catalog names from Iterable. Use when you need to list available catalogs before performing catalog-specific operations like getting or setting catalog records.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List ChannelsITERABLE_LIST_CHANNELSAcción

Get all message channels within the Iterable project. Use this action when you need to retrieve all available communication channels (e.g., email, push notifications) configured in your Iterable project. This is useful for identifying valid channel options when creating campaigns or managing messaging workflows.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List export filesITERABLE_LIST_EXPORT_FILESAcción

Get the job status and files for an export started with the 'Start export' endpoint. Occasionally, a job status may change from running to enqueued because it had to restart. When this happens, the job maintains progress and begins where it previously stopped. Iterable uses exponential backoff for retries. Files are added to the list as the export job is running. Paginate through the files by using the last file name in the response as the startAfter value for the next request. Use when you need to monitor export progress, retrieve export results, or paginate through large export file lists.

Parámetros de entrada

jobIdintegerObligatorio
The ID of the export job. Use the jobId returned from the 'Start export' endpoint.
startAfterstring
Skip file names up to and including this value. Use for paginating over the files in the export.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Export JobsITERABLE_LIST_EXPORT_JOBSAcción

Retrieve a list of recent export jobs for the current project. Use when you need to monitor export job status, check for completed exports, or manage data export operations.

Parámetros de entrada

jobStatestring
Filter results to only include jobs in the specified state. Common states include 'started', 'completed', 'failed', or 'cancelled'.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Forgotten User IDsITERABLE_LIST_FORGOTTEN_USER_IDSAcción

Get hashed user IDs of forgotten users for GDPR compliance. Returns a hash for each userId currently forgotten by your project. Each forgotten userId is lowercased, trimmed, and hashed using SHA-256. Use this action when you need to retrieve forgotten user data for GDPR compliance audits or data subject request processing. Note: This endpoint only works for userID-based and hybrid projects. For email-based projects, it returns an error. Rate limit: 3 requests/second, per project.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List JourneysITERABLE_LIST_JOURNEYSAcción

Get a list of journeys (workflows) within your Iterable project. Use this action when you need to retrieve and browse through marketing automation journeys, including their status, configuration, and metadata. Supports pagination, sorting, and filtering by journey state (active, archived, etc.).

Parámetros de entrada

pageinteger
Page number (starting at 1) for pagination.
sortstring
Sort field with optional direction prefix. Use - for descending, + or no prefix for ascending. Examples: -createdAt, +name, id
statestring[]
Filter journeys by state. Without this parameter, returns all non-archived journeys. With state set to 'Archived', returns only archived journeys.
pageSizeinteger
Number of results to return per page (defaults to 10, maximum of 50).

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List ListsITERABLE_LIST_LISTSAcción

Retrieve all lists within a project. Use when you need to enumerate available lists, retrieve list IDs for subsequent operations, or understand the structure of contact lists. Rate limit: 100 requests/second, per project.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List List UsersITERABLE_LIST_LIST_USERSAcción

Get all users within a list. Use when you need to retrieve the complete list of users subscribed to a specific list for export, analysis, or batch operations. This action returns all users in the list (unlike preview which returns a sample). Rate limit: 5 requests/minute, per project.

Parámetros de entrada

listIdintegerObligatorio
The unique identifier of the list to get users from.
preferUserIdboolean
If true, will return the userId instead of email if both exist in a user profile for a hybrid project. Defaults to false.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Message TypesITERABLE_LIST_MESSAGE_TYPESAcción

Lists all message types within a project. Use when you need to retrieve all available message types (e.g., Email, Push, SMS) and their associated metadata such as channel ID, subscription policy, and rate limits. Rate limit: 100 requests/second, per project.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Metadata KeysITERABLE_LIST_METADATA_KEYSAcción

List all keys in a metadata table. Use when you need to discover what keys exist within a specific metadata table (e.g., to find keys before retrieving or deleting individual metadata items). Results may be paginated; use the `nextMarker` parameter to retrieve subsequent pages.

Parámetros de entrada

tablestringObligatorio
Table name (Alphanumeric, case insensitive). Examples: 'snippets', 'metadata', 'test'.
nextMarkerstring
next result set id; returned by previous search if more hits exist

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Metadata TablesITERABLE_LIST_METADATA_TABLESAcción

List available metadata tables in Iterable. Use when you need to discover what metadata tables are available for querying (e.g., users, events, campaigns). This action is read-only and idempotent.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List recurring campaign child campaignsITERABLE_LIST_RECURRING_CHILD_CAMPAIGNSAcción

Retrieve the child campaigns generated by a recurring campaign. Use when you need to list or monitor campaigns that were created from a recurring campaign template. Pagination is supported using page and pageSize parameters. Rate limit: 100 requests/second per project.

Parámetros de entrada

idintegerObligatorio
The ID of the recurring campaign to get child campaigns for.
pageinteger
Page number for pagination (starting at 1).
sortstring
Field to sort campaigns by, with optional direction prefix. Use '-' for descending, '+' or no prefix for ascending. Fields: id, name, createdAt, updatedAt, startAt. Examples: -createdAt, +name, id
pageSizeinteger
Number of results to return per page. Defaults to 20 if not specified. Maximum is 1000.
campaignStatestring[]
Filter campaigns by state. Can specify multiple states. Valid states: Draft, Ready, Scheduled, Running, Finished, Starting, Aborted, Recurring, Archived.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List SnippetsITERABLE_LIST_SNIPPETSAcción

Get all snippets for the current project. Use this action when you need to retrieve all code snippets available in the Iterable project, including their content, metadata, and associated variables.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all templatesITERABLE_LIST_TEMPLATESAcción

Retrieves metadata about all templates in a project with optional pagination. Use this action when you need to enumerate all templates in a project, retrieve template IDs for subsequent operations, or paginate through large result sets. If no pagination parameters are provided, the unpaginated API returns all templates (deprecated behavior, may be removed in the future). Rate limit: 100 requests/second, per project.

Parámetros de entrada

pageinteger
Page number for pagination (starting at 1).
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
pageSizeinteger
Number of results to return per page (defaults to 20, maximum of 1000).
endDateTimestring
Get templates created before this date time (yyyy-MM-dd HH:mm:ss [ZZ]).
templateTypestringenum
Template type enumeration for filtering.
BaseBlastTriggeredWorkflow
messageMediumstringenum
Message medium enumeration for filtering.
EmailPushInAppSMS
startDateTimestring
Get templates created at or after this date time (yyyy-MM-dd HH:mm:ss [ZZ]).

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List User FieldsITERABLE_LIST_USER_FIELDSAcción

Get all user fields within a project. Use when you need to discover what custom fields exist for users in your Iterable project, such as for understanding user data schema, creating imports, or validating field names before setting user data. Rate limit: 3 requests/second, per project.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List WebhooksITERABLE_LIST_WEBHOOKSAcción

Get all webhooks configured within the Iterable project. Use this action when you need to retrieve all webhook configurations, identify webhook IDs for subsequent operations, or understand the webhook setup for your project. This is useful for auditing webhook settings, checking which events are being monitored, or finding webhook endpoints. This action is read-only and idempotent.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Merge UsersITERABLE_MERGE_USERSAcción

Merge two user profiles in Iterable. Use when you need to consolidate duplicate user profiles. This action merges all profile data and events from the source user into the destination user. The source user profile will be deleted after the merge is complete. IMPORTANT: Provide exactly one source identifier (sourceEmail OR sourceUserId) and exactly one destination identifier (destinationEmail OR destinationUserId). The action will return an error if the source user does not exist. If the destination user is not found, the source user will be updated instead of merged. This action is irreversible — once merged, the source user profile cannot be recovered. Rate limit: 50 requests/second per API key.

Parámetros de entrada

arrayMergeobject[]
An array of objects specifying array fields to merge during the operation. Only references custom arrays, not Iterable-managed arrays like 'devices'.
sourceEmailstring
An email address that identifies the source user profile. Provide sourceEmail or sourceUserId (but not both).
sourceUserIdstring
A user ID that identifies the source user profile. Provide sourceEmail or sourceUserId (but not both).
destinationEmailstring
An email address that identifies the destination user profile. Provide destinationEmail or destinationUserId (but not both).
destinationUserIdstring
A user ID that identifies the destination user profile. Provide destinationEmail or destinationUserId (but not both).

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Preview email templateITERABLE_PREVIEW_EMAIL_TEMPLATEAcción

Generate a fully rendered HTML preview of an email template using custom data. Use this action when you need to preview how an email template will look when rendered with specific data fields or data feed data. This is useful for testing template rendering before sending campaigns, or for verifying template logic with different data scenarios. The preview shows exactly how the template will appear when sent to a user. Note: Fields not provided in the request data will be rendered as empty strings in the preview.

Parámetros de entrada

localestring
The locale of content to get. Leave empty for default locale.
dataFeedobject
Data feed content for template rendering. Provide key-value pairs for any data feed fields that your template references. Data feed fields are accessible as [[fieldName]] when template's mergeDataFeedContext=false, or as {{fieldName}} when mergeDataFeedContext=true. If fetchDataFeeds is true, this will be merged with (or overridden by) the fetched data feed data.
dataFieldsobject
Data fields for template rendering. Provide key-value pairs for any user profile, event, or custom fields that your template references. Fields are accessible as {{fieldName}} in templates.
templateIdintegerObligatorio
The unique identifier of the email template to preview.
fetchDataFeedsboolean
Whether to fetch and use actual data feeds configured in the template. If true, the data feeds associated with the template will be fetched and used for rendering. Data from dataFields will be used to render dynamic URLs in the data feed configuration. If dataFeed is also provided, it will be merged with (or override) the fetched data feed data. Defaults to false.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Preview in-app templateITERABLE_PREVIEW_IN_APP_TEMPLATEAcción

Generate a fully rendered HTML preview of an in-app template using custom data. Use this action when you need to simulate how a template would appear when sent to a user, allowing you to test template rendering with specific data fields and/or data feed data. This is useful for previewing templates before sending campaigns or testing template logic with different data scenarios. Note: If a template references a field that is not provided in the request data, that field will be rendered as an empty string, matching production behavior.

Parámetros de entrada

localestring
The locale of content to get. If not specified, returns the default locale content.
dataFeedobject
Data feed content for template rendering. Provide key-value pairs for any data feed fields that your template references. Data feed fields are accessible as [[fieldName]] when mergeDataFeedContext=false, or as {{fieldName}} when mergeDataFeedContext=true.
dataFieldsobject
Data fields for template rendering. Provide key-value pairs for any user profile, event, or custom fields that your template references. Fields are accessible as {{fieldName}} in templates.
templateIdintegerObligatorio
The unique identifier of the in-app template to preview.
fetchDataFeedsboolean
Whether to fetch and use actual data feeds configured in the template. If true, the data feeds associated with the template will be fetched and used for rendering. Defaults to false.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Preview List UsersITERABLE_PREVIEW_LIST_USERSAcción

Get a random sample of up to 5000 users within a list. Use when you need to quickly preview the users in a specific list without fetching the entire list. This action is useful for sampling list membership before running campaigns or verifying list content. Rate limit: 5 requests/minute, per project.

Parámetros de entrada

sizeinteger
Number of users to return, up to 5000. Defaults to 1000.
listIdintegerObligatorio
The unique identifier of the list to preview users from.
preferUserIdboolean
If true, will return the userId instead of email if both exist in a user profile for a hybrid project. Defaults to false.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Replace Catalog ItemITERABLE_REPLACE_CATALOG_ITEMAcción

Asynchronously creates or replaces the specified catalog item in the given catalog. Use this action when you need to completely replace a catalog item with new data. If the item already exists, it will be fully replaced by the value provided in the request body. Previously existing fields not included in the new value will be lost. This operation is asynchronous — the API returns 202 Accepted when the request is queued for processing. Use GET /api/catalogs/{catalogName}/items/{itemId} to verify completion. Note: A catalog item's ID must be unique, contain only alphanumeric characters and dashes, and have a maximum length of 255 characters. Do not use periods in field names. The rate limit is 1000 requests per second.

Parámetros de entrada

valueobjectObligatorio
JSON representation of the catalog item. Max size is 30KB. Do not use periods in field names.
itemIdstringObligatorio
The unique identifier of the catalog item. Must be alphanumeric with dashes, case-sensitive, maximum 255 characters.
catalogNamestringObligatorio
The name of the catalog containing the item. Alphanumeric with dashes, case-insensitive, maximum 255 characters.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Replace Metadata ItemITERABLE_REPLACE_METADATA_ITEMAcción

Asynchronously creates or replaces the metadata item associated with the specified key. Use when you need to create a new metadata item or completely replace an existing one. A 200 response indicates a valid request that will be processed; updates may not be made immediately. Use GET /api/metadata/{table}/{key} to verify the update completion. Note: This is an idempotent operation - calling it multiple times with the same parameters will result in the same state.

Parámetros de entrada

keystringObligatorio
Metadata key (Alphanumeric, case sensitive).
tablestringObligatorio
Table name (Alphanumeric, case insensitive).
valueobjectObligatorio
The JSON metadata value to store. Max size is 30KB.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Schedule CampaignITERABLE_SCHEDULE_CAMPAIGNAcción

Schedule an existing campaign to be sent at a specified time. Use when you have created a campaign and need to schedule it for future sending. The campaign must exist and not already be scheduled or in the process of sending. You can optionally specify time zone settings to send at the same local time across different recipient time zones. Note: The send time must be up to 7 days in the future. Scheduling can be modified or canceled before the send time using the 'Cancel campaign' endpoint.

Parámetros de entrada

sendAtstringObligatorio
When to send the campaign, up to 7 days in the future. ISO-8601 date time format (e.g. 2007-12-03T10:15:30Z).
campaignIdintegerObligatorio
The unique identifier of the campaign to schedule. Use the campaign ID returned from the 'List campaigns' or 'Get campaign' endpoint.
recipientTimeZoneobject
Time zone configuration for scheduled campaign sending. When sendMode is set to RecipientTimeZone, this specifies the time zone settings for determining when to send to each recipient.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Send CampaignITERABLE_SEND_CAMPAIGNAcción

Send an existing campaign immediately in Iterable. Use when you need to trigger a campaign to send right away, bypassing any scheduled send time. The campaign must be in a 'Ready' state before it can be sent using this endpoint. This action is useful for testing campaigns or sending them outside of their normal schedule. Note: Once a campaign starts sending, it cannot be stopped. Ensure the campaign is in the correct state before using this action.

Parámetros de entrada

campaignIdintegerObligatorio
The unique identifier of the campaign to send. Use the campaign ID returned from the 'List campaigns' or 'Get campaign' endpoint.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Send email template proofITERABLE_SEND_EMAIL_PROOFAcción

Send a proof of an email template to a specific user. Use this action when you need to preview an email template by sending a proof to a specific recipient before sending it to a larger audience. This allows you to verify that the template renders correctly with sample data and contains the expected content. Provide the template ID and either an email address or user ID to identify the recipient. You can optionally include data fields to merge into the template for more accurate preview rendering. Rate limit: 20 requests/second per API key.

Parámetros de entrada

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.
dataFieldsobject
A JSON object containing fields to merge into the template for the proof email. These fields will override user profile data fields of the same name.
templateIdintegerObligatorio
The template ID to send proof for. This is the unique identifier of the email template.
recipientEmailstring
An email address that identifies a user profile in Iterable. Provide a recipientEmail or recipientUserId (but not both), depending on how your project identifies users.
recipientUserIdstring
A user ID that identifies a user profile in Iterable. Provide a recipientEmail or recipientUserId (but not both), depending on how your project identifies users.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Send in-app notification to targetITERABLE_SEND_IN_APPAcción

Send an in-app notification to a specific user using Iterable. Use this action when you need to send an in-app notification directly to a recipient. The notification is sent based on a campaign/template ID, and the recipient is identified either by their email address or user ID. Request data fields override user profile data fields. A reference to the user profile is provided via the profile to help resolve field collisions. Learn about identifying users by userId and email.

Parámetros de entrada

sendAtstring
Schedule the message for up to 365 days in the future. If set in the past, the message is sent immediately. Format is YYYY-MM-DD HH:MM:SS in UTC.
campaignIdintegerObligatorio
The ID of the campaign/template to use for sending the in-app notification. The campaign must be associated with an in-app template.
dataFieldsobject
A JSON object containing fields to merge into the in-app template. These fields will override user profile data fields of the same name.
recipientEmailstring
An email address that identifies a user profile in Iterable. Provide a recipientEmail or recipientUserId (but not both), depending on how your project identifies users.
recipientUserIdstring
A user ID that identifies a user profile in Iterable. Provide a recipientEmail or recipientUserId (but not both), depending on how your project identifies users.
allowRepeatMarketingSendsboolean
Allow repeat marketing sends. Defaults to true. Set to false to prevent sending if the recipient has previously received a marketing message from this campaign.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Send in-app template proofITERABLE_SEND_IN_APP_PROOFAcción

Send a proof of an in-app template to a specific user using Iterable. Use this action when you need to preview how an in-app template will look for a specific user before sending the actual campaign. The proof email contains the rendered template with merge fields populated using the provided data fields and user profile information. Provide either recipientEmail or recipientUserId (but not both) to identify the target user. This action is rate-limited to 20 requests per second per API key.

Parámetros de entrada

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.
dataFieldsobject
Fields to merge into template for proof. These fields will override user profile data fields of the same name.
templateIdintegerObligatorio
Template ID to send proof for.
recipientEmailstring
An email address that identifies a user profile in Iterable. Provide a recipientEmail or recipientUserId (but not both), depending on how your project identifies users.
recipientUserIdstring
A user ID that identifies a user profile in Iterable. Provide a recipientEmail or recipientUserId (but not both), depending on how your project identifies users.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Send push to targetITERABLE_SEND_PUSHAcción

Send a push notification to a specific user using Iterable. Use this action when you need to send a transactional push notification directly to a recipient. The push is sent based on a campaign/template ID, and the recipient is identified either by their email address or user ID. Request data fields override user profile data fields. A reference to the user profile is provided via the profile to help resolve field collisions. Learn about identifying users by userId and email.

Parámetros de entrada

sendAtstring
Schedule the message for up to 365 days in the future. If set in the past, the push is sent immediately. Format is YYYY-MM-DD HH:MM:SS in UTC.
metadataobject
Metadata to pass back via system webhooks. This is not used for rendering the push notification content.
campaignIdintegerObligatorio
The ID of the campaign/template to use for sending the push notification. The campaign must be associated with a push template.
dataFieldsobject
A JSON object containing fields to merge into the push template. These fields will override user profile data fields of the same name.
recipientEmailstring
An email address that identifies a user profile in Iterable. Provide a recipientEmail or recipientUserId (but not both), depending on how your project identifies users.
recipientUserIdstring
A user ID that identifies a user profile in Iterable. Provide a recipientEmail or recipientUserId (but not both), depending on how your project identifies users.
allowRepeatMarketingSendsboolean
Allow repeat marketing sends. Defaults to true. Set to false to prevent sending if the recipient has previously received a marketing push from this campaign.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Send push template proofITERABLE_SEND_PUSH_PROOFAcción

Send a proof of a push template to a specific user. Use this action when you need to preview a push template by sending a proof to a specific recipient before sending it to a larger audience. This allows you to verify that the template renders correctly with sample data and contains the expected content. Provide the template ID and either an email address or user ID to identify the recipient. You can optionally include data fields to merge into the template for more accurate preview rendering. # ci-skip: action-tags (POST /api/templates/push/proof sends a proof push as a side effect, not a durable resource creation) Rate limit: 20 requests/second per API key.

Parámetros de entrada

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.
dataFieldsobject
A JSON object containing fields to merge into the template for the proof message. These fields will override user profile data fields of the same name.
templateIdintegerObligatorio
The template ID to send proof for. This is the unique identifier of the push template.
recipientEmailstring
An email address that identifies a user profile in Iterable. Provide a recipientEmail or recipientUserId (but not both), depending on how your project identifies users.
recipientUserIdstring
A user ID that identifies a user profile in Iterable. Provide a recipientEmail or recipientUserId (but not both), depending on how your project identifies users.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Send SMS template proofITERABLE_SEND_SMS_PROOFAcción

Send a proof of an SMS template to a specific user. Use this action when you need to preview an SMS template by sending a proof to a specific recipient before sending it to a larger audience. This allows you to verify that the template renders correctly with sample data and contains the expected content. Provide the template ID and either an email address or user ID to identify the recipient. You can optionally include data fields to merge into the template for more accurate preview rendering. Rate limit: 20 requests/second per API key.

Parámetros de entrada

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.
dataFieldsobject
A JSON object containing fields to merge into the template for the proof SMS. These fields will override user profile data fields of the same name.
templateIdintegerObligatorio
The template ID to send proof for. This is the unique identifier of the SMS template.
recipientEmailstring
An email address that identifies a user profile in Iterable. Provide a recipientEmail or recipientUserId (but not both), depending on how your project identifies users.
recipientUserIdstring
A user ID that identifies a user profile in Iterable. Provide a recipientEmail or recipientUserId (but not both), depending on how your project identifies users.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Send WhatsApp to targetITERABLE_SEND_WHATS_APPAcción

Send a WhatsApp message to a specific user using Iterable. Use this action when you need to send a transactional WhatsApp message directly to a recipient. The WhatsApp message is sent based on a campaign/template ID, and the recipient is identified either by their email address or user ID. Request data fields override user profile data fields. This API is typically used for transactional messaging. Learn about identifying users by userId and email.

Parámetros de entrada

sendAtstring
Schedule the message for up to 365 days in the future. If set in the past, the WhatsApp message is sent immediately. Format is YYYY-MM-DD HH:MM:SS in UTC.
campaignIdintegerObligatorio
The ID of the campaign/template to use for sending the WhatsApp message. The campaign must be associated with a WhatsApp template.
dataFieldsobject
A JSON object containing fields to merge into the WhatsApp template. These fields will override user profile data fields of the same name.
recipientEmailstring
An email address that identifies a user profile in Iterable. Provide a recipientEmail or recipientUserId (but not both), depending on how your project identifies users.
recipientUserIdstring
A user ID that identifies a user profile in Iterable. Provide a recipientEmail or recipientUserId (but not both), depending on how your project identifies users.
allowRepeatMarketingSendsboolean
Allow repeat marketing sends. Defaults to true. Set to false to prevent sending if the recipient has previously received a marketing WhatsApp message from this campaign.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Start ExportITERABLE_START_EXPORTAcción

Start a data export job. The export processes as a background job asynchronously. Use the 'List export files' action to check export status by jobId and obtain file download links once completed. Use this action when you need to export data such as user profiles, email events, push notifications, SMS messages, purchases, or custom events. The exported data can be in CSV or JSON format. Rate limit: 1 request/second, per organization. Concurrent request limit: Up to 4 exports process at a time, per organization. Additional requests are queued.

Parámetros de entrada

delimiterstring
CSV file delimiter character. Only applicable when output_format is 'text/csv'.
campaignIdinteger
Only export data from this specific campaign ID.
omitFieldsstring
Comma-separated list of field names to omit from the export.
onlyFieldsstring
Comma-separated list of field names to include in the export. Only these fields will be returned.
endDateTimestring
Export events occurring or users updated before date and time exclusive. Format: yyyy-MM-dd HH:mm:ss [ZZ].
dataTypeNamestringObligatorioenum
The type of data to export. Choose from various event types including email, push, SMS, in-app, web push, purchase, custom events, and user data.
emailSendemailOpenemailClickhostedUnsubscribeClickemailComplaintemailBounceemailSendSkippushSendpushOpenpushUninstallpushBouncepushSendSkip+39
outputFormatstringObligatorioenum
The output format for the export file. Use 'text/csv' for CSV format or 'application/x-json-stream' for JSON newline-delimited format.
text/csvapplication/x-json-stream
startDateTimestring
Export events occurring or users updated after date and time inclusive. Format: yyyy-MM-dd HH:mm:ss [ZZ].

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Subscribe to ListITERABLE_SUBSCRIBE_TO_LISTAcción

Subscribe one or more users to a specific list in Iterable. Use this action when you need to add subscribers to a list by their email address, userId, or both. The action can create new user profiles if they don't exist (unless updateExistingUsersOnly is set to true). This is an idempotent operation - re-subscribing a user who is already on the list has no additional effect. Learn about identifying users by userId and email.

Parámetros de entrada

listIdintegerObligatorio
The unique identifier of the list to subscribe users to.
subscribersobject[]Obligatorio
List of subscribers to add to the list. Each subscriber must have at least an email or userId.
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.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Subscribe User By IDITERABLE_SUBSCRIBE_USER_BY_IDAcción

Subscribes a user to the specified subscription group by their userId. Use when you need to add a user to a specific email list, message type, or message channel subscription. Contact your customer success manager to enable this API before using this action.

Parámetros de entrada

userIdstringObligatorio
The unique userId of the user to subscribe.
subscriptionGroupstringObligatorio
The subscription group type. Valid values: 'emailList', 'messageType', 'messageChannel'. Alphanumeric, case insensitive.
subscriptionGroupIdintegerObligatorio
The numeric ID of the subscription group. For email lists, this is the list ID.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Track Embedded ClickITERABLE_TRACK_EMBEDDED_CLICKAcción

Tracks a click event on an embedded message. Use this action when you need to record user interactions with buttons or links in embedded messages. This creates an embeddedClick event in Iterable for analytics and campaign tracking purposes. For test messages (proofs), no events are created. Note: You must provide either an email or userId to identify the user profile, but not both.

Parámetros de entrada

emailstring
Email address identifying the user profile. Provide either email or userId, but not both.
userIdstring
User ID identifying the user profile. Provide either email or userId, but not both.
createdAtinteger
Unix timestamp of when the click occurred. If not provided, defaults to when Iterable receives the event.
messageIdstringObligatorio
The unique identifier of the message on which the click occurred.
targetUrlstring
The URL associated with the click target.
deviceInfoobject
Device information for embedded message events.
buttonIdentifierstring
The identifier of the button that was clicked. Button IDs are defined in Iterable as part of the template or campaign.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Track Embedded ReceivedITERABLE_TRACK_EMBEDDED_RECEIVEDAcción

Track that an embedded message was received on a device. Use this action when you need to record that a device has retrieved an embedded message from Iterable's API. Call this endpoint once per embedded message retrieved. Note that this only indicates the message was retrieved—it does not mean the message has been displayed to the user. Iterable's SDKs automatically call this endpoint, but if you're not using an SDK, call this manually. Provide either email or userId (but not both) to identify the user profile.

Parámetros de entrada

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.
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.
createdAtinteger
The time of the event's occurrence (Unix timestamp). If unspecified, gets set to the time Iterable received the event.
messageIdstringObligatorio
ID of the message that was retrieved by a device.
deviceInfoobject
Device information for embedded message tracking.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Track Embedded SessionITERABLE_TRACK_EMBEDDED_SESSIONAcción

Tracks an embedded message session and related impressions in Iterable. Use this action when you need to report user engagement with embedded messages, including tracking when sessions start and end, and recording impressions for each message that was displayed during the session. This helps Iterable understand user behavior and optimize embedded message campaigns. An embeddedSession event represents a period of time when a user is viewing a page or screen where embedded messages can be displayed. An embeddedImpression event represents how many times a message was visible and for how long.

Parámetros de entrada

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.
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.
sessionobjectObligatorio
Session information including unique ID, start time, and end time.
createdAtinteger
The time of the event's occurrence (Unix timestamp). If unspecified, gets set to the time Iterable received the event.
deviceInfoobjectObligatorio
Device information including app package name, device ID, and platform.
impressionsobject[]
Impressions associated with the session, tracking when messages were displayed and for how long.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Track EventITERABLE_TRACK_EVENTAcción

Track an event in Iterable. Use when you need to record a user action, system event, or custom analytics event. This action sends event data to Iterable for processing. Events are created asynchronously and processed separately from bulk endpoint. To ensure events are tracked in order, send them all to the same endpoint (bulk or non-bulk). There is a soft limit (default 8,000) on unique fields a custom event can have. Provide either email or userId (but not both) depending on how your project identifies users. For events of the same name, identically named data fields must be of the same type. Rate limit: 100 requests/second per project.

Parámetros de entrada

idstring
Optional event ID. If an event exists with that ID, the event will be updated. If not specified, a new ID is automatically generated. Cannot be longer than 512 bytes.
emailstring
An email address that identifies a user profile. Provide email or userId (but not both).
userIdstring
A user ID that identifies a user profile. Provide email or userId (but not both).
createdAtinteger
Unix timestamp when the event occurred. If unspecified, defaults to when the event was received.
eventNamestringObligatorio
The name of the event to track. Must be a non-empty string.
campaignIdinteger
Campaign tied to conversion. Use this to associate the event with a specific campaign.
dataFieldsobject
Additional data associated with the event (e.g., item amount, quantity). For events of the same name, identically named data fields must be of the same type.
templateIdinteger
Template ID associated with the event.
createNewFieldsboolean
Whether new fields should be ingested and added to the schema. Defaults to the project's setting to allow or drop unrecognized fields.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Track Events in BulkITERABLE_TRACK_EVENTS_BULKAcción

Track multiple events in bulk in Iterable. Use this action when you need to track multiple events at once for better performance and to ensure events are processed in the correct order (since bulk events are processed asynchronously together). Each event requires an eventName and should include either an email or userId to identify the user. Note: There is a soft limit of 8,000 unique fields a custom event can have. For events with the same name, identically named data fields must be of the same type.

Parámetros de entrada

eventsobject[]Obligatorio
List of events to track. Each event requires an eventName. Provide either email or userId for each event to identify the user.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Track PurchaseITERABLE_TRACK_PURCHASEAcción

Track a purchase event in Iterable. Use when you need to record a purchase transaction. This action tracks purchase events, clearing the shoppingCartItems field on the user profile. The user profile is updated if it already exists, or created otherwise. Note that there is a soft limit of 1,000 unique fields per user, and field types must remain consistent across all requests in the project. The total amount must match the sum of items (price × quantity), though this is not enforced by the API. If an optional purchase ID is provided and a purchase with that ID already exists, the purchase will be updated instead of creating a new one.

Parámetros de entrada

idstring
Optional purchase ID. If a purchase exists with that ID, it will be updated. If not specified, a new ID will be auto-generated. Maximum 512 bytes.
userobjectObligatorio
The user making the purchase. The user profile is updated if it exists or created otherwise.
itemsobject[]Obligatorio
List of items purchased. shoppingCartItems on the user profile is cleared after tracking.
totalnumberObligatorio
Total order dollar amount.
createdAtinteger
Time the event happened as a Unix timestamp. If not specified, defaults to the time the event was received.
campaignIdinteger
Campaign ID for attribution purposes.
dataFieldsobject
Additional fields to be tracked with this purchase event.
templateIdinteger
Template ID used in A/B testing attribution.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Trigger CampaignITERABLE_TRIGGER_CAMPAIGNAcción

Trigger a campaign to send to one or more lists of recipients. Use when you need to initiate a marketing campaign immediately, sending to all users in the specified lists. The campaign must be in a ready state before triggering. This action is useful for time-sensitive announcements or promotional campaigns that need to go out immediately. Note: This action cannot be undone once the campaign begins sending. If you need to stop a campaign after triggering, use the 'Cancel campaign' action.

Parámetros de entrada

listIdsinteger[]Obligatorio
A non-empty array of list IDs to send the campaign to. All lists must exist in your Iterable project.
campaignIdintegerObligatorio
The unique identifier of the campaign to trigger. Use the campaign ID returned from the 'List campaigns' or 'Get campaign' endpoint.
dataFieldsobject
A JSON object containing fields to merge into the handlebars context for template personalization. These fields override campaign-level data fields for each recipient.
suppressionListIdsinteger[]
An array of list IDs to suppress from receiving this campaign. Users in these lists will not be sent the campaign even if they are in the target lists.
allowRepeatMarketingSendsboolean
Whether to allow repeat marketing sends to users who have already received this campaign. Defaults to true.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Trigger JourneyITERABLE_TRIGGER_JOURNEYAcción

Trigger a journey (workflow) in Iterable for a specific user or list. Use this action when you need to start a journey for an individual user (by email or userId) or for all users in a list. Triggering with a list is asynchronous - if a list trigger is already in progress, it must complete before the same list can be triggered again for the same journey. Journey statistics may take several minutes to update if other journeys are running in parallel. If the journey's start tile has a suppression list configured, users on that list will be excluded from the journey. Provide either email or userId (but not both) when triggering for individual users. Note: This action is idempotent for individual user triggers - triggering the same user for the same journey multiple times will not cause duplicate entries if the journey's entry settings prevent re-entry.

Parámetros de entrada

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.
listIdinteger
The unique identifier of a list (standard or dynamic) to trigger the journey for all users in that list. When using listId, email and userId should not be provided.
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.
dataFieldsobject
A JSON object containing additional data fields to associate with the triggering event. These will be available in the journey's message personalization.
workflowIdintegerObligatorio
The unique identifier of the journey (workflow) to trigger. Use the journey ID returned from the 'List journeys' endpoint.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unforget UserITERABLE_UNFORGET_USERAcción

Unforgets a previously forgotten user in Iterable, resuming data collection. This action allows you to resume collecting data about a user who was previously forgotten (deleted) from your Iterable project. The previously deleted data cannot be recovered, but new data will be collected going forward. Use this action when you need to re-enable tracking for a user after they have requested to be re-included in data collection (e.g., after a GDPR revocation request). In email-based projects, you must unforget users by email. In userID-based projects, you must unforget users by userId. In hybrid projects and projects migrated from email-based to userID-based, you can unforget users by either email or userId. Important: Deleted/forgotten data cannot be recovered, only new data collection resumes.

Parámetros de entrada

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.
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.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unsubscribe from listITERABLE_UNSUBSCRIBE_FROM_LISTAcción

Remove users from a list. Use this action when you need to unsubscribe one or more users from a specific email list in Iterable. This action permanently removes subscribers from the specified list and cannot be easily reversed. Users will need to be manually re-subscribed if they need access to the list again. Note: Users can be identified by email, userId, or both. At least one identifier must be provided for each subscriber.

Parámetros de entrada

listIdintegerObligatorio
The unique identifier of the list to unsubscribe users from.
campaignIdinteger
Associate this unsubscribe action with a specific campaign ID for attribution purposes.
subscribersobject[]Obligatorio
A list of subscribers to unsubscribe. Each subscriber must have at least an email or userId specified.
channelUnsubscribeboolean
If true, unsubscribe the email from the list's associated channel - essentially a global unsubscribe. Defaults to false.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unsubscribe User By IDITERABLE_UNSUBSCRIBE_USER_BY_IDAcción

Unsubscribes a user from the specified subscription group by their userId. Use when you need to remove a user from a specific email list, message type, or message channel subscription. Contact your customer success manager to enable this API before using this action. Note: This action is irreversible — once a user is unsubscribed, they will not receive messages from that subscription group unless they re-subscribe.

Parámetros de entrada

userIdstringObligatorio
The unique userId of the user to unsubscribe.
subscriptionGroupstringObligatorio
The subscription group type. Valid values: 'emailList', 'messageType', 'messageChannel'. Alphanumeric, case insensitive.
subscriptionGroupIdintegerObligatorio
The numeric ID of the subscription group. For email lists, this is the list ID.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Shopping CartITERABLE_UPDATE_CARTAcción

Update a user's shopping cart items in Iterable. Use when you need to update the shoppingCartItems field on a user profile with items from the user's shopping cart. The user profile is updated if it already exists or created otherwise via the user field. Types of data fields must match the types sent in previous requests, across all data fields in the project. Learn about identifying users by userId and email. This action is idempotent - calling it multiple times with the same items will simply update the shoppingCartItems field on the user profile.

Parámetros de entrada

userobjectObligatorio
User identifier for the cart update. Provide either email or userId (but not both).
itemsobject[]Obligatorio
List of cart items to update. Each item must have id, name, price, and quantity.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Catalog Field MappingsITERABLE_UPDATE_CATALOG_FIELD_MAPPINGSAcción

Set a catalog's field mappings (data types) in Iterable. Use this action when you need to define the data type for fields in a catalog. After being set, a given field's data type may not be changed. Valid types: boolean, date, geo_location, long, double, object, and string. Note: This action is idempotent - applying the same field mappings multiple times will have the same effect. Field types cannot be changed once set.

Parámetros de entrada

catalogNamestringObligatorio
Name of the catalog to update field mappings for. Must be alphanumeric with dashes, case insensitive, maximum 255 characters.
mappingsUpdatesobject[]Obligatorio
List of field mapping updates to apply. Each mapping defines a field name and its target data type.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Catalog ItemITERABLE_UPDATE_CATALOG_ITEMAcción

Asynchronously creates or updates the specified catalog item in the given catalog. Use when you need to create a new catalog item or update an existing one. If the item already exists, its fields will be updated with the values provided. Previously existing fields not included in the request body will remain unchanged. The operation is asynchronous — use GET /api/catalogs/{catalogName}/items/{itemId} to verify completion. Note: A catalog item's ID must be unique, contain only alphanumeric characters and dashes, and have a maximum length of 255 characters. Do not use periods in field names.

Parámetros de entrada

itemIdstringObligatorio
The unique identifier of the catalog item. Must be alphanumeric with dashes, case-sensitive, maximum 255 characters.
updateobjectObligatorio
JSON representation of the catalog item fields to update or create. Max size is 30KB. Do not use periods in field names.
catalogNamestringObligatorio
The name of the catalog containing the item. Alphanumeric with dashes, case-insensitive, maximum 255 characters.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update email templateITERABLE_UPDATE_EMAIL_TEMPLATEAcción

Update an existing email template in Iterable. Use this action when you need to modify an existing email template's content, settings, sender information, or metadata. Only the fields included in the request will be updated; previously existing fields not included will retain their current values. The templateId is required to identify which template to update. This is an idempotent operation - calling it multiple times with the same parameters will result in the same state.

Parámetros de entrada

htmlstring
HTML contents of the email template.
namestring
Name of the template.
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.
subjectstring
Email subject line.
ccEmailsstring[]
CC email addresses for carbon copy.
fromNamestring
From name for the email.
metadataobject
Metadata associated with the email template.
bccEmailsstring[]
BCC email addresses for blind carbon copy.
fromEmailstring
From email (must be an authorized sender).
plainTextstring
Plain text contents of the email template.
dataFeedIdinteger
[Deprecated - use dataFeedIds instead] Id for data feed used in template rendering.
linkParamsobject[]
Parameters to append to each URL in HTML contents.
templateIdintegerObligatorio
The unique identifier of the email template to update.
dataFeedIdsinteger[]
Ids for data feeds used in template rendering.
replyToEmailstring
Reply-to email address.
cacheDataFeedobject
Cache data feed lookups for 1 hour.
creatorUserIdstring
User ID of the template creator.
messageTypeIdinteger
Message type ID for the template.
preheaderTextstring
Preheader text displayed after the subject line in email clients.
isDefaultLocaleboolean
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.
clientTemplateIdstring
Client template ID. Used as a secondary key to reference the template.
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.
mergeDataFeedContextobject
Merge data feed contents into user context, so fields can be referenced by {{field}} instead of [[field]].
googleAnalyticsCampaignNamestring
Google Analytics utm_campaign value.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Embedded TemplateITERABLE_UPDATE_EMBEDDED_TEMPLATEAcción

Updates an embedded message template with the specified fields. Use this action when you need to modify an existing embedded message template in Iterable. Only the fields included in the request body will be updated; previously existing fields not specified will remain unchanged. This is an idempotent operation — calling it multiple times with the same parameters will produce the same result.

Parámetros de entrada

bodystring
Body text of the embedded message.
namestring
Name of the template.
titlestring
Title of the embedded message.
localestring
The locale for the content in this request. Leave empty for default locale. Iterable automatically sends the content with a locale that matches a user profile's locale field.
payloadobject
Additional payload data for the template.
elementsobject
Represents the visual elements of an embedded message template.
campaignIdinteger
Campaign ID associated with this template.
templateIdintegerObligatorio
Embedded message template ID. Required to identify the template to update.
placementIdobject
Placement ID that this template is associated with.
messageTypeIdinteger
Message type ID.
isDefaultLocaleboolean
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.
clientTemplateIdstring
Client template ID. Used as a secondary key to reference the template.
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.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update in-app templateITERABLE_UPDATE_IN_APP_TEMPLATEAcción

Update an existing in-app template in Iterable. Use this action when you need to modify an existing in-app template. Only the fields specified in the request will be updated; fields not included will retain their existing values. The templateId is required to identify the template to update. This action performs a partial update. Note: This action is idempotent and will only update the fields provided. Fields not included in the request will retain their existing values.

Parámetros de entrada

htmlstring
HTML content of the in-app notification.
namestring
Name of the template.
localestring
The locale for the content in this request. Leave empty for default locale. Iterable automatically sends the content with a locale that matches a user profile's locale field.
payloadobject
Payload data for the template.
campaignIdinteger
Campaign ID.
templateIdintegerObligatorio
In-app template ID. Required to identify the template to update.
inboxMetadataobject
Metadata for the mobile inbox feature.
messageTypeIdinteger
Message Type ID associated with this template.
isDefaultLocaleboolean
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.
clientTemplateIdstring
Client template ID. Used as a secondary key to reference the template.
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.
expirationDateTimestring
The in-app message's absolute expiration time. If set to a time before the campaign sends, contacts will never see the message. Format is YYYY-MM-DD HH:MM:SS (UTC timestamp).
expirationDurationstring
The in-app message's expiration time relative to its send time. Should be an expression such as now+90d. Default expiration is 90 days after send time.
inAppDisplaySettingsobject
Display settings for in-app messages.
webInAppDisplaySettingsobject
Display settings for web in-app messages.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update push templateITERABLE_UPDATE_PUSH_TEMPLATEAcción

Updates an existing push template in Iterable. Use this action when you need to modify an existing push template's content, settings, or configuration. Only the fields specified in the request body will be updated; previously existing fields not included in the request will remain unchanged. Note: This action is idempotent — calling it multiple times with the same request will have the same effect as calling it once.

Parámetros de entrada

namestring
Name of the template.
wakeboolean
Set the content-available flag on iOS notifications, which will wake the app in the background.
badgestring
Badge to set for push notification.
soundstring
Sound to play for the push notification.
titlestring
Push message title.
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.
buttonsobject[]
Array of buttons that appear to respond to the push. Max of 3.
messagestring
Push message content.
payloadobject
Payload to send with push notification.
deeplinkobject
Model representing deeplink URLs for different platforms.
richMediaobject
Model representing rich media URLs for different platforms.
campaignIdinteger
Campaign ID.
templateIdintegerObligatorio
The unique identifier of the push template to update.
dataFeedIdsinteger[]
Ids for data feeds used in template rendering.
isSilentPushboolean
Whether or not this is a silent push notification template.
cacheDataFeedboolean
Cache data feed lookups for 1 hour.
messageTypeIdinteger
Message Type ID.
relevanceScorenumber
Relevance score for iOS notifications on iOS 15+. Number is clamped between 0 and 1.0.
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.
clientTemplateIdstring
Client template ID. Used as a secondary key to reference the template.
interruptionLevelstringenum
Interruption level for push notifications on iOS.
passiveactivetime-sensitivecritical
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.
mergeDataFeedContextboolean
Merge data feed contents into user context, so fields can be referenced by {{field}} instead of [[field]].

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update SMS templateITERABLE_UPDATE_SMS_TEMPLATEAcción

Update an existing SMS template in Iterable. Use this action when you need to modify the content or settings of an existing SMS template. Only the fields specified in the request will be updated; fields not included will retain their existing values. You must provide the templateId to identify which template to update. Note: This action modifies an existing template. The changes are irreversible and will affect all campaigns using this template.

Parámetros de entrada

namestring
Name of the template.
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.
messagestring
SMS message content.
imageUrlstring
Image URL.
campaignIdobject
Campaign ID.
linkParamsobject[]
Parameters to append to each URL in contents.
templateIdintegerObligatorio
SMS template ID. Required to identify the template to update.
messageTypeIdinteger
Message Type ID associated with this template.
trackingDomainstring
Tracking Domain.
isDefaultLocaleboolean
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.
clientTemplateIdstring
Client template ID. Used as a secondary key to reference the template.
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.
googleAnalyticsCampaignNamestring
Google analytics utm_campaign value.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update snippet by ID or nameITERABLE_UPDATE_SNIPPETAcción

Updates an existing snippet by ID (numeric) or creates/updates a snippet by name (string). For numeric identifiers: only existing snippets can be updated (returns 404 if not found). For string identifiers (snippet names): creates the snippet if it doesn't exist, or updates it if it already exists. Use this action when you need to modify snippet content, description, or variables for an existing snippet, or create a new snippet by name.

Parámetros de entrada

contentstringObligatorio
Content of the snippet. Handlebars must be valid. Disallowed content: script tags with JS sources or non-JSON content, inline JS event handlers (e.g., onload="..."), and javascript: in href or src attributes (anchors and iframes).
variablesstring[]
A list of variable names used in the content with a Handlebars expression such as {{myField}}. Variable names are case-sensitive and should be simple identifiers (letters, numbers, underscores).
identifierstringObligatorio
Snippet identifier. Numeric identifiers are treated as snippet IDs, string identifiers are treated as snippet names. For numeric IDs, only existing snippets can be updated. For names, creates a new snippet if one doesn't exist.
descriptionstring
Description of the snippet.
createdByUserIdstring
User ID (email) of the updater. If not provided, defaults to the project creator.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update UserITERABLE_UPDATE_USERAcción

Update user data or add a user if none exists in Iterable. Use when you need to create or update user profile information. This action merges data — missing fields are not deleted. Provide either email or userId (but not both) depending on how your project identifies users. There is a soft limit (default: 1,000) on the number of unique fields users can have. Types of data fields must match the types sent in previous requests, across all data fields in the project. Processing time varies based on the current load for Iterable's back-end services. To avoid race conditions, provide a buffer of at least 60 seconds between this request and subsequent dependent requests. Rate limit: 100 requests/second per project.

Parámetros de entrada

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.
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.
dataFieldsobject
Data to store on the user profile identified by userId or email.
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.
createNewFieldsboolean
Whether new fields should be ingested and added to the schema. Defaults to project's setting to allow or drop unrecognized fields.
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}}.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update User EmailITERABLE_UPDATE_USER_EMAILAcción

Updates a user's email address in Iterable. Use when you need to change a user's email in email-based projects. Use this action when you need to update a user's email address and migrate all profile data and events to the new email. To update an email in a userID-based or hybrid project, use POST /api/users/update instead. Specify either currentEmail or currentUserId in the request body, but not both — if both are provided, currentEmail takes precedence. This action is irreversible and will migrate all historical data to the new email address.

Parámetros de entrada

newEmailstringObligatorio
The new email address to assign to the specified user. This field is required.
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. If both are included, currentEmail takes precedence.
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. If both are included, currentEmail takes precedence.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update User SubscriptionsITERABLE_UPDATE_USER_SUBSCRIPTIONSAcción

Updates user subscription preferences in Iterable. Use when you need to modify a user's subscription status for email lists, message types, and channels. IMPORTANT: This endpoint overwrites (does not merge) existing data for any non-null fields specified in the request. For example, if unsubscribedChannelIds is included in the request, it will replace the user's existing channel subscriptions entirely. Provide either email or userId (but not both), depending on how your project identifies users. Learn about identifying users by userId and email. This action is idempotent - calling it multiple times with the same parameters will result in the same subscription state.

Parámetros de entrada

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.
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.
campaignIdinteger
Campaign to attribute unsubscribes. Use with templateId to attribute unsubscribes to a specific workflow.
templateIdinteger
Template to attribute unsubscribes. Use with campaignId to attribute unsubscribes to a specific workflow.
emailListIdsinteger[]
Lists that a user is subscribed to. Provide the list IDs.
unsubscribedChannelIdsinteger[]
Email channel IDs to unsubscribe from.
subscribedMessageTypeIdsinteger[]
Individual message type IDs to subscribe to. Does not impact channel subscriptions. To set this field, first have your CSM enable the opt-in message types feature.
validateChannelAlignmentboolean
Defaults to true (validation enabled). When false, allows subscribing users to message types that belong to unsubscribed channels.
unsubscribedMessageTypeIdsinteger[]
Individual message type IDs to unsubscribe from. Does not impact channel subscriptions.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Bulk Update User SubscriptionsITERABLE_UPDATE_USER_SUBSCRIPTIONS_BULKAcción

Bulk update subscription preferences for multiple users in Iterable. Use this action when you need to update email list subscriptions, message type subscriptions, or channel subscriptions for multiple users in a single API call. This is useful for bulk list management, compliance updates, or campaign-related subscription changes. IMPORTANT: This endpoint overwrites (does not merge) existing data for any non-null fields specified in the request. Provide email or userId for each user to identify them. This action modifies user communication preferences immediately. Learn about identifying users by userId and email.

Parámetros de entrada

updateSubscriptionsRequestsobject[]Obligatorio
List of UpdateSubscriptionsRequests to process. Each request must have at least an email or userId.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update WebhookITERABLE_UPDATE_WEBHOOKAcción

Update an existing webhook configuration in Iterable. Use this action when you need to modify webhook settings such as endpoint URL, authentication type, enabled status, or campaign type subscriptions. Only the fields included in the request body will be updated; other fields remain unchanged. The webhook ID (id) is required to identify which webhook to update.

Parámetros de entrada

idintegerObligatorio
The ID of the webhook in Iterable. This field is required to identify the webhook to update.
enabledboolean
Whether or not Iterable will call the webhook when sending campaigns.
headersobject[]
Custom headers to include in webhook requests.
authTypestringenum
Authentication type for webhook.
NoAuthBasicOAuth2
endpointstring
The URL associated with the webhook.
authTokenstring
Auth token to use for webhook authentication.
blastSendEnabledboolean
Whether or not Iterable calls this webhook for blast campaigns.
triggeredSendEnabledboolean
Whether or not Iterable calls this webhook for triggered campaigns.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Upsert email templateITERABLE_UPSERT_EMAIL_TEMPLATEAcción

Create or update an email template in Iterable. Use this action when you need to create a new email template or update an existing one that matches the provided clientTemplateId. This endpoint performs an upsert operation: if no template exists with the given clientTemplateId, a new template is created; if one or more templates exist with the same clientTemplateId, all matching templates are updated with the provided fields. Note that only the fields specified in the request will be updated. Fields not included in the request will retain their existing values (for updates) or use default values (for new templates).

Parámetros de entrada

htmlstring
HTML contents of the email template.
namestring
Name of the template.
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.
subjectstring
Email subject line.
ccEmailsstring[]
CC email addresses for carbon copy.
fromNamestring
From name displayed in email clients.
bccEmailsstring[]
BCC email addresses for blind carbon copy.
fromEmailstring
From email address (must be an authorized sender).
plainTextstring
Plain text contents of the email template.
dataFeedIdinteger
[Deprecated - use dataFeedIds instead] ID for data feed used in template rendering.
linkParamsobject[]
Parameters to append to each URL in HTML contents.
dataFeedIdsinteger[]
IDs for data feeds used in template rendering.
replyToEmailstring
Reply-to email address.
cacheDataFeedobject
Cache data feed lookups for 1 hour.
creatorUserIdstring
Specify a specific creator user ID (email). The email must be an existing member of the project. Defaults to the organization creator.
messageTypeIdinteger
Message Type ID associated with this template.
preheaderTextstring
Preheader text displayed after the subject line in email clients.
isDefaultLocaleboolean
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.
clientTemplateIdstringObligatorio
ID used by the client to identify a template. If multiple templates exist with this ID, all will be updated.
mergeDataFeedContextboolean
Merge data feed contents into user context, so fields can be referenced by {{field}} instead of [[field]].
googleAnalyticsCampaignNamestring
Google Analytics utm_campaign value.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Upsert Embedded TemplateITERABLE_UPSERT_EMBEDDED_TEMPLATEAcción

Creates an embedded message template if it doesn't exist, or updates all embedded message templates that match the provided clientTemplateId. Use this action when you need to create or update embedded message templates in Iterable. If multiple templates exist with the same clientTemplateId, all will be updated with the provided data. This is useful for managing template versions or ensuring a template exists before sending campaigns.

Parámetros de entrada

bodystring
Body text of the embedded message.
namestring
Name of the template.
titlestring
Title of the embedded message.
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.
payloadobject
Represents the payload associated with the embedded template.
elementsobject
Represents the visual elements of an embedded message template.
placementIdobject
Placement ID that this template is associated with.
creatorUserIdstring
Specify a specific creator user ID (email). The email must be an existing member of the project. Defaults to the organization creator.
messageTypeIdinteger
Message type ID.
isDefaultLocaleboolean
Sets the locale associated with the request content as the template's default. Requires beta enrollment. If empty or flexible default locales are not enabled for the project, the project's default locale is assigned.
clientTemplateIdstringObligatorio
ID used by the client to identify a template. If multiple templates exist with this ID, all will be updated.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Upsert in-app templateITERABLE_UPSERT_IN_APP_TEMPLATEAcción

Create or update an in-app template in Iterable. Use this action when you need to create a new in-app template or update an existing one that matches the provided clientTemplateId. This endpoint performs an upsert operation: if no template exists with the given clientTemplateId, a new template is created; if one or more templates exist with the same clientTemplateId, all matching templates are updated with the provided fields. Note that only the fields specified in the request will be updated. Fields not included in the request will retain their existing values (for updates) or use default values (for new templates).

Parámetros de entrada

htmlstring
HTML of the in-app notification.
namestring
Name of the template.
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.
payloadobject
Payload model for the template data.
creatorUserIdstring
Specify a specific creator user ID (email). The email must be an existing member of the project. Defaults to the organization creator.
inboxMetadataobject
Metadata for the mobile inbox feature.
messageTypeIdinteger
Message Type ID.
isDefaultLocaleboolean
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.
clientTemplateIdstringObligatorio
ID used by the client to identify a template. If multiple templates exist with this ID, all will be updated.
expirationDateTimestring
Absolute expiration of message. Format: YYYY-MM-DD HH:MM:SS (UTC timestamp).
expirationDurationstring
Relative expiration of message. Example: now+90d.
inAppDisplaySettingsobject
Display settings for in-app messages.
webInAppDisplaySettingsobject
Display settings for web in-app messages.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Upsert push templateITERABLE_UPSERT_PUSH_TEMPLATEAcción

Create or update a push template in Iterable. Use this action when you need to create a new push template or update an existing one that matches the provided clientTemplateId. This endpoint performs an upsert operation: if no template exists with the given clientTemplateId, a new template is created; if one or more templates exist with the same clientTemplateId, all matching templates are updated with the provided fields. Note that only the fields specified in the request will be updated. Fields not included in the request will retain their existing values (for updates) or use default values (for new templates). This action is idempotent - calling it multiple times with the same clientTemplateId will always result in the same state.

Parámetros de entrada

namestring
Name of the template.
wakeboolean
Set the content-available flag on iOS notifications, which will wake the app in the background.
badgestring
Badge to set for push notification.
soundstring
Sound to play for the push notification.
titlestring
Push message title.
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.
buttonsobject[]
Array of buttons that appear to respond to the push. Max of 3.
messagestring
Push message body text.
payloadobject
Model representing payload to send with push notification.
deeplinkobject
Model representing deeplink URLs for different platforms.
richMediaobject
Model representing rich media URLs for different platforms.
dataFeedIdsinteger[]
Ids for data feeds used in template rendering.
isSilentPushboolean
Whether or not this is a silent push notification template.
cacheDataFeedboolean
Cache data feed lookups for 1 hour.
creatorUserIdstring
Specify a specific creator user ID (email). The email must be an existing member of the project. Defaults to the organization creator.
messageTypeIdinteger
Message Type ID associated with this template.
relevanceScorenumber
Relevance score for iOS notifications on iOS 15+. Number is clamped between 0 and 1.0.
isDefaultLocaleboolean
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.
clientTemplateIdstringObligatorio
ID used by the client to identify a template. If multiple templates exist with this ID, all will be updated.
interruptionLevelstringenum
Interruption level for push notifications on iOS.
passiveactivetime-sensitivecritical
mergeDataFeedContextboolean
Merge data feed contents into user context, so fields can be referenced by {{field}} instead of [[field]].

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Upsert SMS templateITERABLE_UPSERT_SMS_TEMPLATEAcción

Create or update an SMS template in Iterable. Use this action when you need to create a new SMS template or update an existing one that matches the provided clientTemplateId. This endpoint performs an upsert operation: if no template exists with the given clientTemplateId, a new template is created; if one or more templates exist with the same clientTemplateId, all matching templates are updated with the provided fields. Note that only the fields specified in the request will be updated. Fields not included in the request will retain their existing values (for updates) or use default values (for new templates).

Parámetros de entrada

namestring
Name of the template.
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.
messagestring
SMS message content.
imageUrlstring
Image URL to include in the SMS.
linkParamsobject[]
Parameters to append to each URL in SMS content.
creatorUserIdstring
Specify a specific creator user ID (email). The email must be an existing member of the project. Defaults to the organization creator.
messageTypeIdinteger
Message Type ID associated with this template.
isDefaultLocaleboolean
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.
clientTemplateIdstringObligatorio
ID used by the client to identify a template. If multiple templates exist with this ID, all will be updated.
googleAnalyticsCampaignNamestring
Google Analytics utm_campaign value.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Verify SMS CodeITERABLE_VERIFY_SMS_CODEAcción

Verifies an SMS verification code sent to a phone number in Iterable. Use this action when you need to check whether a user has entered the correct verification code during phone number verification. The code must match the most recent, non-expired, not-yet-verified code sent to the specified phone number. If the code is correct, the verification is successful. If the code is incorrect or expired, the verification fails. This action is idempotent - verifying the same code multiple times returns the same result.

Parámetros de entrada

codestringObligatorio
The SMS verification code to verify. This is the numeric or alphanumeric code that was sent to the phone number.
phoneNumberstringObligatorio
The phone number that the verification code was sent to. Must be in E.164 format (e.g., +1234567890).
verificationProfileIdintegerObligatorio
The unique identifier for the verification profile associated with this SMS verification attempt.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not