Iterable
Cross-channel marketing platform for creating, executing, and optimizing campaigns
This is a first-class FlyMyAI MCP. Agents discover it automatically via tool search and call the actions below on demand - you never wire it up by hand. See the Composio catalog for how discovery works.
Connect
Iterable authenticates with an API key. Generate the credential in your Iterable account, then paste it into FlyMyAI the first time an agent uses an Iterable action.
Get your Iterable credential →
Fields to fill in FlyMyAI
| Field | Details |
|---|---|
API Key | Your Iterable API key. Get it from Settings > API Keys in your Iterable dashboard. (required) |
Region | Data center region for your Iterable project. Use "us" (default) or "eu". |
Actions
Every action this integration exposes. Agents pick the right one from the task; you do not call them by name.
| Action | What it does | Required inputs |
|---|---|---|
ITERABLE_ABORT_CAMPAIGN | 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 dis… | campaignId |
ITERABLE_ACTIVATE_TRIGGERED_CAMPAIGN | 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).… | campaignId |
ITERABLE_ARCHIVE_CAMPAIGNS | 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 stil… | campaignIds |
ITERABLE_BULK_UPDATE_USERS | 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 mer… | users |
ITERABLE_CANCEL_CAMPAIGN | 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 irre… | campaignId |
ITERABLE_CANCEL_EMAIL | 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 t… | - |
ITERABLE_CANCEL_EXPORT | 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. | jobId |
ITERABLE_CANCEL_IN_APP | 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… | - |
ITERABLE_CANCEL_PUSH | 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… | - |
ITERABLE_CANCEL_WEB_PUSH | 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 prov… | - |
ITERABLE_CANCEL_WHATS_APP | 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 ca… | - |
ITERABLE_CREATE_CAMPAIGN | 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 suppr… | name, templateId |
ITERABLE_CREATE_CATALOG | 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 longe… | catalogName |
ITERABLE_CREATE_CATALOG_ITEMS | 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 replaceUp… | catalogName, documents |
ITERABLE_CREATE_LIST | 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 em… | name |
ITERABLE_CREATE_SNIPPET | 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… | name, content |
ITERABLE_DEACTIVATE_TRIGGERED_CAMPAIGN | 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 d… | campaignId |
ITERABLE_DELETE_BULK_TEMPLATES | 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… | ids |
ITERABLE_DELETE_CATALOG | 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 cata… | catalogName |
ITERABLE_DELETE_CATALOG_ITEM | 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 d… | catalogName, itemId |
ITERABLE_DELETE_CATALOG_ITEMS | 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 requ… | catalogName, itemIds |
ITERABLE_DELETE_LIST | 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 act… | listId |
ITERABLE_DELETE_METADATA_TABLE | 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… | table |
ITERABLE_DELETE_SNIPPET | 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… | identifier |
ITERABLE_DELETE_USER_BY_ID | 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 delet… | userId |
ITERABLE_EXPORT_DATA_CSV | 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 sim… | dataTypeName |
ITERABLE_EXPORT_DATA_JSON | 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 'startDateT… | dataTypeName |
ITERABLE_EXPORT_USER_EVENTS | 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… | - |
ITERABLE_FORGET_USER | 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 c… | - |
ITERABLE_GET_CAMPAIGN | 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. | id |
ITERABLE_GET_CAMPAIGN_METRICS | 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 limi… | campaignId |
ITERABLE_GET_CATALOG_FIELD_MAPPINGS | 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. | catalogName |
ITERABLE_GET_CATALOG_ITEM | 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. | catalogName, itemId |
ITERABLE_GET_EMAIL_TEMPLATE | 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 i… | templateId |
ITERABLE_GET_EMBEDDED_MESSAGES | 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 m… | - |
ITERABLE_GET_EMBEDDED_TEMPLATE | 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… | templateId |
ITERABLE_GET_EXPERIMENT_METRICS | 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 s… | - |
ITERABLE_GET_IN_APP_MESSAGES | 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… | count |
ITERABLE_GET_IN_APP_TEMPLATE | 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… | templateId |
ITERABLE_GET_LIST_SIZE | 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. | listId |
ITERABLE_GET_PUSH_TEMPLATE | 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, deepli… | templateId |
ITERABLE_GET_SMS_TEMPLATE | 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 oth… | templateId |
ITERABLE_GET_SNIPPET | 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 ass… | identifier |
ITERABLE_GET_TEMPLATE_BY_CLIENT_ID | 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 |
ITERABLE_GET_USER_BY_ID | 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-pa… | userId |
ITERABLE_GET_USER_BY_ID_PATH | 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: Thi… | userId |
ITERABLE_GET_USER_EVENTS | 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… | userId |
ITERABLE_GET_USER_SENT_MESSAGES | 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… | - |
ITERABLE_GET_WEB_IN_APP_MESSAGES | 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 messa… | count |
ITERABLE_LIST_CAMPAIGNS | 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… | - |
ITERABLE_LIST_CATALOGS | 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. | - |
ITERABLE_LIST_CATALOG_ITEMS | 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/secon… | catalogName |
ITERABLE_LIST_CHANNELS | 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 wh… | - |
ITERABLE_LIST_EXPORT_FILES | 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… | jobId |
ITERABLE_LIST_EXPORT_JOBS | 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. | - |
ITERABLE_LIST_FORGOTTEN_USER_IDS | 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 da… | - |
ITERABLE_LIST_JOURNEYS | 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 jo… | - |
ITERABLE_LIST_LISTS | 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. | - |
ITERABLE_LIST_LIST_USERS | 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 req… | listId |
ITERABLE_LIST_MESSAGE_TYPES | 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. | - |
ITERABLE_LIST_METADATA_KEYS | 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 retriev… | table |
ITERABLE_LIST_METADATA_TABLES | 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. | - |
ITERABLE_LIST_RECURRING_CHILD_CAMPAIGNS | 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 pe… | id |
ITERABLE_LIST_SNIPPETS | 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. | - |
ITERABLE_LIST_TEMPLATES | 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 param… | - |
ITERABLE_LIST_USER_FIELDS | 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 re… | - |
ITERABLE_LIST_WEBHOOKS | 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 webhoo… | - |
ITERABLE_MERGE_USERS | 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.… | - |
ITERABLE_PREVIEW_EMAIL_TEMPLATE | 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 be… | templateId |
ITERABLE_PREVIEW_IN_APP_TEMPLATE | 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.… | templateId |
ITERABLE_PREVIEW_LIST_USERS | 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. R… | listId |
ITERABLE_REPLACE_CATALOG_ITEM | 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 bo… | catalogName, itemId, value |
ITERABLE_REPLACE_METADATA_ITEM | 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… | table, key, value |
ITERABLE_SCHEDULE_CAMPAIGN | 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 z… | campaignId, sendAt |
ITERABLE_SEND_CAMPAIGN | 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 test… | campaignId |
ITERABLE_SEND_EMAIL_PROOF | 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 w… | templateId |
ITERABLE_SEND_IN_APP | 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 emai… | campaignId |
ITERABLE_SEND_IN_APP_PROOF | 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 f… | templateId |
ITERABLE_SEND_PUSH | 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 emai… | campaignId |
ITERABLE_SEND_PUSH_PROOF | 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… | templateId |
ITERABLE_SEND_SMS_PROOF | 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… | templateId |
ITERABLE_SEND_WHATS_APP | 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… | campaignId |
ITERABLE_START_EXPORT | 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 profi… | dataTypeName, outputFormat |
ITERABLE_SUBSCRIBE_TO_LIST | 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… | listId, subscribers |
ITERABLE_SUBSCRIBE_USER_BY_ID | 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. | subscriptionGroup, subscriptionGroupId, userId |
ITERABLE_TRACK_EMBEDDED_CLICK | 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… | messageId |
ITERABLE_TRACK_EMBEDDED_RECEIVED | 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 mes… | messageId |
ITERABLE_TRACK_EMBEDDED_SESSION | 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 display… | deviceInfo, session |
ITERABLE_TRACK_EVENT | 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 e… | eventName |
ITERABLE_TRACK_EVENTS_BULK | 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 requ… | events |
ITERABLE_TRACK_PURCHASE | 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… | total, items, user |
ITERABLE_TRIGGER_CAMPAIGN | 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… | campaignId, listIds |
ITERABLE_TRIGGER_JOURNEY | 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 alread… | workflowId |
ITERABLE_UNFORGET_USER | 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… | - |
ITERABLE_UNSUBSCRIBE_FROM_LIST | 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… | listId, subscribers |
ITERABLE_UNSUBSCRIBE_USER_BY_ID | 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… | subscriptionGroup, subscriptionGroupId, userId |
ITERABLE_UPDATE_CART | 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. Type… | items, user |
ITERABLE_UPDATE_CATALOG_FIELD_MAPPINGS | 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, obje… | catalogName, mappingsUpdates |
ITERABLE_UPDATE_CATALOG_ITEM | 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 f… | catalogName, itemId, update |
ITERABLE_UPDATE_EMAIL_TEMPLATE | 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 inc… | templateId |
ITERABLE_UPDATE_EMBEDDED_TEMPLATE | 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 w… | templateId |
ITERABLE_UPDATE_IN_APP_TEMPLATE | 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… | templateId |
ITERABLE_UPDATE_PUSH_TEMPLATE | 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 t… | templateId |
ITERABLE_UPDATE_SMS_TEMPLATE | 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… | templateId |
ITERABLE_UPDATE_SNIPPET | 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 exi… | identifier, content |
ITERABLE_UPDATE_USER | 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 id… | - |
ITERABLE_UPDATE_USER_EMAIL | 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 us… | newEmail |
ITERABLE_UPDATE_USER_SUBSCRIPTIONS | 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 t… | - |
ITERABLE_UPDATE_USER_SUBSCRIPTIONS_BULK | 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 m… | updateSubscriptionsRequests |
ITERABLE_UPDATE_WEBHOOK | 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 upda… | id |
ITERABLE_UPSERT_EMAIL_TEMPLATE | 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 |
ITERABLE_UPSERT_EMBEDDED_TEMPLATE | 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… | clientTemplateId |
ITERABLE_UPSERT_IN_APP_TEMPLATE | 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 giv… | clientTemplateId |
ITERABLE_UPSERT_PUSH_TEMPLATE | 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 cl… | clientTemplateId |
ITERABLE_UPSERT_SMS_TEMPLATE | 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 cli… | clientTemplateId |
ITERABLE_VERIFY_SMS_CODE | 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-v… | code, phoneNumber, verificationProfileId |
Links
We love our partners - FlyMy.AI builds with the best. Thanks, Iterable!