---
title: Iterable API Integration on Truto
slug: iterable
category: Marketing Automation
canonical: "https://truto.one/integrations/detail/iterable/"
---

# Iterable API Integration on Truto



**Category:** Marketing Automation  
**Status:** Beta

## MCP-ready AI tools

Truto exposes 157 tools for Iterable that AI agents can call directly.

- **create_a_iterable_browser_token** — Register a browser token for web push. Learn about identifying users by userId and email . Token limit : Maximum of 500 browser tokens per user profile. Returns a 400 response code when this limit has been exceeded.
- **create_a_iterable_campaign_abort** — Abort a campaign. Abort a campaign given a campaign ID
- **create_a_iterable_campaign_archive** — 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 still be viewed in the Archived tab. Rate limit : 5 requests/second, per API key.
- **list_all_iterable_campaign_metrics** — Get metrics for campaigns. Get metrics for a single campaign or multiple campaigns. Rate limit : 10 requests/minute, per project. The body is a CSV export (the spec types it as a plain string); the connector returns the rows.
- **create_a_iterable_campaign_schedule** — Schedule existing campaign to be sent
- **create_a_iterable_campaign_send** — Send existing campaign now
- **create_a_iterable_campaign_trigger** — Trigger a campaign. Trigger a campaign given lists
- **list_all_iterable_campaigns** — List campaign metadata. Get metadata about campaigns in a project. Use page and pageSize parameters to paginate results. If the unpaginated campaigns API is allowed for your project, then all campaigns are returned if no pagination parameters are provided. The unpaginated behavior is deprecated and may be removed in the future. Rate limit : 100 requests/second, per project.
- **iterable_campaigns_cancel** — Cancel a scheduled or recurring campaign. Cancel a campaign given a campaign ID
- **create_a_iterable_campaign** — Create a campaign. Creates a new blast or triggered campaign from an existing template. This endpoint can create email, push notification, web push notification, SMS, in-app message, and embedded message campaigns. Important note : 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. To learn more about creating a campaign with this API, see our API Overview .
- **get_single_iterable_campaign_by_id** — Get a campaign. Get a campaign by ID. Rate limit : 100 requests/second, per project.
- **create_a_iterable_cart_update** — Update a user's shopping cart items. Update the shoppingCartItems field on the user profile with shopping cart items. User profile is updated if it already exists (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 .
- **list_all_iterable_catalog_field_mappings** — Get field mappings for a catalog. Field mappings (field to data types) and undefined fields of a catalog
- **iterable_catalog_field_mappings_bulk_update** — Set a catalog's field mappings (data types). Set a catalog's field mappings (data types). After being set, a given field's data type may not be changed. Valid types: boolean, date, geo_location, long, double, object, and string.
- **iterable_catalog_items_bulk_delete** — Bulk delete catalog items. Asynchronous. Delete the specified catalog items from the catalog.
- **list_all_iterable_catalog_items** — Get the catalog items for a catalog. Get the catalog items for a catalog. Rate limit : 100 requests/second, per API key.
- **iterable_catalog_items_bulk_create** — Bulk create catalog items. Asynchronous. Create up to 1000 catalog items with a single request. Each of a catalog's items must have a unique ID that contains only alphanumeric characters and dashes and has a maximum length of 255 characters. If the catalog already contains an item with the same ID as one provided in the request body, the item in the catalog will be completely overwritten, unless replaceUploadedFieldsOnly is set to true. Do not use periods in field names. Rate limit : 100 requests/second, per API key.
- **delete_a_iterable_catalog_item_by_id** — Delete a catalog item. Asynchronous. Deletes the specified item from the catalog. Data may not be deleted immediately.
- **get_single_iterable_catalog_item_by_id** — Get a specific catalog item. Get a specific catalog item from the given catalog.
- **iterable_catalog_items_partial_update** — Create or update a catalog item. Asynchronous. Create or update the specified catalog item in the given catalog. A catalog item's ID must be unique, contain only alphanumeric characters and dashes, and have a maximum length of 255 characters. If the catalog item already exists, its fields will be updated with the values provided in the request body. Previously existing fields not included in the request body will remain as is. Do not use periods in field names.
- **update_a_iterable_catalog_item_by_id** — Create or replace a catalog item. Asynchronous. Create or replace the specified catalog item in the given catalog. A catalog item's ID must be unique, contain only alphanumeric characters and dashes, and have a maximum length of 255 characters. If the catalog item already exists, it will be replaced by the value provided in the request body. Do not use periods in field names. Rate limit : 1000 requests/second, per API key.
- **list_all_iterable_catalogs** — Get catalog names. Get catalog names. Rate limit : 100 requests/second, per API key.
- **delete_a_iterable_catalog_by_id** — Delete a catalog. Delete the catalog with the specified name. Also deletes all collections that reference the specified catalog.
- **create_a_iterable_catalog** — Create a catalog. Create a catalog. 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.
- **list_all_iterable_channels** — Get channels. Get all message channels within the project. Rate limit : 100 requests/second, per project.
- **list_all_iterable_data_exports_csv** — Export data to CSV. Export campaign analytics data in CSV format. Use of either 'range' or 'startDateTime' and 'endDateTime' is required. Rate limit : 4 requests/minute, per project.
- **list_all_iterable_data_exports_json** — Export data to JSON. Export campaign analytics data in JSON format, one entry per line. Use of either 'range' or 'startDateTime' and 'endDateTime' is required. Rate limit : 4 requests/minute, per project.
- **create_a_iterable_device_disable** — Disable pushes to a mobile device. Disables push notifications to a given device. Learn about identifying users by userId and email .
- **create_a_iterable_device_token** — Register a device token for push. Registers a device token for push. This will add the data if it doesn't exist yet. It will also update data fields on the device. Data will be merged; missing fields are not deleted. Also, note that there is a soft limit on the number of unique fields a user can have (default is 1,000). 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 . Device limit : Maximum of 500 devices per user profile. Endpoint returns a 400 response code when this limit has been exceeded. Rate limit : 500 reques…
- **create_a_iterable_double_opt_in_subscription** — Trigger a double opt-in subscription flow. This endpoint triggers a double opt-in subscription for a user. Once the user responds to the subscription confirmation message, they will be subscribed to the message types specified in the request body. This endpoint can only be used with SMS, double opt-in message types. To enable it, contact your customer success manager. Learn about identifying users by userId and email . Response Format Notes: 202 Accepted: Plain text (e.g., 'Request for double opt-in subscription accepted') 204 No Content: Returned when user is already subscribed to all requested message types (no body) 400 Bad Request…
- **create_a_iterable_email_send** — Send an email to an email address. Send an email to a specific email address. Request data fields will override user profile data fields. A reference to the user profile is provided via the profile field, to help resolve field collisions. Learn about identifying users by userId and email .
- **create_a_iterable_email_template_preview** — Preview email template with custom data. Generate a fully rendered HTML preview of an email template using custom data. This endpoint simulates 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. Use this to preview templates before sending campaigns or to test 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 the behavior of actual email sends. Rate limit : 10 requests/second, per project.
- **create_a_iterable_email_template_proof** — Send a proof of an email template. Send a proof of an email template to a specific user. Rate limit : 20 requests/second, per API key.
- **list_all_iterable_email_templates** — Get one email template by templateId (required query parameter; locale optional). Returns that template. Note: despite the .list name this returns ONE template (pass templateId, optional locale); use templates.list to list templates.

- **update_a_iterable_email_template_by_id** — Update email template
- **create_a_iterable_email_template** — Create email template. Create email template if it doesn't exist already, otherwise update all email templates that match the name provided.
- **list_all_iterable_email_views** — View a previously sent email. View a rendered version of a previously sent email. Learn about identifying users by userId and email . Rate limit : 100 requests/second, per project.
- **iterable_emails_cancel** — Cancel an email to a user. Cancels an email to a specific user. Request must include a campaignId and an email or userId , or just a scheduledMessageId . Learn about identifying users by userId and email .
- **create_a_iterable_embedded_message_click** — Track an embedded message click. This endpoint tracks a click on an embedded message. It creates an embeddedClick event. For test messages (proofs), no events are created. Learn about identifying users by userId and email .
- **create_a_iterable_embedded_message_receipt** — Track an embedded message received event. This endpoint tracks that a given embedded message was received on a device. It creates an embeddedReceived event in Iterable. An embeddedReceived event indicates that a device has retrieved a message. It does not mean that the message has been displayed. Iterable's SDKs automatically call this endpoint for each embedded message they retrieve. If you're not using an SDK, call this endpoint once per embedded message you retrieve from Iterable's API. For test messages (proofs), no events are created. Learn about identifying users by userId and email .
- **create_a_iterable_embedded_message_session** — Track an embedded message session and related impressions. This endpoint tracks a single embeddedSession event, and one embeddedImpression event for each of the session's impressions. An embeddedSession event represents a period of time when a user is viewing a page or a screen where embedded messages can be displayed (in one or many placements). An embeddedImpression event represents the number of times a given embedded message was visible during the session, and the total amount of time the message was visible (in seconds) across all those appearances. This endpoint does not create events for test messages (proofs). Learn about identifying users by…
- **list_all_iterable_embedded_messages** — Get a user's embedded messages. This endpoint returns embedded messages for which the specified user is eligible, grouped by placementId . By default, it returns data for all placements that have messages for the user. To constrain the response to specific placements, provide one or more placementIds query parameters. Learn about identifying users by userId and email .
- **list_all_iterable_embedded_templates** — Get one embedded template by templateId (required query parameter; locale optional). Returns that template. Note: despite the .list name this returns ONE template (pass templateId, optional locale); use templates.list to list templates.

- **update_a_iterable_embedded_template_by_id** — Update embedded message template
- **create_a_iterable_embedded_template** — Create an embedded message template. Create an embedded message template if it doesn't exist yet, otherwise update all embedded message templates that match the name provided.
- **create_a_iterable_event** — Track an event. Events are created asynchronously and processed separately from single event (non-bulk) endpoint . To make sure events are tracked in order, send them all to the same endpoint (either bulk or non-bulk). There is a soft limit (default is 8,000) on the number of unique fields a custom event can have. For events of the same name, identically named data fields must be of the same type. Learn about identifying users by userId and email . Rate limit : 2000 requests/second, per project.
- **iterable_events_bulk_create** — Bulk track events. Events are created asynchronously and processed separately from single event (non-bulk) endpoint . To make sure events are tracked in order, send them all to the same endpoint (either bulk or non-bulk). There is a soft limit (default is 8,000) on the number of unique fields a custom event can have. For events of the same name, identically named data fields must be of the same type. Learn about identifying users by userId and email . Rate limit : 10 requests/second, per project.
- **create_a_iterable_experiment_deletion** — Delete an experiment. Deletes a campaign experiment that's in draft or ready status and returns the experiment as it was before deletion. This endpoint doesn't support journey experiments.
- **list_all_iterable_experiment_metrics** — Get metrics for experiments. Get metrics for a single experiment or for multiple experiments. Note that we currently only support exporting email experiment metrics.
- **iterable_experiment_settings_bulk_update** — Update experiment settings. Updates settings on a campaign experiment that's in draft or ready status. Iterable changes only the fields you send. Omitted fields keep their current values, and null removes a setting when the field allows it. Blast campaigns accept blast and holdout settings, and triggered campaigns accept trigger settings. This endpoint works only with experiments that test message content: the subject line, preheader text, from name and sender, email body, or all content. It doesn't work with send time or Send Time Decisioning experiments. This endpoint doesn't support journey experiments.
- **create_a_iterable_experiment_start** — Start an experiment. Starts a campaign experiment that's in draft or ready status. This endpoint doesn't support journey experiments.
- **list_all_iterable_experiment_totals** — Get experiment totals. Get lifetime send and conversion totals for each variant in a campaign experiment. This endpoint doesn't support journey experiments.
- **list_all_iterable_experiment_trends** — Get experiment trends. Get histogram time series data for each variant in a campaign experiment. Iterable picks the interval between data points based on the date range. To choose a date range, send both startDateTime and endDateTime as UTC ISO 8601 timestamps. The range must fall within the period the experiment ran and can't exceed 31 days. If you omit both, Iterable returns up to the last 31 days the experiment ran, ending one minute before the experiment ended, or before the current time if it's still running . If the experiment hasn't started, the response contains no data. This endpoint doesn't support journe…
- **list_all_iterable_experiment_variants** — Get experiment variants. Get all variants for an experiment, including each variant's template content.
- **create_a_iterable_experiment_variant** — Copy a template as a new variant. Copies the template you specify into a new variant on a campaign experiment that's in draft or ready status. Each successful request adds another variant, so retrying a successful request creates a duplicate. This endpoint works only with experiments that test message content: the subject line, preheader text, from name and sender, email body, or all content. It doesn't work with send time or Send Time Decisioning experiments. This endpoint doesn't support journey experiments.
- **create_a_iterable_experiment_winner** — Declare a winner and end experiment. Declares the variant you specify as the winner of a running experiment, and then ends the experiment. If the experiment already has a winner ( winner_found ), the variant you specify replaces it. Iterable replaces the campaign's template with the winning variant's template. You can't declare the holdout group as the winner, and you can't change the winner after the experiment ends. This endpoint works only with experiments that test message content: the subject line, preheader text, from name and sender, email body, or all content. It doesn't work with send time or Send Time Decisioning exper…
- **list_all_iterable_experiments** — List experiments. Get a list of experiments with optional filtering by campaign, state, and date range. The connector pages automatically with `limit` (up to 100) and `next_cursor` (offset paging).

- **create_a_iterable_experiment** — Create an experiment. Creates a draft experiment on a campaign. The campaign's current template becomes the control variant. This request doesn't add variants, configure settings, or start the experiment. If you omit name , Iterable names the experiment {campaign name} Experiment . You can create experiments that test message content: the subject line, preheader text, from name and sender, email body, or all content. You can't use this endpoint to create send time or Send Time Decisioning experiments. This endpoint doesn't support journey experiments.
- **get_single_iterable_experiment_by_id** — Get an experiment. Get a single experiment by ID.
- **iterable_experiments_cancel** — Cancel an experiment. Cancels a campaign experiment that's in running or winner_found status without declaring a winner. The campaign keeps its current template. This endpoint doesn't support journey experiments.
- **list_all_iterable_export_job_files** — Get 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. 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. Each file is up to 10MB. Exports are limited to 100GB in total size. Rate limit : 1 request/second, per organization…
- **list_all_iterable_export_jobs** — Get export jobs. Return a list of recent export jobs. Only includes jobs for the current project and not other projects.
- **create_a_iterable_export_job** — Start export. Start a data export. The export processes as a background job. Use the "Get export files" endpoint to check export status by jobId and obtain file download links. Rate limit : 1 request/second, per organization. Concurrent request limit : Up to 4 exports process at a time, per organization. Additional requests are queued.
- **delete_a_iterable_export_job_by_id** — Cancel export. Cancel a queued or running export created with the "Start export" endpoint. Rate limit : 1 request/second, per project.
- **list_all_iterable_forgotten_user_ids** — Get hashed forgotten userIds in compliance with GDPR. Returns a hash for each userId currently forgotten by your project. Each forgotten userId is lowercased, trimmed, and hashed using SHA-256. This endpoint only works for userID-based and hybrid projects. For email-based projects, it returns an error. Learn about identifying users by userId and email . Rate limit : 3 requests/second, per project.
- **list_all_iterable_forgotten_users** — Get hashed forgotten users in compliance with GDPR. Returns a hash for each email addresses currently forgotten by your project. Each forgotten email is lowercased, trimmed, and hashed using SHA-256. This endpoint only works for email-based and hybrid projects. For userID-based projects, it returns an error. Learn about identifying users by userId and email . Rate limit : 3 requests/second, per project.
- **create_a_iterable_in_app_click_event** — Track an in-app message click. Creates an inAppClick event for the specified user, message, and URL. When not using one of Iterable’s mobile SDKs, call this endpoint when a user taps on a button or link in an in-app message. Learn about identifying users by userId and email .
- **create_a_iterable_in_app_close_event** — Track the closing of an in-app message. Creates an inAppClose event for a specific user and in-app message. When not using Iterable's mobile SDKs, call this endpoint to indicate that the user tapped a close button, link or back button to close a particular in app-message. Learn about identifying users by userId and email .
- **create_a_iterable_in_app_consume** — Consume or delete an in-app message. Consumes or deletes an in-app message from the server. Use this API if your app does not use one of Iterable’s mobile SDKs, since they call it automatically. If an incoming in-app message is not configured to use the mobile inbox, use this API to "consume" it from the server queue after the user sees it. Otherwise, call this API when the user explicitly deletes an inbox-enabled message (by clicking a delete button in its content, swiping it in the inbox, etc.). If you pass a deleteAction value to this endpoint, Iterable generates an inAppDelete event; otherwise, it does not. Learn about ident…
- **create_a_iterable_in_app_delivery_event** — Track the delivery of an in-app message. Creates an inAppDelivery event for a specific user, device, and message. When not using Iterable's mobile SDKs, call this endpoint to indicate that a particular message has been delivered to a particular device for a particular user. Take care not to call this endpoint multiple times for the same message/device/user combination. Learn about identifying users by userId and email .
- **iterable_in_app_messages_cancel** — Cancel a scheduled in-app message. Cancels the sending of a scheduled in-app message to a specific user. Learn about identifying users by userId and email .
- **list_all_iterable_in_app_messages** — Get a user's in-app messages. Get a user's in-app messages. 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. This endpoint returns new messages and messages that have already been saved to a mobile inbox, and each message has a read field to indicate whether or not it has already been seen. Learn about identifying users by userId and email .
- **create_a_iterable_in_app_open_event** — Track an in-app message open. Creates an inAppOpen event for the specified user and message, and marks the message as having been read. When not using one of Iterable’s mobile SDKs, call this endpoint when a mobile app displays an in-app message to a user. Learn about identifying users by userId and email .
- **list_all_iterable_in_app_priority_messages** — Get a user's most relevant in-app message. Get a user's most relevant in-app message. Learn about identifying users by userId and email .
- **create_a_iterable_in_app_send** — Send an in-app notification to a user. Send an in-app notification to a specific user. Request data fields will override user profile data fields. A reference to the user profile is provided via the profile field, to help resolve field collisions. Learn about identifying users by userId and email .
- **create_a_iterable_in_app_template_preview** — Preview in-app template with custom data. Generate a fully rendered HTML preview of an in-app template using custom data. This endpoint simulates 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. Use this to preview templates before sending campaigns or to test 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 the behavior of actual email sends. Rate limit : 10 requests/second, per project.
- **create_a_iterable_in_app_template_proof** — Send a proof of an in-app template. Send a proof of an in-app template to a specific user. Rate limit : 20 requests/second, per API key.
- **list_all_iterable_in_app_templates** — Get one in-app template by templateId (required query parameter; locale optional). Returns that template. Note: despite the .list name this returns ONE template (pass templateId, optional locale); use templates.list to list templates.

- **update_a_iterable_in_app_template_by_id** — Update in-app template
- **create_a_iterable_in_app_template** — Create an in-app template. Create an in-app template if it doesn't exist yet, otherwise update all in-app templates that match the name provided.
- **create_a_iterable_journey_trigger** — Trigger a journey (workflow). Triggers a journey (formerly known as workflow). Triggering with a list is asynchronous. If a list trigger is in progress, it must finish before the same list can be triggered again for a particular journey. The journey stats may take several minutes to update if other journeys are running. If the journey's start tile has a suppression list, that will apply. Learn about identifying users by userId and email .
- **list_all_iterable_journeys** — Get journeys (workflows). Get a list of the journeys within your project.
- **list_all_iterable_list_sizes** — Get count of users in list. Get the number of users within a list. Rate limit : 5 requests/minute, per project.
- **create_a_iterable_list_subscription** — Add subscribers to list. Add specific subscribers to a list. Learn about identifying users by userId and email .
- **create_a_iterable_list_unsubscription** — Remove users from a list. Remove specific users from a list. Learn about identifying users by userId and email .
- **list_all_iterable_list_user_previews** — Preview users in a list. Get a random sample of up to 5000 users within a list. Rate limit : 5 requests/minute, per project. Returns newline-separated user identifiers as text.
- **list_all_iterable_list_users** — Get users in a list. Get all users within a list. Rate limit : 5 requests/minute, per project. Returns newline-separated user identifiers as text.
- **list_all_iterable_lists** — Get lists. Get all lists within a project. Rate limit : 100 requests/second, per project.
- **create_a_iterable_list** — Create a static list. Create a new static list.
- **delete_a_iterable_list_by_id** — Delete a list. Delete a list by listId.
- **list_all_iterable_message_types** — List message types. List all message types within a project. Rate limit : 100 requests/second, per project.
- **list_all_iterable_metadata_keys** — List keys in a table
- **list_all_iterable_metadata_tables** — List available tables
- **delete_a_iterable_metadata_table_by_id** — Delete a table. Asynchronous. Deletes the table. 200 response indicates a valid request that will be processed; table may not be deleted immediately. Use GET /api/metadata/{table} to verify completion.
- **delete_a_iterable_metadata_value_by_id** — Delete a single metadata key/value. Asynchronous. Deletes the specified item from the table. 200 response indicates a valid request that will be processed; data may not be deleted immediately. Use GET /api/metadata/{table}/{key} to verify completion.
- **get_single_iterable_metadata_value_by_id** — Get the metadata value of a single key
- **update_a_iterable_metadata_value_by_id** — Create or replace metadata. Asynchronous. Creates or replaces the item associated with the specified key. 200 response indicates a valid request that will be processed; updates may not be made immediately. Use GET /api/metadata/{table}/{key} to verify completion.
- **create_a_iterable_purchase** — Track a purchase. Track purchase events. shoppingCartItems field on the user profile is cleared. User profile is also updated if it already exists (created otherwise) using the user request field. Also, note that there is a soft limit on the number of unique fields a user can have (default is 1,000). 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 .
- **create_a_iterable_push_open_event** — Track a mobile push open. Learn about identifying users by userId and email .
- **create_a_iterable_push_send** — Send push notification to user. Send a push notification to a specific user. Request data fields will override user profile data fields. A reference to the user profile is provided via the profile field, to help resolve field collisions. Learn about identifying users by userId and email .
- **create_a_iterable_push_template_proof** — Send a proof of a push template. Send a proof of a push template to a specific user. Rate limit : 20 requests/second, per API key.
- **list_all_iterable_push_templates** — Get one push template by templateId (required query parameter; locale optional). Returns that template. Note: despite the .list name this returns ONE template (pass templateId, optional locale); use templates.list to list templates.

- **update_a_iterable_push_template_by_id** — Update push template
- **create_a_iterable_push_template** — Create a push template. Create a push template if it doesn't exist, otherwise update all push templates that match the name provided.
- **iterable_pushes_cancel** — Cancel a push notification to a user. Cancels a push notification to a specific user. Request must include a campaignId and an email or userId , or just a scheduledMessageId . Learn about identifying users by userId and email .
- **iterable_rcs_messages_cancel** — Cancel a scheduled RCS message. Cancels the sending of a scheduled RCS message to a specific user. Request must include a campaignId and an email or userId , or just a scheduledMessageId . Learn about identifying users by userId and email .
- **create_a_iterable_rcs_send** — Send an RCS message to a user. Send an RCS message to a specific user. Optionally, schedule the send with sendAt instead of sending immediately. Learn about identifying users by userId and email .
- **list_all_iterable_recurring_campaign_children** — Get child campaigns of a recurring campaign. Get child campaigns generated by a recurring campaign. Use page and pageSize parameters to paginate results. If the unpaginated campaigns API is allowed for your project, then all child campaigns are returned if no pagination parameters are provided. The unpaginated behavior is deprecated and may be removed in the future. Rate limit : 100 requests/second, per project.
- **list_all_iterable_sent_messages** — Get messages sent to a user. Gets messages sent to a user, by email address or userId . Returns 10 by default, up to 1,000. Learn about identifying users by userId and email . Rate limit : 3 requests/second, per project.
- **iterable_sms_messages_cancel** — Cancel an SMS to a user. Cancels an SMS to a specific user. Request must include a campaignId and an email or userId , or just a scheduledMessageId . Learn about identifying users by userId and email .
- **create_a_iterable_sms_send** — Send SMS notification to user. Send an SMS notification to a specific user. Note that this API is typically used for transactional messaging. Request data fields will override user profile data fields. A reference to the user profile is provided via the profile field, to help resolve field collisions. Learn about identifying users by userId and email .
- **create_a_iterable_sms_template_proof** — Send a proof of an SMS template. Send a proof of an SMS template to a specific user. Rate limit : 20 requests/second, per API key.
- **list_all_iterable_sms_templates** — Get one sms template by templateId (required query parameter; locale optional). Returns that template. Note: despite the .list name this returns ONE template (pass templateId, optional locale); use templates.list to list templates.

- **update_a_iterable_sms_template_by_id** — Update SMS template
- **create_a_iterable_sms_template** — Create an SMS template. Create an SMS template if it doesn't exist yet, otherwise update all SMS templates that match the name provided.
- **create_a_iterable_sms_verification** — Begin SMS Verification. Sends an SMS verification code to phoneNumber , using the specified verificationProfileId . Verification codes are sent from a pool of sender IDs reserved for this use, not from your sender IDs. Because of this, you don't need to worry about competing message priority or throughput. Call this endpoint only for projects that use Iterable SMS to send SMS messages. If you use your own Twilio or Telnyx account, call their verification endpoints directly. To use this endpoint, first ask your Iterable customer success manager to add SMS phone verification to your project. To learn more, read SMS Ph…
- **iterable_sms_verifications_validate** — Check SMS Verification Code. Checks whether the code included in the request body matches the most recent, non-expired, not-yet-verified SMS verification code sent to phoneNumber by the specified verificationProfileId . If code is correct, the endpoint returns a 200 response with a JSON body that has a params object with status set to verified . If code is incorrect, the endpoint returns a 200 response with a JSON body that has a params object with status set to rejected . If there is no pending verification for phoneNumber because it expired, was already approved, or reached the maximum number of check attempts, the end…
- **list_all_iterable_snippets** — Get all snippets. Get all snippets for the current project.
- **create_a_iterable_snippet** — Create a snippet. Create a new snippet.
- **delete_a_iterable_snippet_by_id** — Delete a snippet. Delete a snippet by ID (numeric) or name (string). Numeric identifiers are treated as IDs, string identifiers as names.
- **get_single_iterable_snippet_by_id** — Get snippet by ID or name. Retrieve a snippet by its ID (numeric) or name (string). Numeric identifiers are treated as IDs, string identifiers as names.
- **update_a_iterable_snippet_by_id** — Create or update a snippet. Create or update a snippet by ID (numeric) or name (string). For names, creates the snippet if it doesn't exist. For IDs, only updates existing snippets. Numeric identifiers are treated as IDs, string identifiers as names.
- **iterable_subscription_group_users_bulk_update** — Bulk subscription action on a list of users. Subscribes or unsubscribes multiple users to the specified subscription group. In users , list email addresses. In usersByUserId , list userId values. A single request can include both users and usersByUserId . To enable this API, contact your customer success manager. Learn about identifying users by userId and email .
- **delete_a_iterable_subscription_group_user_by_id** — Unsubscribe a single user. Unsubscribes a user from the specified subscription group. To enable this API, contact your customer success manager. Learn about identifying users by userId and email .
- **update_a_iterable_subscription_group_user_by_id** — Subscribe a single user. Subscribes a user to the specified subscription group. To enable this API, contact your customer success manager. Learn about identifying users by userId and email .
- **delete_a_iterable_subscription_group_users_by_user_id_by_id** — Unsubscribe a single user by userId. Unsubscribes a user from the specified subscription group. To enable this API, contact your customer success manager. Learn about identifying users by userId and email .
- **update_a_iterable_subscription_group_users_by_user_id_by_id** — Subscribe a single user by their userId. Subscribes a user to the specified subscription group. To enable this API, contact your customer success manager. Learn about identifying users by userId and email .
- **list_all_iterable_templates** — Get project templates. Get templates for a project. Use page and pageSize parameters to paginate results. If the unpaginated templates API is allowed for your project, then all templates are returned if no pagination parameters are provided. The unpaginated behavior is deprecated and may be removed in the future. Rate limit : 100 requests/second, per project. The connector pages automatically with `limit` (up to 100) and `next_cursor` (page / pageSize paging).

- **iterable_templates_bulk_delete** — Bulk delete templates. This endpoint deletes one or more base templates. Templates which are associated with a campaign will not be deleted.
- **list_all_iterable_templates_by_client_template_id** — Get an email template by clientTemplateId. Rate limit : 100 requests/second, per project.
- **create_a_iterable_triggered_campaign_activation** — Activate a triggered campaign. Activate a triggered campaign given a campaign ID
- **create_a_iterable_triggered_campaign_deactivation** — Deactivate a triggered campaign. Deactivate a triggered campaign given a campaign ID
- **create_a_iterable_user_email_change** — Update user email. Updates a user's email . Use this endpoint with email-based projects. To update an email in a userID-based or hybrid project, use POST /api/users/update . In the request body, specify currentEmail or currentUserId , but not both. If you include both, currentEmail takes precedence. Returns an error if the new email already exists in Iterable, or if the new email has been forgotten via a GDPR request. Learn about identifying users by userId and email .
- **list_all_iterable_user_event_exports** — Export user events. Export all events (in JSON) for the user specified by email or userId . One event per line. Learn about identifying users by userId and email .
- **list_all_iterable_user_events** — Get user events. Get events for a specific user, by email . On Iterable's API Documentation page, this endpoint does not work for email values that contain a / character. In such cases, you can still call this endpoint with a tool like curl or Postman, or from your code. To learn how, read Using API keys . Learn about identifying users by userId and email . Rate limit : 100 requests/second, per project.
- **list_all_iterable_user_events_by_user_id** — Get user events by userId. Get events for a specific user, by userId . On Iterable's API Documentation page, this endpoint does not work for userId values that contain a / character. In such cases, you can still call this endpoint with a tool like curl or Postman, or from your code. To learn how, read Using API keys . Learn about identifying users by userId and email . Rate limit : 100 requests/second, per project.
- **list_all_iterable_user_fields** — Get all user fields. Get all user fields within a project. Rate limit : 3 requests/second, per project.
- **create_a_iterable_user_forget** — Forget a user in compliance with GDPR. Deletes the specified user's data from the Iterable project and prevents future data collection 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 . Rate limit : 3 requests/second, per project. Daily Cap : 1000 requests per 24 hour period, per project.
- **create_a_iterable_user_jwt_invalidation** — Invalidate all JWTs issued for a user. Invalidates all JWTs issued for a given user before the current time or a specified time. Learn about identifying users by userId and email .
- **create_a_iterable_user_merge** — Merge users. Merge two users. In the request body, specify sourceEmail or sourceUserId (but not both), and destinationEmail or destinationUserId (but not both). Returns an error if source user does not exist in Iterable. Will update source user if destination user is not found. Rate limit : 50 requests/second, per API key. Learn about identifying users by userId and email .
- **iterable_user_subscriptions_bulk_update** — Bulk update user subscriptions. IMPORTANT : This endpoint overwrites (does not merge) existing data for any non- null fields specified in the request. Learn about identifying users by userId and email .
- **create_a_iterable_user_subscription** — Update user subscriptions. Updates user subscriptions. IMPORTANT : This endpoint overwrites (does not merge) existing data for any non- null fields specified in the request. Learn about identifying users by userId and email .
- **create_a_iterable_user_unforget** — Unforget a user in compliance with GDPR. Allows the Iterable project to resume collecting data about a previously forgotten user. Deleted data cannot be recovered. In email-based projects, you must unforget users by email . In userID-based projects, you must unforget users by userId . In hybrid projects and in projects that migrated from being email-based to being userID-based, you can unforget users by either email or userId . Learn about identifying users by userId and email . Rate limit : 3 requests/second, per project. Daily Cap : 1000 requests per 24 hour period, per project.
- **iterable_users_bulk_update** — Bulk update user data: body {users: [{email or userId, dataFields, preferUserId, mergeNestedObjects}]} (up to 1,000 users per request; processed asynchronously).
- **create_a_iterable_user** — Update user data. Updates user data or adds a user if none exists. Data is merged - missing fields are not deleted. Please note 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, such as POST /api/email/target. Learn about identifying users by userId and email . Rate l…
- **delete_a_iterable_user_by_id** — Delete a user by email. Asynchronous. Deletes a specific user by email . Does not prevent future data collection about the user. This endpoint can be used to delete users from email-based projects and hybrid projects, but not userID-based projects. On Iterable's API Documentation page, this endpoint does not work for email values that contain a / character. In such cases, you can still call this endpoint with a tool like curl or Postman, or from your code. To learn how, read Using API keys . Learn about identifying users by userId and email . Rate limit : 100 requests/second, per project.
- **get_single_iterable_user_by_id** — Get a user by email (path parameter). Get a user by email address (passed as a path parameter). On Iterable's API Documentation page, this endpoint does not work for email values that contain a / character. In such cases, you can use GET /api/users/getByEmail instead, or you can still call this endpoint with a tool like curl or Postman, or from your code. To learn how, read Using API keys . Learn about identifying users by userId and email . Rate limit : 100 requests/second, per project.
- **delete_a_iterable_users_by_user_id_by_id** — Delete user by userId. Asynchronous. Deletes a specific user by userId . 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. On Iterable's API Documentation page, this endpoint does not work for userId values that contain a / character. In such cases, you can still call this endpoint with a tool like curl or Postman, or from your code. To learn how, read Using API keys . Learn about identifying users by userId and email . Rate limit :…
- **get_single_iterable_users_by_user_id_by_id** — Get a user by userId (path parameter). Get a user by userId (passed as a path parameter). On Iterable's API Documentation page, this endpoint does not work for userId values that contain a / character. In such cases, you can use GET /api/users/byUserId , or you can still call this endpoint with a tool like curl or Postman, or from your code. To learn how, read Using API keys . Learn about identifying users by userId and email . Rate limit : 100 requests/second, per project.
- **list_all_iterable_web_in_app_messages** — Get a user's web in-app messages. Get a user's web in-app messages. This endpoint always returns the user's non-selective (not app-specific) web in-app messages; to also fetch web app-specific in-app messages, include a packageName in the request. This endpoint returns new messages and messages that have already been saved to a mobile inbox, and each message has a read field to indicate whether or not it has already been seen. Learn about identifying users by userId and email .
- **create_a_iterable_web_push_click_event** — Track a web push click. Learn about identifying users by userId and email .
- **create_a_iterable_web_push_send** — Send web push notification to user. Sends a web push notification to a specific user. Request data fields override user profile data fields. A reference to the user profile is provided via the profile field, to help resolve field collisions. Learn about identifying users by userId and email .
- **iterable_web_pushes_cancel** — Cancel a web push notification to a user. Cancels a web push notification to a specific user. Request must include a campaignId and an email or userId , or just a scheduledMessageId . Learn about identifying users by userId and email .
- **list_all_iterable_webhooks** — Get webhooks. Get webhooks for a project.
- **update_a_iterable_webhook_by_id** — Update webhook
- **iterable_whatsapp_messages_cancel** — Cancel a scheduled WhatsApp message. Cancels the sending of a scheduled WhatsApp message to a specific user. Learn about identifying users by userId and email .
- **create_a_iterable_whatsapp_send** — Send a WhatsApp message to a user. Send a WhatsApp message to a user. Request data fields will override user profile data fields. Learn about identifying users by userId and email .

## How it works

1. **Link your customer's Iterable account.** Use Truto's frontend SDK; we handle every OAuth and API key flow so you don't need to create the OAuth app.
2. **Authentication is automatic.** Truto refreshes tokens, stores credentials securely, and injects them into every API request.
3. **Call Truto's API to reach Iterable.** The Proxy API is a 1-to-1 mapping of the Iterable API.
4. **Get a unified response format.** Every response uses a single shape, with cursor-based pagination and data in the `result` field.

## Use cases

- **Power lifecycle marketing for e-commerce merchants** — Let merchants on your commerce or subscription platform trigger Iterable journeys from real purchase and cart activity. Sync product catalogs, cart updates, and purchases so marketers can launch browse abandonment and renewal campaigns without engineering help.
- **Automate inbound lead capture for form and CRM tools** — When a prospect submits a form or lands in a CRM, instantly provision them as an Iterable user and subscribe them to the right list. Marketers get real-time nurture flows triggered by your product without manual CSV uploads.
- **Surface support context inside marketing journeys** — Help desks and customer success platforms can push ticket status and resolution events into Iterable as user attributes and custom events. Marketers can suppress promos during escalations and trigger NPS surveys after resolutions.
- **Unify marketing engagement in analytics and BI dashboards** — Pull Iterable campaign metrics and raw user events into your analytics product to attribute marketing touchpoints to product activation and revenue. Give customers a single view of engagement across channels.
- **Keep subscription and consent preferences in sync** — Preference centers, CDPs, and compliance tools can read and write Iterable list memberships and subscription groups so opt-ins stay accurate across every system a customer uses.

## What you can build

- **Real-time user and attribute sync** — Create and update Iterable user profiles in bulk from your app so custom fields, identifiers, and consent flags stay current across both systems.
- **Event streaming for journey triggers** — Forward product events like signups, feature usage, or ticket resolutions into Iterable using single or bulk event ingestion to kick off automated workflows.
- **Catalog sync for dynamic content** — Push product, course, or inventory data into Iterable Catalogs with bulk create and partial update so marketers can personalize emails with live content from your platform.
- **Cart and purchase tracking for commerce journeys** — Fire cart update and purchase events directly to Iterable to power abandoned cart, post-purchase, and subscription renewal campaigns with accurate revenue data.
- **Transactional message dispatch** — Trigger one-off emails, SMS, or push notifications from your product through Iterable's send endpoints for receipts, password resets, and account notifications.
- **Campaign metrics and export pipelines** — Pull campaign-level metrics and schedule bulk event exports to feed Iterable engagement data into your analytics, warehouse, or attribution views.
- **GDPR-compliant user forget workflows** — Expose a one-click deletion flow that calls Iterable's user forget endpoint and verifies status against the forgotten users list for audit trails.

## FAQs

### How does authentication work for connecting end-user Iterable accounts?

Iterable uses API keys scoped to a specific project. Through Truto, your end users paste their Iterable API key during connection setup, and Truto securely stores and injects it on every request so you never handle credentials directly.

### Can we sync custom user attributes and event properties?

Yes. Iterable's data model supports arbitrary custom fields on user profiles and custom properties on events. You can write them via the create user, bulk user update, and event ingestion endpoints, and read the schema using the user fields and metadata endpoints.

### How do we handle high-volume event ingestion?

Use the bulk events endpoint to send batched events in a single request, and bulk user update for profile changes. This is the recommended pattern for backfills and high-throughput streaming to stay within Iterable's rate limits.

### Can we extract campaign performance and raw engagement data?

Yes. You can pull aggregated campaign metrics, list sent messages and email views, and create export jobs that generate CSV or JSON files containing raw user events for downstream analytics or warehousing.

### Does the integration support channels beyond email?

Yes. Iterable is cross-channel, and the available tools cover email, SMS, push, in-app, embedded messages, web push, WhatsApp, and RCS, including sends, template management, and cancellations for each.

### How do we support GDPR and privacy requests?

Iterable exposes dedicated endpoints to forget a user (deleting their data), unforget them if needed, and list all forgotten users or IDs for audit. These are all available as tools so you can build compliant deletion flows for your customers.

### Does Truto handle pagination and API quirks for Iterable?

Yes. Truto normalizes pagination, retries, and error handling across Iterable endpoints so you work with consistent request and response patterns instead of per-endpoint edge cases.

## Related reading

- [Connect Iterable to Claude: Optimize Experiments and Analytics](https://truto.one/blog/connect-iterable-to-claude-optimize-experiments-and-analytics/) — Learn how to connect Iterable to Claude using Truto's MCP Server. This guide covers setup, hero tools, and real-world marketing automation workflows.
- [Connect Iterable to ChatGPT: Manage Campaigns and User Profiles](https://truto.one/blog/connect-iterable-to-chatgpt-manage-campaigns-and-user-profiles/) — Learn how to connect Iterable to ChatGPT using an auto-generated MCP server to automate campaigns, track user events, and orchestrate marketing workflows.
- [Connect Iterable to AI Agents: Sync Catalogs and Automate Flows](https://truto.one/blog/connect-iterable-to-ai-agents-sync-catalogs-and-automate-flows/) — Learn how to connect Iterable to AI agents using Truto's /tools endpoint. Build autonomous workflows that sync catalogs, trigger journeys, and manage users.
