Reference

List all campaigns

Retrieve all campaigns in your project to see what's running and gather campaign information for further management or analysis. Use this to get campaign IDs and details needed for organizing or updating your marketing efforts.

Trigger Campaign

Immediately send a marketing campaign to specified recipient lists when you're ready to launch. This is useful for time-sensitive announcements, promotions, or product launches that need to reach your audience right away.

Abort Campaign

Immediately stops a running campaign and halts all ongoing message deliveries to recipients. Use this when you need to quickly pause a campaign due to content errors, targeting issues, or other urgent concerns.

Activate a triggered campaign

Enables a triggered campaign to start processing user events and automatically send targeted messages to subscribers. Use this when you want to activate event-based campaigns that respond to specific customer actions.

Archive Campaigns

Archive one or more campaigns to remove them from your active campaigns list while preserving them for historical reference. This stops scheduled or running campaigns and hides them from view, but keeps records intact for future auditing.

Cancel Campaign

Stop a scheduled or recurring email campaign before it sends to your audience. Use this when you need to pause marketing efforts, fix campaign content, or adjust your messaging strategy.

Create a new campaign

Launch new email, SMS, push notification, or in-app message campaigns quickly by using an existing template as your starting point. This saves time on campaign setup while ensuring consistent messaging across your marketing channels.

Deactivate Triggered Campaign

Stops a triggered campaign from automatically sending messages to users based on their actions or events in Iterable. Use this when you need to pause an automated campaign workflow without permanently deleting it.

Get campaign by ID

Retrieves detailed information about a specific campaign including its status, type, timing, and associated audience lists or message templates. Use this to check campaign details and performance settings without leaving your workflow.

Get Campaign Metrics

Retrieve performance metrics such as delivery, open, click, and conversion rates for your email, push, or SMS campaigns. Analyze campaign effectiveness across specific time periods to optimize your marketing strategy.

List recurring campaign child campaigns

Retrieve all child campaigns that were automatically generated from a recurring campaign template, allowing you to monitor and manage the individual campaign instances created over time.

Schedule Campaign

Schedule a pre-created campaign to send automatically at a specific future date and time, with optional timezone support to reach recipients at their local time.

Send Campaign

Instantly trigger an existing campaign to send out immediately in Iterable, bypassing any scheduled send times. This is useful when you need to push out urgent communications or test campaigns before their scheduled deployment.

Update Shopping Cart

Sync a customer's shopping cart items to their Iterable profile to enable personalized email campaigns based on their current shopping behavior. This automatically creates or updates the customer record with their cart contents for targeted marketing.

Create a catalog

Create a new catalog in Iterable to store and organize product, customer, or inventory data for your marketing campaigns. This enables you to structure and manage reference data that can be used across your email, SMS, and personalization efforts.

Create Catalog Items

Bulk create or update up to 1000 product items in your Iterable catalog with a single request, ideal for maintaining your product database at scale. Items are processed asynchronously, allowing you to manage large inventory changes efficiently without blocking your workflow.

Delete a catalog

Permanently remove a catalog and all its associated collections from Iterable when you no longer need them. This is useful for cleaning up outdated product lists or organizational changes.

Delete a Catalog Item

Removes a specific item from your Iterable catalog by its unique identifier, allowing you to keep your product database clean and up-to-date as inventory changes.

Delete Catalog Items

Removes specific products or items from your Iterable catalog when they're no longer needed or available. This operation handles bulk deletions efficiently and processes them in the background.

Get Catalog Field Mappings

Retrieve the field structure and data types for a specific catalog in Iterable so you can understand what information is stored and how it's formatted. This helps you validate data before syncing customer information or product catalogs.

Get catalog item by ID

Fetch details about a specific product or item from your catalog using its unique ID. This helps you quickly access product information for customer communications, inventory checks, or order fulfillment.

List Catalog Items

Retrieve all items stored in a specific Iterable catalog to access your product data, user preferences, or custom datasets. This helps you manage and reference catalog information for marketing campaigns and personalization.

List Catalogs

Retrieve all available catalogs from your Iterable account to see what product or content catalogs you have set up for marketing campaigns.

Replace Catalog Item

Completely replace or create a catalog item with updated data in your Iterable catalog, overwriting any previous version. This is useful when you need to sync product or content information from your systems to use in personalized marketing campaigns.

Update Catalog Field Mappings

Define the data types for fields in your Iterable product catalog so that customer data is properly formatted and validated. This ensures your catalog maintains data integrity and enables accurate segmentation and personalization.

Update Catalog Item

Creates or updates product information in your Iterable catalog, allowing you to keep product details synchronized for personalized marketing campaigns. Changes are processed asynchronously, so you can continue managing your catalog without waiting for confirmation.

List Channels

Retrieve all available message channels configured in your Iterable project, such as email and push notifications. This helps you understand what communication options are set up and ready to use for your marketing campaigns.

Send email template proof

Send a test version of an email template to verify its appearance and content before launching to your audience. This helps you catch formatting issues and ensure personalization data displays correctly.

Cancel Email

Stop a scheduled email from being sent to a specific user in Iterable before it reaches their inbox. This is useful when you need to prevent a queued message from delivery due to changed circumstances or updated user information.

Get email template by ID

Retrieve a specific email template from Iterable to view its content, settings, and configuration details. Use this to access template HTML, subject lines, sender information, and rendering options for review or analysis.

Preview email template

Generate a fully rendered HTML preview of your email template with custom data to see exactly how it will appear to recipients before sending campaigns.

Update email template

Modify an existing email template in Iterable by updating its content, design, sender details, or metadata without affecting unchanged fields. This lets you keep your email campaigns fresh and on-brand without starting from scratch.

Upsert email template

Create new email templates or update existing ones in Iterable by providing a template ID and content. This allows you to manage your email designs and messaging centrally for consistent customer communications.

Get Embedded Messages

Retrieves in-app embedded messages that a user is eligible to see, organized by their placement locations. This helps you deliver personalized messages directly within your app interface based on user identity.

Get Embedded Template

Retrieve the complete details of a specific embedded message template from Iterable, including its content, design elements, and configuration settings. This helps you review, verify, or reuse existing templates in your messaging campaigns.

Track Embedded Click

Records when a user clicks on a button or link within an embedded message, enabling you to measure engagement and optimize in-app messaging campaigns.

Track Embedded Received

Record when a customer receives an embedded message on their device through Iterable, enabling you to track message delivery and optimize your messaging campaigns based on actual reception data.

Track Embedded Session

Records when users view your embedded messages and how long they engage with them, helping you understand which in-app messages resonate with your audience. This provides Iterable with detailed engagement data to improve your message campaign performance.

Update Embedded Template

Modify the content, layout, or settings of an existing embedded message template in Iterable to keep your messaging campaigns current and relevant. This lets you update only the specific fields you want to change while preserving all other template details.

Upsert Embedded Template

Create or update embedded message templates in Iterable to ensure your messaging designs are ready for campaigns. This operation automatically creates new templates or updates existing ones matching your template identifier, streamlining your message design workflow.

Track Events in Bulk

Send multiple customer events to Iterable at once for tracking user actions and behaviors across your marketing campaigns. This bulk approach improves performance and ensures events are processed together in the correct sequence.

Get User Events

Retrieve a user's complete event history from Iterable, including all interactions, campaign responses, and channel activity to understand their engagement patterns and behavior.

Track Event

Records user actions and custom events in Iterable to track customer behavior and engagement for marketing automation. This enables you to capture in-app activities, purchases, or any custom business event for segmentation and personalized campaigns.

Track Purchase

Record purchase transactions in Iterable to track customer buying behavior and automatically update customer profiles with purchase data. This helps you segment customers based on purchase history and trigger follow-up marketing campaigns.

Get Experiment Metrics

Retrieve performance metrics for your email A/B tests and experiments to see which versions resonated best with your audience. Analyze open rates, click rates, and conversion data filtered by experiment, campaign, or date range to optimize your email marketing strategy.

Cancel Export

Stop a queued or in-progress export job to prevent unnecessary processing and resource consumption. Use this when you need to abort an export that's no longer needed or was started with incorrect parameters.

Export Campaign Data to JSON

Extract campaign performance metrics like sends, opens, clicks, and conversions in a structured JSON format that you can easily import into spreadsheets or analysis tools. Use this to measure your email marketing effectiveness and identify which campaigns drive the most engagement.

Export data to CSV

Export your campaign analytics and event data from Iterable in CSV format for analysis, reporting, or integration with other tools. This lets you access detailed metrics on email sends, opens, clicks, and customer interactions outside of the Iterable platform.

Export User Events

Retrieve the complete event history for a specific customer by email or user ID, including their interactions, purchases, and engagement activities within Iterable. This helps you analyze individual customer behavior and activity patterns.

List export files

Retrieve the status and generated files from a data export job, allowing you to monitor progress and download results as they become available.

List Export Jobs

Monitor and track all recent data export jobs in your Iterable project to verify completion status and manage ongoing export operations.

Start Export

Initiates a background data export job from Iterable to retrieve user profiles, events, and activity data in CSV or JSON format. This allows you to extract and analyze your customer data outside of Iterable's platform.

Cancel In-App Message

Stop a scheduled in-app message before it reaches a specific user, useful when you need to prevent outdated or incorrect messages from being delivered. This action is permanent and prevents the message from ever being sent to that user.

Get In-App Messages

Retrieve all in-app messages for a specific user from Iterable, including new messages and saved inbox items, with indicators showing which messages have been read.

Get in-app template by ID

Retrieve detailed information about a specific in-app template from your Iterable account, including its content, display settings, and metadata for verification or reuse across campaigns.

Get Web In-App Messages

Retrieves all web in-app messages for a user from Iterable, including unread notifications and saved messages. Useful for displaying personalized message inboxes or checking notification status across your web properties.

Preview in-app template

Generate a fully rendered preview of an in-app message template to see exactly how it will appear to users with your specific data. This helps you validate template design and messaging before launching campaigns.

Send in-app notification to target

Deliver targeted in-app messages to specific users based on their email or user ID, allowing you to engage customers with timely notifications directly within your application.

Send in-app template proof

Preview how an in-app message template will appear to a specific user before launching your campaign, with all personalized content rendered exactly as it will be displayed.

Update in-app template

Modify an existing in-app template in Iterable to update messaging, design, or targeting settings without affecting unchanged elements.

Upsert in-app template

Create or update in-app message templates in Iterable to control how notifications appear to your users. This operation automatically creates new templates or updates existing ones based on your template ID, allowing you to manage your app messaging strategy without duplicate efforts.

Trigger Journey

Automatically start a customer journey or workflow in Iterable for individual users or entire lists to deliver targeted messages and automated actions. This lets you engage customers at the right time with personalized communication sequences.

List Journeys

Retrieve all marketing automation journeys in your Iterable account to review their status, configuration, and metadata. This helps you manage and understand your active customer engagement workflows.

Create a new list

Create a new static contact list in Iterable to organize and segment your subscribers for targeted email campaigns. This allows you to group contacts by criteria and manage them separately for more effective marketing.

Delete a list

Permanently remove a contact list from Iterable when you no longer need it. This action cannot be undone, so ensure the list is no longer being used in any active campaigns before deletion.

Get List Size

Retrieve the total number of subscribers in a specific email list to understand your audience size and assess list health for campaign planning.

List List Users

Retrieve all users subscribed to a specific Iterable list to export, analyze, or perform batch operations on your entire subscriber base.

List Lists

Retrieve all available contact lists in your Iterable project to see which audiences you can work with. This helps you identify lists for targeting, segmentation, or integration with other tools.

Preview List Users

Get a quick sample of up to 5000 users from a specific list to see who's included without loading the entire audience. This helps you verify list quality and confirm the right people will receive your campaigns before launching.

List Message Types

Retrieves all available message types in your Iterable project, including email, push notifications, SMS, and other channels along with their configuration details.

Delete Metadata Table

Permanently removes a metadata table from Iterable to clean up unused data structures or reorganize your customer data architecture. This action is irreversible and processes asynchronously.

List Metadata Keys

Retrieve all available metadata keys from a specific metadata table in Iterable, helping you understand what custom data fields are being tracked for your campaigns and users.

List Metadata Tables

Discover and view all available metadata tables in Iterable to understand what data you can query and work with for your customer database and marketing campaigns.

Replace Metadata Item

Creates or updates custom metadata fields for your marketing data, allowing you to store and organize additional information associated with specific keys. This is useful when you need to attach custom attributes or properties to your customer records or marketing assets.

Cancel Push

Stop a scheduled push notification before it's sent to a user in Iterable. Use this when you need to prevent a queued message from being delivered.

Cancel Web Push

Stop a scheduled web push notification from being sent to a specific user in Iterable. This is useful when you need to prevent a queued message from reaching a customer before it's delivered.

Get push template by ID

Retrieves a specific push notification template from Iterable so you can review its content, configuration, and settings before sending campaigns or making updates.

Send push template proof

Preview a push notification template by sending a test version to a specific user, ensuring it displays correctly with your content before launching to your full audience.

Send push to target

Deliver targeted push notifications to individual users based on their email or user ID, with the ability to customize content using user profile data. This enables real-time communication directly to your app users for important updates and time-sensitive information.

Update push template

Modify an existing push notification template's content, settings, or configuration in Iterable to keep your messaging strategies current without recreating templates from scratch.

Upsert push template

Create or update push notification templates in Iterable to manage your mobile messaging campaigns. This operation automatically handles both new template creation and updates to existing templates based on a unique identifier.

Get SMS template

Retrieve the complete details of a specific SMS template including message content, settings, and configuration to review or verify template details before using it in campaigns.

Send SMS template proof

Send a test SMS to a specific recipient to preview how your template will render before launching it to your full audience. This helps you catch formatting issues and verify content accuracy.

Update SMS template

Modify the content, messaging, or settings of an existing SMS template in Iterable to keep your text message campaigns current and relevant. Changes apply immediately to all campaigns using that template.

Upsert SMS template

Create or update SMS templates in Iterable to manage your text message campaigns and communications. This operation automatically creates new templates or updates existing ones based on your template ID.

Verify SMS Code

Confirms that a user has entered the correct SMS verification code sent to their phone number, enabling secure phone number verification in your marketing campaigns. This ensures only users with verified phone numbers can proceed with signup or account access.

Create snippet

Creates a reusable code snippet in Iterable that can be inserted into campaigns and templates, allowing you to maintain consistent messaging and functionality across your marketing efforts without duplicating code.

Delete snippet

Removes a reusable snippet from your Iterable account by ID or name, freeing up your template library and preventing accidental use of outdated content.

Get snippet by ID or name

Retrieves a specific snippet by its ID or name so you can access its content and variables for use in your email campaigns and messaging.

List Snippets

Retrieve all code snippets available in your Iterable project to see what reusable content blocks and templates you have created for your marketing campaigns.

Update snippet by ID or name

Modify email template snippets you're already using or quickly create new ones by name, ensuring your marketing messages stay fresh and consistent across campaigns.

Bulk Update User Subscriptions

Update subscription preferences for multiple users at once, such as email list subscriptions, message types, or channel preferences. This is ideal for managing bulk changes to how your audience receives communications.

Subscribe to List

Add one or more subscribers to a specific list in Iterable, whether they're new or existing contacts. This helps you organize your audience for targeted email campaigns and marketing efforts.

Subscribe User By ID

Add a user to a specific email list or communication channel within Iterable so they receive targeted messages and campaigns for that subscription group.

Unsubscribe from list

Remove one or more users from a specific email list in Iterable, permanently unsubscribing them from that list's communications. Use this when managing subscriber preferences or maintaining list hygiene.

Unsubscribe User By ID

Removes a user from a specific subscription group, preventing them from receiving messages from that particular email list or channel. Use this to honor user preferences, manage list hygiene, or comply with unsubscribe requests.

Update User Subscriptions

Modify a user's subscription preferences for email lists, channels, and message types in Iterable to keep your communications aligned with their preferences. This operation replaces existing subscription settings with the values you specify, allowing you to quickly update how users receive your marketing messages.

Bulk delete templates

Permanently remove multiple email or push notification templates from Iterable in one action, helping you keep your template library clean and organized by deleting templates that are no longer in use.

Get template by client template ID

Retrieves email templates using your custom template identifier, allowing you to quickly access specific email designs without needing to search through Iterable's internal IDs. This is useful when you've organized templates with your own naming system or reference codes.

List all templates

Retrieves a list of all email and message templates available in your Iterable project, allowing you to view template details and IDs for use in campaigns.

Get User By ID

Retrieve detailed user information from Iterable using their unique identifier, including email and custom profile data. This is useful when you need to access specific customer information for personalization, segmentation, or account management tasks.

Update User

Adds a new user to Iterable or updates an existing user's profile information without overwriting unmapped fields. Use this to keep your customer database synchronized with current contact and behavioral data.

Bulk Update Users

Update multiple user profiles in Iterable simultaneously, such as refreshing contact information, adding custom attributes, or syncing customer data from other platforms. This lets you manage large-scale profile updates without manual entry.

Delete User By ID

Permanently removes a user from your Iterable account using their user ID, allowing you to clean up inactive accounts or manage your subscriber database.

Forget User

Permanently deletes a user's data from Iterable and stops all future data collection about them, ensuring compliance with privacy regulations like GDPR.

Get User By ID (Path)

Retrieve detailed information about a specific user in Iterable using their user ID, including email and custom data fields. Use this when you need to access individual customer profiles for personalization or verification purposes.

Get User Sent Messages

Retrieve the complete history of messages sent to a specific user to review past communications and engagement patterns. Helps you understand what content your customers have received and when.

List Forgotten User IDs

Retrieve hashed identifiers of users who have requested data deletion from your platform, enabling you to verify GDPR compliance and process data subject access requests. This helps you maintain proper records of user deletion requests and demonstrate regulatory compliance.

List User Fields

Retrieve all custom user fields configured in your Iterable project to understand your user data structure and available attributes.

Merge Users

Consolidate duplicate customer profiles in Iterable by merging all data and event history from one profile into another, then removing the source profile. Use this to clean up your customer database and maintain accurate user records.

Unforget User

Re-enable tracking and data collection for a user who was previously forgotten or deleted from Iterable, allowing new engagement data to be captured going forward.

Update User Email

Updates a user's email address in Iterable while preserving all their profile data and communication history under the new email. Use this when a subscriber changes their email and you need to keep their complete engagement record intact.

List Webhooks

Retrieve all webhooks configured in your Iterable project to see which customer events are being tracked and where they're being sent. This helps you audit your current webhook setup and verify that all necessary integrations are in place.

Update Webhook

Modify an existing webhook configuration in Iterable to change where marketing events are sent, what events trigger notifications, or authentication settings. Use this when you need to update your webhook endpoint URL, toggle it on/off, or adjust which campaign events you want to receive.

Cancel WhatsApp

Stop a scheduled WhatsApp message before it's sent to a specific user, allowing you to correct mistakes or change your messaging strategy without delivering unwanted communications.

Send WhatsApp to target

Send a WhatsApp message to a specific customer using a predefined template in Iterable, enabling direct communication via WhatsApp without building a separate messaging platform.