- Category: marketing
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 116
- Triggers: 0
- Slug:
ITERABLE - Version: 20261101_00
Tools
Abort Campaign
Abort Campaign
ITERABLE_ABORT_CAMPAIGNAbort 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.Input Parameters
Output
Activate a triggered campaign
Activate a triggered campaign
ITERABLE_ACTIVATE_TRIGGERED_CAMPAIGNActivates 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.Input Parameters
Output
Archive Campaigns
Archive Campaigns
ITERABLE_ARCHIVE_CAMPAIGNSArchives 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.Input Parameters
Output
Bulk Update Users
Bulk Update Users
ITERABLE_BULK_UPDATE_USERSBulk 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.Input Parameters
Output
Cancel Campaign
Cancel Campaign
ITERABLE_CANCEL_CAMPAIGNCancel 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.Input Parameters
Output
Cancel Email
Cancel Email
ITERABLE_CANCEL_EMAILCancel 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.Input Parameters
Output
Cancel Export
Cancel Export
ITERABLE_CANCEL_EXPORTCancel 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.Input Parameters
Output
Cancel In-App Message
Cancel In-App Message
ITERABLE_CANCEL_IN_APPCancel a scheduled in-app message for a specific user in Iterable. Identify it by scheduled message ID, or by campaign ID together with the user’s email or user ID.Input Parameters
Output
Cancel Push
Cancel Push
ITERABLE_CANCEL_PUSHCancel 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.Input Parameters
Output
Cancel Web Push
Cancel Web Push
ITERABLE_CANCEL_WEB_PUSHCancel 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.Input Parameters
Output
Cancel WhatsApp
Cancel WhatsApp
ITERABLE_CANCEL_WHATS_APPCancel 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.Input Parameters
Output
Create a new campaign
Create a new campaign
ITERABLE_CREATE_CAMPAIGNCreates 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.Input Parameters
[[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.Output
Create a catalog
Create a catalog
ITERABLE_CREATE_CATALOGCreate 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.Input Parameters
Output
Create Catalog Items
Create Catalog Items
ITERABLE_CREATE_CATALOG_ITEMSAsynchronously 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.Input Parameters
Output
Create a new list
Create a new list
ITERABLE_CREATE_LISTCreate 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.Input Parameters
Output
Create snippet
Create snippet
ITERABLE_CREATE_SNIPPETCreates 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.Input Parameters
Output
Deactivate Triggered Campaign
Deactivate Triggered Campaign
ITERABLE_DEACTIVATE_TRIGGERED_CAMPAIGNDeactivate 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.Input Parameters
Output
Bulk delete templates
Bulk delete templates
ITERABLE_DELETE_BULK_TEMPLATESBulk 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.Input Parameters
Output
Delete a catalog
Delete a catalog
ITERABLE_DELETE_CATALOGDelete 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.Input Parameters
Output
Delete a Catalog Item
Delete a Catalog Item
ITERABLE_DELETE_CATALOG_ITEMDeletes 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.Input Parameters
Output
Delete Catalog Items
Delete Catalog Items
ITERABLE_DELETE_CATALOG_ITEMSAsynchronously 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.Input Parameters
Output
Delete a list
Delete a list
ITERABLE_DELETE_LISTDelete 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.Input Parameters
Output
Delete Metadata Table
Delete Metadata Table
ITERABLE_DELETE_METADATA_TABLEAsynchronously 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.Input Parameters
Output
Delete snippet
Delete snippet
ITERABLE_DELETE_SNIPPETDeletes 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.Input Parameters
Output
Delete User By ID
Delete User By ID
ITERABLE_DELETE_USER_BY_IDAsynchronously 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.Input Parameters
Output
Export data to CSV
Export data to CSV
ITERABLE_EXPORT_DATA_CSVExport 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.Input Parameters
Output
Export Campaign Data to JSON
Export Campaign Data to JSON
ITERABLE_EXPORT_DATA_JSONExport Iterable event and user data as newline-delimited JSON, optionally filtered by campaign and date. The date range defaults to Today when no range or custom date is supplied; a predefined range cannot be combined with custom dates.Input Parameters
Output
Export User Events
Export User Events
Forget User
Forget User
ITERABLE_FORGET_USERDeletes 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.Input Parameters
Output
Get campaign by ID
Get campaign by ID
Get Campaign Metrics
Get Campaign Metrics
ITERABLE_GET_CAMPAIGN_METRICSRetrieve performance metrics for one or more specified campaigns, optionally filtered by a date range. Returns the report as column headers and rows.Input Parameters
Output
Get Catalog Field Mappings
Get Catalog Field Mappings
ITERABLE_GET_CATALOG_FIELD_MAPPINGSTool 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.Input Parameters
Output
Get catalog item by ID
Get catalog item by ID
ITERABLE_GET_CATALOG_ITEMRetrieves 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.Input Parameters
Output
Get email template by ID
Get email template by ID
ITERABLE_GET_EMAIL_TEMPLATEGet 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.Input Parameters
Output
Get Embedded Messages
Get Embedded Messages
ITERABLE_GET_EMBEDDED_MESSAGESRetrieve a user’s eligible embedded messages grouped by placement, with optional placement and platform parameters. Returned message entries expose only the truncation indicator, not message content or identifiers.Input Parameters
Output
Get Embedded Template
Get Embedded Template
ITERABLE_GET_EMBEDDED_TEMPLATERetrieves 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.Input Parameters
Output
Get Experiment Metrics
Get Experiment Metrics
ITERABLE_GET_EXPERIMENT_METRICSRetrieve 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.Input Parameters
Output
Get In-App Messages
Get In-App Messages
ITERABLE_GET_IN_APP_MESSAGESRetrieve a user’s in-app messages by email or user ID, with optional platform and package filters for app-specific messages. Results can include new messages and mobile inbox messages, with read status when provided.Input Parameters
Output
Get in-app template by ID
Get in-app template by ID
ITERABLE_GET_IN_APP_TEMPLATERetrieves 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.Input Parameters
Output
Get List Size
Get List Size
Get push template by ID
Get push template by ID
ITERABLE_GET_PUSH_TEMPLATERetrieves 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.Input Parameters
Output
Get SMS template
Get SMS template
ITERABLE_GET_SMS_TEMPLATERetrieves 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.Input Parameters
Output
Get snippet by ID or name
Get snippet by ID or name
ITERABLE_GET_SNIPPETRetrieves 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.Input Parameters
Output
Get template by client template ID
Get template by client template ID
Get User By ID
Get User By ID
ITERABLE_GET_USER_BY_IDGet 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.Input Parameters
Output
Get User By ID (Path)
Get User By ID (Path)
ITERABLE_GET_USER_BY_ID_PATHGet 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.Input Parameters
Output
Get User Events
Get User Events
ITERABLE_GET_USER_EVENTSGet 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.Input Parameters
Output
Get User Sent Messages
Get User Sent Messages
ITERABLE_GET_USER_SENT_MESSAGESGet 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.Input Parameters
Output
Get Web In-App Messages
Get Web In-App Messages
ITERABLE_GET_WEB_IN_APP_MESSAGESGet a user’s web in-app messages from Iterable, including non-selective messages and, with a package name, web app-specific messages. Results can include new messages and messages saved to a mobile inbox; a read field may indicate whether a message has been seen.Input Parameters
Output
List all campaigns
List all campaigns
ITERABLE_LIST_CAMPAIGNSRetrieves 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.Input Parameters
Output
List Catalog Items
List Catalog Items
ITERABLE_LIST_CATALOG_ITEMSGet 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.Input Parameters
Output
List Catalogs
List Catalogs
List Channels
List Channels
ITERABLE_LIST_CHANNELSGet 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.Output
List export files
List export files
ITERABLE_LIST_EXPORT_FILESGet 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.Input Parameters
Output
List Export Jobs
List Export Jobs
ITERABLE_LIST_EXPORT_JOBSRetrieve 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.Input Parameters
Output
List Forgotten User IDs
List Forgotten User IDs
ITERABLE_LIST_FORGOTTEN_USER_IDSGet 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.Output
List Journeys
List Journeys
ITERABLE_LIST_JOURNEYSGet 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.).Input Parameters
Output
List Lists
List Lists
List List Users
List List Users
ITERABLE_LIST_LIST_USERSGet 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.Input Parameters
Output
List Message Types
List Message Types
List Metadata Keys
List Metadata Keys
ITERABLE_LIST_METADATA_KEYSList 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.Input Parameters
Output
List Metadata Tables
List Metadata Tables
List recurring campaign child campaigns
List recurring campaign child campaigns
ITERABLE_LIST_RECURRING_CHILD_CAMPAIGNSRetrieve child campaigns generated by a recurring campaign, with pagination, sorting and campaign-state filtering; the rate limit is 100 requests per second per project. If Iterable reports that the specified campaign is not recurring, the tool returns an empty campaign list.Input Parameters
Output
List Snippets
List Snippets
List all templates
List all templates
ITERABLE_LIST_TEMPLATESRetrieves 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.Input Parameters
Output
List User Fields
List User Fields
ITERABLE_LIST_USER_FIELDSGet 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.Output
List Webhooks
List Webhooks
ITERABLE_LIST_WEBHOOKSGet 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.Output
Merge Users
Merge Users
ITERABLE_MERGE_USERSMerge 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.Input Parameters
Output
Preview email template
Preview email template
ITERABLE_PREVIEW_EMAIL_TEMPLATEGenerate 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.Input Parameters
[[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.Output
Preview in-app template
Preview in-app template
ITERABLE_PREVIEW_IN_APP_TEMPLATEGenerate 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.Input Parameters
[[fieldName]] when mergeDataFeedContext=false, or as {{fieldName}} when mergeDataFeedContext=true.Output
Preview List Users
Preview List Users
ITERABLE_PREVIEW_LIST_USERSPreview a random sample of up to 5,000 users in an Iterable list without fetching the entire list. Use it to check list membership or content before a campaign. The rate limit is 5 requests per minute per project.Input Parameters
Output
Replace Catalog Item
Replace Catalog Item
ITERABLE_REPLACE_CATALOG_ITEMAsynchronously 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.Input Parameters
Output
Replace Metadata Item
Replace Metadata Item
ITERABLE_REPLACE_METADATA_ITEMAsynchronously 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.Input Parameters
Output
Schedule Campaign
Schedule Campaign
ITERABLE_SCHEDULE_CAMPAIGNSchedule 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.Input Parameters
Output
Send Campaign
Send Campaign
ITERABLE_SEND_CAMPAIGNSend 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.Input Parameters
Output
Send email template proof
Send email template proof
ITERABLE_SEND_EMAIL_PROOFSend 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.Input Parameters
Output
Send in-app notification to target
Send in-app notification to target
ITERABLE_SEND_IN_APPSend 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.Input Parameters
Output
Send in-app template proof
Send in-app template proof
ITERABLE_SEND_IN_APP_PROOFSend 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.Input Parameters
Output
Send push to target
Send push to target
ITERABLE_SEND_PUSHSend 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.Input Parameters
Output
Send push template proof
Send push template proof
ITERABLE_SEND_PUSH_PROOFSend 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.Input Parameters
Output
Send SMS template proof
Send SMS template proof
ITERABLE_SEND_SMS_PROOFSend 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.Input Parameters
Output
Send WhatsApp to target
Send WhatsApp to target
ITERABLE_SEND_WHATS_APPSend 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.Input Parameters
Output
Start Export
Start Export
ITERABLE_START_EXPORTStart 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.Input Parameters
Output
Subscribe to List
Subscribe to List
ITERABLE_SUBSCRIBE_TO_LISTSubscribe one or more users to an Iterable list by email, userId, or both. The action can create new user profiles and can also update profile data supplied with subscribers; updateExistingUsersOnly can limit creation.Input Parameters
Output
Subscribe User By ID
Subscribe User By ID
ITERABLE_SUBSCRIBE_USER_BY_IDSubscribe an Iterable user identified by userId to a specified email list, message type, or message channel subscription group. Contact your customer success manager to enable this API before using the action.Input Parameters
Output
Track Embedded Click
Track Embedded Click
ITERABLE_TRACK_EMBEDDED_CLICKTracks 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.Input Parameters
Output
Track Embedded Received
Track Embedded Received
ITERABLE_TRACK_EMBEDDED_RECEIVEDTrack 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.Input Parameters
Output
Track Embedded Session
Track Embedded Session
ITERABLE_TRACK_EMBEDDED_SESSIONTracks 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.Input Parameters
Output
Track Event
Track Event
ITERABLE_TRACK_EVENTTrack 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.Input Parameters
Output
Track Events in Bulk
Track Events in Bulk
ITERABLE_TRACK_EVENTS_BULKTrack multiple events in bulk in Iterable, identifying each user by email or userId. The response includes success and failure counts and may include failure details; events are processed asynchronously.Input Parameters
Output
Track Purchase
Track Purchase
ITERABLE_TRACK_PURCHASETrack 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.Input Parameters
Output
Trigger Campaign
Trigger Campaign
ITERABLE_TRIGGER_CAMPAIGNTrigger a ready marketing campaign to send to one or more recipient lists, with optional suppression lists and personalization data. Once sending begins, the action cannot be undone.Input Parameters
Output
Trigger Journey
Trigger Journey
ITERABLE_TRIGGER_JOURNEYTrigger 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.Input Parameters
Output
Unforget User
Unforget User
ITERABLE_UNFORGET_USERUnforgets 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.Input Parameters
Output
Unsubscribe from list
Unsubscribe from list
ITERABLE_UNSUBSCRIBE_FROM_LISTUnsubscribe users from an Iterable list, identifying each subscriber by either email or userId. Optionally unsubscribe them from the list’s associated channel and attribute the action to a campaign; the response includes success and failure counts.Input Parameters
Output
Unsubscribe User By ID
Unsubscribe User By ID
ITERABLE_UNSUBSCRIBE_USER_BY_IDUnsubscribe an Iterable user identified by userId from a specified email list, message type, or message channel subscription group. Contact your customer success manager to enable this API before using the action.Input Parameters
Output
Update Shopping Cart
Update Shopping Cart
ITERABLE_UPDATE_CARTUpdate 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.Input Parameters
Output
Update Catalog Field Mappings
Update Catalog Field Mappings
ITERABLE_UPDATE_CATALOG_FIELD_MAPPINGSSet 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.Input Parameters
Output
Update Catalog Item
Update Catalog Item
ITERABLE_UPDATE_CATALOG_ITEMAsynchronously 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.Input Parameters
Output
Update email template
Update email template
ITERABLE_UPDATE_EMAIL_TEMPLATEUpdate 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.Input Parameters
[[field]].Output
Update Embedded Template
Update Embedded Template
ITERABLE_UPDATE_EMBEDDED_TEMPLATEUpdates 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.Input Parameters
Output
Update in-app template
Update in-app template
ITERABLE_UPDATE_IN_APP_TEMPLATEUpdate 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.Input Parameters
Output
Update push template
Update push template
ITERABLE_UPDATE_PUSH_TEMPLATEUpdates 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.Input Parameters
[[field]].Output
Update SMS template
Update SMS template
ITERABLE_UPDATE_SMS_TEMPLATEUpdate 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.Input Parameters
Output
Update snippet by ID or name
Update snippet by ID or name
ITERABLE_UPDATE_SNIPPETUpdates 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.Input Parameters
Output
Update User
Update User
ITERABLE_UPDATE_USERUpdate 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.Input Parameters
Output
Update User Email
Update User Email
ITERABLE_UPDATE_USER_EMAILUpdates 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.Input Parameters
Output
Update User Subscriptions
Update User Subscriptions
ITERABLE_UPDATE_USER_SUBSCRIPTIONSUpdates 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.Input Parameters
Output
Bulk Update User Subscriptions
Bulk Update User Subscriptions
ITERABLE_UPDATE_USER_SUBSCRIPTIONS_BULKBulk 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.Input Parameters
Output
Update Webhook
Update Webhook
ITERABLE_UPDATE_WEBHOOKUpdate 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.Input Parameters
Output
Upsert email template
Upsert email template
ITERABLE_UPSERT_EMAIL_TEMPLATECreate 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).Input Parameters
[[field]].Output
Upsert Embedded Template
Upsert Embedded Template
ITERABLE_UPSERT_EMBEDDED_TEMPLATECreates 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.Input Parameters
Output
Upsert in-app template
Upsert in-app template
ITERABLE_UPSERT_IN_APP_TEMPLATECreate 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).Input Parameters
Output
Upsert push template
Upsert push template
ITERABLE_UPSERT_PUSH_TEMPLATECreate or update a push template in Iterable by clientTemplateId. If multiple templates share the ID, all matching templates are updated with the provided fields; omitted fields retain their existing values on updates.Input Parameters
[[field]].Output
Upsert SMS template
Upsert SMS template
ITERABLE_UPSERT_SMS_TEMPLATECreate 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).Input Parameters
Output
Verify SMS Code
Verify SMS Code
ITERABLE_VERIFY_SMS_CODEVerifies an SMS code for a phone number and verification profile in Iterable. Check the returned code and message for the outcome; API errors with a response code may be returned as results.