Skip to main content

Iterable

Cross-channel marketing platform — manage campaigns, templates, lists, users, events, journeys, catalogs, experiments, snippets, metadata tables, webhooks and data exports.

Categories: Marketing Automation, Email Marketing, Marketing

What you can ask​

  • List the users in the Newsletter Subscribers list and flag the ones who unsubscribed this week
  • Look up user jane.doe@example.com and update their subscriptions
  • Activate the triggered campaign Order Shipped for a list of users

Set up​

Iterable connects with credentials from your Iterable account. Have these values ready:

  • Data center
  • API key
  1. Go to Organization > Connectors and find Iterable.
  2. Click Enable and choose which tools to allow.
  3. Each member enters their own values the first time they use it.

To use one account for the whole organization, turn on Share one connection with everyone. Every member's agents then act as that account, with exactly the access it has.

Tools​

Iterable offers 128 tools. Admins choose which ones agents can use. See Tool permission groups.

Read (51)​

View and search information without changing it.

ToolWhat it does
export_dataDownload campaign analytics immediately as CSV or JSON lines, without a background job.
export_user_eventsDownload one user's complete event history as JSON lines, identified by email or user_id.
get_campaignRead one campaign by ID, including its state, template, lists and send times.
get_campaign_metricsGet send and engagement metrics for one or more campaigns as CSV.
get_catalog_field_mappingsRead a catalog's declared field types and the fields that have none.
get_catalog_itemRead one catalog item's stored fields.
get_email_templateRead one email template's full content: subject, HTML, plain text, sender and link settings.
get_embedded_templateRead one embedded-message template's full content: title, body, elements and placement.
get_experimentRead one experiment: its type, status, variants, traffic allocation and targeting.
get_experiment_metricsGet a metrics report across several experiments or campaigns as rows of comma-separated values.
get_experiment_totalsRead lifetime send and conversion totals for every variant in an experiment.
get_experiment_trendsRead an experiment's per-variant metrics as a time series, with the holdout group reported separately.
get_in_app_templateRead one in-app template's full content: HTML, display settings, inbox metadata and expiry.
get_list_sizeCount the users on a list without reading them.
get_list_usersRead every user on a list as email addresses, or user IDs when prefer_user_id is true.
get_metadata_valueRead one key's stored JSON value from a metadata table.
get_priority_in_app_messageRead the single most relevant in-app message waiting for one user.
get_push_templateRead one push template's full content: title, message, deep links, buttons and payload.
get_sms_templateRead one SMS template's full content: message body, image and link settings.
get_snippetRead one snippet by its numeric ID or its name.
get_template_by_client_idFind the templates carrying a given client template ID, the secondary key set when a template is created through upsert_email_template and its siblings.
get_user_by_emailRead one user profile by email address, including every custom data field.
get_user_by_user_idRead one user profile by user ID, including every custom data field.
list_campaignsList campaigns in the project, with optional state filter and sort.
list_catalog_itemsList a catalog's items with their stored fields, optionally ordered by a typed field.
list_catalogsList the project's catalog names.
list_channelsList the project's message channels and whether each is Marketing or Transactional.
list_child_campaignsList the individual sends a recurring campaign has generated.
list_embedded_messagesList the embedded messages waiting for one user, grouped by placement.
list_experiment_variantsList an experiment's variants with the template content each sends and its share of the audience.
list_experimentsList the project's experiments, filtered by campaign, state or start date.
list_export_filesRead an export job's state and the files it has written, each with a signed download URL that expires after 30 minutes.
list_export_jobsList the project's recent export jobs with their state and size.
list_in_app_messagesList the in-app messages waiting for one user on a mobile platform, in display priority order.
list_journeysList the project's journeys with their trigger events and enabled state.
list_listsList every list in the project with its type and size-relevant metadata.
list_message_typesList the project's message types with their channel, subscription policy and send caps.
list_metadata_keysList the keys in one metadata table, without their values.
list_metadata_tablesList the project's metadata tables.
list_sent_messagesList the messages Iterable has sent to one user, with campaign, date and channel filters.
list_snippetsList the project's snippets with their content and variables.
list_templatesList the project's templates with their IDs, names and message types, filtered by type, channel or creation date.
list_user_eventsRead one user's recent events, newest first, identified by email or user_id.
list_user_fieldsList every user-profile field defined in the project and its data type.
list_web_in_app_messagesList the in-app messages waiting for one user in the browser.
list_webhooksList the project's system webhooks with their endpoints, authentication and scope.
preview_email_templateRender an email template against sample data and return the HTML, without sending anything.
preview_in_app_templateRender an in-app template against sample data and return the HTML, without sending anything.
preview_list_usersRead a random sample of up to 5000 users on a list.
validate_credentialValidate the Iterable API key with a lightweight project lookup.
view_email_in_browserFetch the rendered HTML of an email already sent to a user, with that recipient's merge data applied.

Write (23)​

Create or send data.

ToolWhat it does
begin_sms_verificationSend a verification code by SMS to a phone number.
check_sms_verificationCheck a verification code against the number begin_sms_verification sent it to.
create_campaignCreate a blast or triggered campaign from an existing template, in Ready state so it sends nothing until scheduled.
create_catalogCreate an empty catalog.
create_experimentAttach a new experiment to a campaign, choosing what it varies.
create_experiment_variantAdd a variant to an experiment by copying an existing template into it.
create_listCreate a static list.
create_snippetCreate a snippet.
send_email_template_proofSend a real test email rendered from a template to one recipient.
send_in_app_template_proofSend a real test in-app message rendered from a template to one recipient.
send_push_template_proofSend a real test push notification rendered from a template to one recipient.
send_sms_template_proofSend a real test SMS rendered from a template to one recipient.
start_exportQueue a background export of events or user profiles and return its job_id.
subscribe_to_double_opt_inSend a user an SMS confirmation and subscribe them to the named message types once they reply.
subscribe_to_listAdd users to a static list, creating profiles for identifiers that do not exist yet.
subscribe_user_to_groupSubscribe one user to a list, message type or channel.
track_bulk_eventsRecord many custom events in one request.
track_embedded_message_clickRecord a click on an embedded message, creating an embeddedClick event.
track_embedded_message_receivedRecord that a device retrieved an embedded message, creating an embeddedReceived event.
track_embedded_message_sessionRecord a viewing session and one impression per embedded message seen during it, creating an embeddedSession event and an embeddedImpression event each.
track_eventRecord one custom event against a user profile.
trigger_campaignFire a triggered campaign at the members of one or more lists.
trigger_journeyEnrol one user, or every member of a list, in a journey.

Delete or overwrite (54)​

Remove or replace existing data.

ToolWhat it does
abort_campaignAbort a campaign that is currently sending.
activate_triggered_campaignActivate a triggered campaign so it can fire.
archive_campaignsArchive one or more campaigns, hiding them from the Campaigns page.
bulk_create_catalog_itemsCreate or overwrite up to 1000 catalog items in one request.
bulk_delete_catalog_itemsDelete several items from a catalog in one request.
bulk_delete_templatesDelete base templates by ID.
bulk_update_group_subscriptionsSubscribe or unsubscribe many users to or from one list, message type or channel.
bulk_update_user_subscriptionsSet list, channel and message-type subscriptions for many users in one request.
bulk_update_usersCreate or update up to 1000 user profiles in one request.
cancel_campaignCancel a scheduled or recurring campaign so it does not send.
cancel_emailCancel a scheduled email before it is delivered.
cancel_experimentStop a running experiment without choosing a winner.
cancel_export_jobCancel a queued or running export job.
cancel_in_appCancel a scheduled in-app message before it is delivered to the user's device.
cancel_pushCancel a scheduled mobile push notification before it is delivered.
cancel_rcsCancel a scheduled RCS message before it is delivered.
cancel_smsCancel a scheduled SMS before it is delivered.
cancel_web_pushCancel a scheduled browser push notification before it is delivered.
cancel_whatsappCancel a scheduled WhatsApp message before it is delivered.
deactivate_triggered_campaignDeactivate a triggered campaign so it stops firing.
declare_experiment_winnerEnd an experiment by declaring one variant the winner, after which the campaign sends that variant to everyone.
delete_catalogDelete a catalog and every collection that references it.
delete_catalog_itemDelete one item from a catalog.
delete_experimentDelete an experiment from its campaign.
delete_listDelete a list.
delete_metadata_keyDelete one key and its value from a metadata table.
delete_metadata_tableDelete a whole metadata table and every key in it.
delete_snippetDelete a snippet by its numeric ID or its name.
patch_catalog_itemSet individual fields on a catalog item, leaving the rest as they are, creating the item if it does not exist.
schedule_campaignSchedule an existing campaign to send at a given time.
set_catalog_field_mappingsDeclare data types for a catalog's fields so they can be sorted and filtered on.
set_metadata_valueCreate or REPLACE one key's JSON value, creating the table if it does not exist.
start_experimentStart an experiment so it begins allocating traffic across its variants.
track_purchaseRecord a completed purchase against a user profile, creating the profile if it does not exist.
unsubscribe_from_listRemove users from a list.
unsubscribe_user_from_groupUnsubscribe one user from a list, message type or channel.
update_cartReplace the items in a user's shopping cart, creating the profile if it does not exist.
update_email_templateUpdate one existing email template by ID.
update_embedded_templateUpdate one existing embedded-message template by ID.
update_experiment_settingsChange how an experiment splits traffic and picks a winner.
update_in_app_templateUpdate one existing in-app template by ID.
update_push_templateUpdate one existing push template by ID.
update_sms_templateUpdate one existing SMS template by ID.
update_userCreate or update one user profile, merging the fields given into whatever is already stored.
update_user_emailMove a user profile to a new email address.
update_user_subscriptionsSet one user's list, channel and message-type subscriptions.
update_webhookChange an existing webhook's endpoint, authentication, scope or enabled state.
upsert_catalog_itemCreate a catalog item, or REPLACE an existing one entirely — fields left out of value are removed.
upsert_email_templateCreate an email template, or update every template sharing the client_template_id.
upsert_embedded_templateCreate an embedded-message template, or update every template sharing the client_template_id.
upsert_in_app_templateCreate an in-app template, or update every template sharing the client_template_id.
upsert_push_templateCreate a push template, or update every template sharing the client_template_id.
upsert_sms_templateCreate an SMS template, or update every template sharing the client_template_id. message_type_id must belong to a channel whose medium is SMS — use list_message_types and list_channels to find one, or Iterable rejects the save as an invalid message medium.
upsert_snippetCreate or update a snippet by name, or update one by numeric ID.
⌘J