Articles in this section

Available Iterable APIs

When you configure an export, import, other type of flow step using the prebuilt Iterable connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Iterable API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource

API endpoint

Export

Import

Campaigns

List campaign metadata

X

Abort a campaign

X

Activate a triggered campaign

X

Archive campaigns

X

Cancel a scheduled or recurring campaign

X

Create a campaign

X

Deactivate a triggered campaign

X

Get metrics for campaigns

X

Get child campaigns of a recurring campaign

X

Trigger a campaign

X

Schedule existing campaign to be sent

X

Send existing campaign now

X

Get a campaign

X

Catalogs

Get catalog names

X

Delete a catalog

X

Create a catalog

X

Get field mappings for a catalog

X

Set a catalog's field mappings (data types)

X

Bulk delete catalog items

X

Get the catalog items for a catalog

X

Bulk create catalog items

X

Delete a catalog item

X

Get a specific catalog item

X

Create or update a catalog item

X

Create or replace a catalog item

X

Channels

Get channels

X

Commerce

Track a purchase

X

Update a user's shopping cart items

X

Email

Cancel an email to a user

X

Send an email to an email address

X

View a previously sent email

X

Embedded messaging

Get a user's embedded messages

X

Events

Track an embedded message click

X

Track an embedded message received event

X

Track an embedded message session and related impressions

X

Get user events by user ID

X

Consume or delete an in-app message

X

Track an event

X

Bulk track events

X

Track an in-app message click

X

Track the closing of an in-app message

X

Track the delivery of an in-app message

X

Track an in-app message open

X

Track a mobile push open

X

Track a web push click

X

Get user events

X

Experiments

Get metrics for experiments

X

Export

Export data to CSV

X

Export data to JSON

X

Get export jobs

X

Start export

X

Export user events

X

Cancel export

X

Get export files

X

In-app

Cancel a scheduled in-app message

X

Get a user's in-app messages

X

Get a user's most relevant in-app message

X

Send an in-app notification to a user

X

In-app-web

Get a user's web in-app messages

X

Lists

Get lists

X

Create a static list

X

Get users in a list

X

Preview users in a list

X

Add subscribers to list

X

Remove users from a list

X

Delete a list

X

Get count of users in list

X

Message types

List message types

X

Metadata

List available tables

X

Delete a table

X

List keys in a table

X

Delete a single metadata key/value

X

Get the metadata value of a single key

X

Create or replace metadata

X

Push

Cancel a push notification to a user

X

Send push notification to user

X

Sms

Cancel an SMS to a user

X

Send SMS notification to user

X

Snippets

Get all snippets

X

Create a snippet

X

Delete a snippet

X

Get snippet by ID or name

X

Create or update a snippet

X

Subscriptions

Trigger a double opt-in subscription flow

X

Bulk subscription action on a list of users

X

Unsubscribe a single user by user ID

X

Subscribe a single user by their user ID

X

Unsubscribe a single user

X

Subscribe a single user

X

Templates

Get project templates

X

Bulk delete templates

X

Get an email template by template ID

X

Preview email template with custom data

X

Send a proof of an email template

X

Update email template

X

Create email template

X

Get an embedded message template

X

Update embedded message template

X

Create an embedded message template

X

Get an email template by client template ID

X

Get an in-app template

X

Preview in-app template with custom data

X

Send a proof of an in-app template

X

Update in-app template

X

Create an in-app template

X

Get a push template

X

Send a proof of a push template

X

Update push template

X

Create a push template

X

Get an SMS template

X

Send a proof of an SMS template

X

Update SMS template

X

Create an SMS template

X

Users

Bulk update user data

X

Bulk update user subscriptions

X

Get a user by user ID (query parameter)

X

Delete user by user ID

X

Get a user by user ID (path parameter)

X

Disable pushes to a mobile device

X

Forget a user in compliance with GDPR

X

Get hashed forgotten users in compliance with GDPR

X

Get hashed forgotten user IDs in compliance with GDPR

X

Get a user by email (query parameter)

X

Get all user fields

X

Get messages sent to a user

X

Merge users

X

Register a browser token for web push

X

Register a device token for push

X

Unforget a user in compliance with GDPR

X

Update user data

X

Update user email

X

Update user subscriptions

X

Delete a user by email

X

Get a user by email (path parameter)

X

Verify

Begin SMS verification

X

Check SMS verification code

X

Web push

Cancel a web push notification to a user

X

Send web push notification to user

X

Webhooks

Get webhooks

X

Update webhook

X

WhatsApp

Cancel a scheduled WhatsApp message

X

Send a WhatsApp message to a user

X

Workflows

Get journeys (workflows)

X

Trigger a journey (workflow)

X