# Iterable integration

> Cross-channel marketing platform API: users, lists, campaigns, journeys, templates, catalogs, events, and message sends over email, push, SMS, in-app, web push, WhatsApp and RCS.

- Authentication: apiKey

## Tools (148)

- **Abort a campaign**: Abort a campaign given a campaign ID
- **Activate a triggered campaign**: Activate a triggered campaign given a campaign ID
- **Add subscribers to list**: Add specific subscribers to a list.
- **Archive campaigns**: Archives one or more campaigns, like the UI archive feature.
- **Begin SMS Verification**: Sends an SMS verification code to a phone number.
- **Bulk create catalog items**: Asynchronous. Create up to 1000 catalog items in one request.
- **Bulk delete catalog items**: Asynchronous. Delete the specified catalog items from the catalog.
- **Bulk delete templates**: Deletes one or more base templates not attached to a campaign.
- **Bulk subscription action on a list of users**: Subscribes or unsubscribes multiple users to a subscription group.
- **Bulk track events**: Track multiple custom events in one request (asynchronous).
- **Bulk update user data**: Bulk updates user data, adding and overwriting profile fields.
- **Bulk update user subscriptions**: Bulk updates user subscriptions; overwrites non-null fields.
- **Cancel an email to a user**: Cancels a scheduled email to a specific user.
- **Cancel an experiment**: Cancels a running or winner_found campaign experiment without declaring a winner.
- **Cancel an SMS to a user**: Cancels a scheduled SMS to a specific user.
- **Cancel a push notification to a user**: Cancels a scheduled push notification to a specific user.
- **Cancel a scheduled in-app message**: Cancels a scheduled in-app message to a specific user.
- **Cancel a scheduled or recurring campaign**: Cancel a campaign given a campaign ID
- **Cancel a scheduled RCS message**: Cancels a scheduled RCS message to a specific user.
- **Cancel a scheduled WhatsApp message**: Cancels a scheduled WhatsApp message to a specific user.
- **Cancel a web push notification to a user**: Cancels a scheduled web push notification to a specific user.
- **Cancel export**: Cancel a queued or running export.
- **Check SMS Verification Code**: Checks an SMS verification code against the latest pending code for a phone number.
- **Copy a template as a new variant**: Copies a template into a new variant on a draft or ready campaign experiment.
- **Create a campaign**: Creates a new blast or triggered campaign from an existing template.
- **Create a catalog**: Create a catalog with a unique name.
- **Create an embedded message template**: Create an embedded message template, or update all matching the clientTemplateId.
- **Create an experiment**: Creates a draft content experiment on a campaign.
- **Create an in-app template**: Create an in-app template, or update all matching the clientTemplateId.
- **Create an SMS template**: Create an SMS template, or update all matching the clientTemplateId.
- **Create a push template**: Create a push template, or update all matching the clientTemplateId.
- **Create a snippet**: Create a new snippet.
- **Create a static list**: Create a new static list.
- **Create email template**: Create an email template, or update all email templates matching the clientTemplateId.
- **Create or replace a catalog item**: Asynchronous. Create or replace the specified catalog item.
- **Create or replace metadata**: Asynchronous. Creates or replaces the item for a metadata key.
- **Create or update a catalog item**: Asynchronous. Create or update (merge) the specified catalog item.
- **Create or update a snippet**: Create or update a snippet by ID or name.
- **Deactivate a triggered campaign**: Deactivate a triggered campaign given a campaign ID
- **Declare a winner and end experiment**: Declares a variant the winner of a running experiment and ends it.
- **Delete a catalog**: Delete the catalog with the specified name, including collections that reference it.
- **Delete a catalog item**: Asynchronous. Deletes the specified item from the catalog.
- **Delete a list**: Delete a list by listId.
- **Delete an experiment**: Deletes a draft or ready campaign experiment and returns it as it was before deletion.
- **Delete a single metadata key/value**: Asynchronous. Deletes the specified item from a metadata table.
- **Delete a snippet**: Delete a snippet by ID or name.
- **Delete a table**: Asynchronous. Deletes a metadata table.
- **Delete a user by email**: Asynchronous. Deletes a user by email without blocking future data collection.
- **Delete user by userId**: Asynchronous. Deletes a user by userId without blocking future data collection.
- **Export data to CSV**: Export campaign analytics data in CSV format.
- **Export data to JSON**: Export campaign analytics data as JSON, one entry per line.
- **Export user events**: Export all events for a user as JSON, one per line.
- **Forget a user in compliance with GDPR**: Deletes a user's data and prevents future data collection about them.
- **Get a campaign**: Get a campaign by ID.
- **Get all snippets**: Get all snippets for the current project.
- **Get all user fields**: Get all user fields within a project.
- **Get an email template by clientTemplateId**: Get email templates by clientTemplateId.
- **Get an email template by templateId**: Get an email template by templateId.
- **Get an embedded message template**: Get an embedded message template by templateId.
- **Get an experiment**: Get a single experiment by ID.
- **Get an in-app template**: Get an in-app template by templateId.
- **Get an SMS template**: Get an SMS template by templateId.
- **Get a push template**: Get a push template by templateId.
- **Get a specific catalog item**: Get a specific catalog item from the given catalog.
- **Get a user by email (path parameter)**: Get a user by email passed as a path parameter.
- **Get a user by email (query parameter)**: Get a user by email passed as a query parameter.
- **Get a user by userId (path parameter)**: Get a user by userId passed as a path parameter.
- **Get a user by userId (query parameter)**: Get a user by userId passed as a query parameter.
- **Get a user's embedded messages**: Returns embedded messages a user is eligible for, grouped by placementId.
- **Get a user's in-app messages**: Get a user's in-app messages, optionally including app-specific ones.
- **Get a user's web in-app messages**: Get a user's web in-app messages, optionally including app-specific ones.
- **Get catalog names**: Get catalog names.
- **Get channels**: Get all message channels within the project.
- **Get child campaigns of a recurring campaign**: Get child campaigns generated by a recurring campaign.
- **Get count of users in list**: Get the number of users within a list.
- **Get experiment totals**: Lifetime send and conversion totals per variant of a campaign experiment.
- **Get experiment trends**: Histogram time series per variant of a campaign experiment.
- **Get experiment variants**: Get all variants for an experiment, including template content.
- **Get export files**: Get the status and files of an export started with Start export.
- **Get export jobs**: List recent export jobs for the current project.
- **Get field mappings for a catalog**: Field mappings (field to data types) and undefined fields of a catalog
- **Get hashed forgotten userIds in compliance with GDPR**: Returns SHA-256 hashes of userIds currently forgotten by the project.
- **Get hashed forgotten users in compliance with GDPR**: Returns SHA-256 hashes of emails currently forgotten by the project.
- **Get journeys (workflows)**: Get a list of the journeys within your project.
- **Get lists**: Get all lists within a project.
- **Get messages sent to a user**: Gets messages sent to a user, by email or userId.
- **Get metrics for campaigns**: Get metrics for a single campaign or multiple campaigns.
- **Get metrics for experiments**: Get metrics for one or more experiments (email experiments only).
- **Get project templates**: Get templates for a project, paginated.
- **Get snippet by ID or name**: Retrieve a snippet by ID or name.
- **Get the catalog items for a catalog**: Get the catalog items for a catalog.
- **Get the metadata value of a single key**: Get the metadata value of a single key.
- **Get user events**: Get events for a specific user, by email.
- **Get user events by userId**: Get events for a specific user, by userId.
- **Get users in a list**: Get all users within a list.
- **Get webhooks**: Get webhooks for a project.
- **Invalidate all JWTs issued for a user**: Invalidates all JWTs issued for a given user before the current time or a specified time.
- **List available tables**: List available metadata tables.
- **List campaign metadata**: Get metadata about campaigns in a project, paginated.
- **List experiments**: List experiments, filterable by campaign, state, and date range.
- **List keys in a table**: List keys in a metadata table.
- **List message types**: List all message types within a project.
- **Merge users**: Merge a source user into a destination user.
- **Preview email template with custom data**: Render an HTML preview of an email template using custom data fields and data feed data.
- **Preview in-app template with custom data**: Render an HTML preview of an in-app template using custom data.
- **Preview users in a list**: Get a random sample of up to 5000 users within a list.
- **Remove users from a list**: Remove specific users from a list.
- **Schedule existing campaign to be sent**: Schedule existing campaign to be sent
- **Send an email to an email address**: Send a campaign email to a specific recipient.
- **Send an in-app notification to a user**: Send an in-app notification to a specific user.
- **Send an RCS message to a user**: Send an RCS message to a specific user, optionally scheduled.
- **Send a proof of an email template**: Send a proof of an email template to a specific user.
- **Send a proof of an in-app template**: Send a proof of an in-app template to a specific user.
- **Send a proof of an SMS template**: Send a proof of an SMS template to a specific user.
- **Send a proof of a push template**: Send a proof of a push template to a specific user.
- **Send a WhatsApp message to a user**: Send a WhatsApp message to a user.
- **Send existing campaign now**: Send existing campaign now
- **Send push notification to user**: Send a push notification to a specific user.
- **Send SMS notification to user**: Send an SMS notification to a specific user (typically transactional).
- **Send web push notification to user**: Sends a web push notification to a specific user.
- **Set a catalog's field mappings (data types)**: Set a catalog's field mappings (data types); a field's type cannot change once set.
- **Start an experiment**: Starts a draft or ready campaign experiment.
- **Start export**: Start a data export as a background job.
- **Subscribe a single user**: Subscribes a user (by email) to a subscription group.
- **Subscribe a single user by their userId**: Subscribes a user (by userId) to a subscription group.
- **Track an embedded message click**: Tracks a click on an embedded message (creates an embeddedClick event).
- **Track an embedded message received event**: Tracks that an embedded message was received on a device (embeddedReceived event).
- **Track an embedded message session and related impressions**: Tracks one embeddedSession event and an embeddedImpression event per impression.
- **Track an event**: Track a custom event for a user (asynchronous).
- **Track a purchase**: Track purchase events; clears the user's shoppingCartItems and upserts the user profile.
- **Trigger a campaign**: Trigger a campaign given lists
- **Trigger a double opt-in subscription flow**: Triggers a double opt-in subscription for a user (SMS double opt-in message types).
- **Trigger a journey (workflow)**: Triggers a journey (formerly workflow) for a user or a list.
- **Unforget a user in compliance with GDPR**: Lets the project resume collecting data about a previously forgotten user.
- **Unsubscribe a single user**: Unsubscribes a user (by email) from a subscription group.
- **Unsubscribe a single user by userId**: Unsubscribes a user (by userId) from a subscription group.
- **Update a user's shopping cart items**: Update the shoppingCartItems field on a user profile.
- **Update email template**: Update an email template.
- **Update embedded message template**: Update an embedded message template.
- **Update experiment settings**: Updates settings on a draft or ready campaign experiment; only sent fields change.
- **Update in-app template**: Update an in-app template.
- **Update push template**: Update a push template.
- **Update SMS template**: Update an SMS template.
- **Update user data**: Updates user data, or adds the user if none exists; fields are merged.
- **Update user email**: Updates a user's email (email-based projects).
- **Update user subscriptions**: Updates user subscriptions; overwrites non-null fields.
- **Update webhook**: Update a webhook.
- **View a previously sent email**: View a rendered version of a previously sent email.

Connect Iterable in General Input: https://www.generalinput.com/apps/iterable