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 Subscriberslist and flag the ones who unsubscribed this week - Look up user
jane.doe@example.comand update their subscriptions - Activate the triggered campaign
Order Shippedfor a list of users
Set up
Iterable connects with credentials from your Iterable account. Have these values ready:
- Data center
- API key
- Go to Organization > Connectors and find Iterable.
- Click Enable and choose which tools to allow.
- 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.
| Tool | What it does |
|---|---|
export_data | Download campaign analytics immediately as CSV or JSON lines, without a background job. |
export_user_events | Download one user's complete event history as JSON lines, identified by email or user_id. |
get_campaign | Read one campaign by ID, including its state, template, lists and send times. |
get_campaign_metrics | Get send and engagement metrics for one or more campaigns as CSV. |
get_catalog_field_mappings | Read a catalog's declared field types and the fields that have none. |
get_catalog_item | Read one catalog item's stored fields. |
get_email_template | Read one email template's full content: subject, HTML, plain text, sender and link settings. |
get_embedded_template | Read one embedded-message template's full content: title, body, elements and placement. |
get_experiment | Read one experiment: its type, status, variants, traffic allocation and targeting. |
get_experiment_metrics | Get a metrics report across several experiments or campaigns as rows of comma-separated values. |
get_experiment_totals | Read lifetime send and conversion totals for every variant in an experiment. |
get_experiment_trends | Read an experiment's per-variant metrics as a time series, with the holdout group reported separately. |
get_in_app_template | Read one in-app template's full content: HTML, display settings, inbox metadata and expiry. |
get_list_size | Count the users on a list without reading them. |
get_list_users | Read every user on a list as email addresses, or user IDs when prefer_user_id is true. |
get_metadata_value | Read one key's stored JSON value from a metadata table. |
get_priority_in_app_message | Read the single most relevant in-app message waiting for one user. |
get_push_template | Read one push template's full content: title, message, deep links, buttons and payload. |
get_sms_template | Read one SMS template's full content: message body, image and link settings. |
get_snippet | Read one snippet by its numeric ID or its name. |
get_template_by_client_id | Find 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_email | Read one user profile by email address, including every custom data field. |
get_user_by_user_id | Read one user profile by user ID, including every custom data field. |
list_campaigns | List campaigns in the project, with optional state filter and sort. |
list_catalog_items | List a catalog's items with their stored fields, optionally ordered by a typed field. |
list_catalogs | List the project's catalog names. |
list_channels | List the project's message channels and whether each is Marketing or Transactional. |
list_child_campaigns | List the individual sends a recurring campaign has generated. |
list_embedded_messages | List the embedded messages waiting for one user, grouped by placement. |
list_experiment_variants | List an experiment's variants with the template content each sends and its share of the audience. |
list_experiments | List the project's experiments, filtered by campaign, state or start date. |
list_export_files | Read an export job's state and the files it has written, each with a signed download URL that expires after 30 minutes. |
list_export_jobs | List the project's recent export jobs with their state and size. |
list_in_app_messages | List the in-app messages waiting for one user on a mobile platform, in display priority order. |
list_journeys | List the project's journeys with their trigger events and enabled state. |
list_lists | List every list in the project with its type and size-relevant metadata. |
list_message_types | List the project's message types with their channel, subscription policy and send caps. |
list_metadata_keys | List the keys in one metadata table, without their values. |
list_metadata_tables | List the project's metadata tables. |
list_sent_messages | List the messages Iterable has sent to one user, with campaign, date and channel filters. |
list_snippets | List the project's snippets with their content and variables. |
list_templates | List the project's templates with their IDs, names and message types, filtered by type, channel or creation date. |
list_user_events | Read one user's recent events, newest first, identified by email or user_id. |
list_user_fields | List every user-profile field defined in the project and its data type. |
list_web_in_app_messages | List the in-app messages waiting for one user in the browser. |
list_webhooks | List the project's system webhooks with their endpoints, authentication and scope. |
preview_email_template | Render an email template against sample data and return the HTML, without sending anything. |
preview_in_app_template | Render an in-app template against sample data and return the HTML, without sending anything. |
preview_list_users | Read a random sample of up to 5000 users on a list. |
validate_credential | Validate the Iterable API key with a lightweight project lookup. |
view_email_in_browser | Fetch the rendered HTML of an email already sent to a user, with that recipient's merge data applied. |
Write (23)
Create or send data.
| Tool | What it does |
|---|---|
begin_sms_verification | Send a verification code by SMS to a phone number. |
check_sms_verification | Check a verification code against the number begin_sms_verification sent it to. |
create_campaign | Create a blast or triggered campaign from an existing template, in Ready state so it sends nothing until scheduled. |
create_catalog | Create an empty catalog. |
create_experiment | Attach a new experiment to a campaign, choosing what it varies. |
create_experiment_variant | Add a variant to an experiment by copying an existing template into it. |
create_list | Create a static list. |
create_snippet | Create a snippet. |
send_email_template_proof | Send a real test email rendered from a template to one recipient. |
send_in_app_template_proof | Send a real test in-app message rendered from a template to one recipient. |
send_push_template_proof | Send a real test push notification rendered from a template to one recipient. |
send_sms_template_proof | Send a real test SMS rendered from a template to one recipient. |
start_export | Queue a background export of events or user profiles and return its job_id. |
subscribe_to_double_opt_in | Send a user an SMS confirmation and subscribe them to the named message types once they reply. |
subscribe_to_list | Add users to a static list, creating profiles for identifiers that do not exist yet. |
subscribe_user_to_group | Subscribe one user to a list, message type or channel. |
track_bulk_events | Record many custom events in one request. |
track_embedded_message_click | Record a click on an embedded message, creating an embeddedClick event. |
track_embedded_message_received | Record that a device retrieved an embedded message, creating an embeddedReceived event. |
track_embedded_message_session | Record a viewing session and one impression per embedded message seen during it, creating an embeddedSession event and an embeddedImpression event each. |
track_event | Record one custom event against a user profile. |
trigger_campaign | Fire a triggered campaign at the members of one or more lists. |
trigger_journey | Enrol one user, or every member of a list, in a journey. |
Delete or overwrite (54)
Remove or replace existing data.
| Tool | What it does |
|---|---|
abort_campaign | Abort a campaign that is currently sending. |
activate_triggered_campaign | Activate a triggered campaign so it can fire. |
archive_campaigns | Archive one or more campaigns, hiding them from the Campaigns page. |
bulk_create_catalog_items | Create or overwrite up to 1000 catalog items in one request. |
bulk_delete_catalog_items | Delete several items from a catalog in one request. |
bulk_delete_templates | Delete base templates by ID. |
bulk_update_group_subscriptions | Subscribe or unsubscribe many users to or from one list, message type or channel. |
bulk_update_user_subscriptions | Set list, channel and message-type subscriptions for many users in one request. |
bulk_update_users | Create or update up to 1000 user profiles in one request. |
cancel_campaign | Cancel a scheduled or recurring campaign so it does not send. |
cancel_email | Cancel a scheduled email before it is delivered. |
cancel_experiment | Stop a running experiment without choosing a winner. |
cancel_export_job | Cancel a queued or running export job. |
cancel_in_app | Cancel a scheduled in-app message before it is delivered to the user's device. |
cancel_push | Cancel a scheduled mobile push notification before it is delivered. |
cancel_rcs | Cancel a scheduled RCS message before it is delivered. |
cancel_sms | Cancel a scheduled SMS before it is delivered. |
cancel_web_push | Cancel a scheduled browser push notification before it is delivered. |
cancel_whatsapp | Cancel a scheduled WhatsApp message before it is delivered. |
deactivate_triggered_campaign | Deactivate a triggered campaign so it stops firing. |
declare_experiment_winner | End an experiment by declaring one variant the winner, after which the campaign sends that variant to everyone. |
delete_catalog | Delete a catalog and every collection that references it. |
delete_catalog_item | Delete one item from a catalog. |
delete_experiment | Delete an experiment from its campaign. |
delete_list | Delete a list. |
delete_metadata_key | Delete one key and its value from a metadata table. |
delete_metadata_table | Delete a whole metadata table and every key in it. |
delete_snippet | Delete a snippet by its numeric ID or its name. |
patch_catalog_item | Set individual fields on a catalog item, leaving the rest as they are, creating the item if it does not exist. |
schedule_campaign | Schedule an existing campaign to send at a given time. |
set_catalog_field_mappings | Declare data types for a catalog's fields so they can be sorted and filtered on. |
set_metadata_value | Create or REPLACE one key's JSON value, creating the table if it does not exist. |
start_experiment | Start an experiment so it begins allocating traffic across its variants. |
track_purchase | Record a completed purchase against a user profile, creating the profile if it does not exist. |
unsubscribe_from_list | Remove users from a list. |
unsubscribe_user_from_group | Unsubscribe one user from a list, message type or channel. |
update_cart | Replace the items in a user's shopping cart, creating the profile if it does not exist. |
update_email_template | Update one existing email template by ID. |
update_embedded_template | Update one existing embedded-message template by ID. |
update_experiment_settings | Change how an experiment splits traffic and picks a winner. |
update_in_app_template | Update one existing in-app template by ID. |
update_push_template | Update one existing push template by ID. |
update_sms_template | Update one existing SMS template by ID. |
update_user | Create or update one user profile, merging the fields given into whatever is already stored. |
update_user_email | Move a user profile to a new email address. |
update_user_subscriptions | Set one user's list, channel and message-type subscriptions. |
update_webhook | Change an existing webhook's endpoint, authentication, scope or enabled state. |
upsert_catalog_item | Create a catalog item, or REPLACE an existing one entirely — fields left out of value are removed. |
upsert_email_template | Create an email template, or update every template sharing the client_template_id. |
upsert_embedded_template | Create an embedded-message template, or update every template sharing the client_template_id. |
upsert_in_app_template | Create an in-app template, or update every template sharing the client_template_id. |
upsert_push_template | Create a push template, or update every template sharing the client_template_id. |
upsert_sms_template | Create 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_snippet | Create or update a snippet by name, or update one by numeric ID. |