Skip to main content
Iterable
Iterable
68 actions · 1 auth method
PreviewMarketingCampaignsMessagingCatalogsCommerceTrackingEmailTemplatesContentEventsAnalyticsAudienceSegmentationSubscriptionsUsersAutomation

​
Authentication

API Key

You need an Iterable account with permissions to create API keys. Generate a server-side API key in the Iterable web app…Guides: Connector Profile, Link Account
Actions
68 actions
Action
Description
List Campaign Metadata
List campaign metadata
Get A Campaign
Get a campaign
Create A Campaign
Create a campaign
Archive Campaigns
Archive campaigns
Get The Catalog Items For A Catalog
Get the catalog items for a catalog
Get Catalog Names
Get catalog names
Get A Specific Catalog Item
Get a specific catalog item
Get Field Mappings For A Catalog
Get field mappings for a catalog
Create A Catalog
Create a catalog
Bulk Create Or Update Catalog Items
Bulk create or update catalog items
Set A Catalog’s Field Mappings (data Types)
Set a catalog’s field mappings (data types)
Bulk Delete Catalog Items
Bulk delete catalog items
Delete A Catalog
Delete a catalog
Delete A Catalog Item
Delete a catalog item
Create Or Replace A Catalog Item
Create or replace a catalog item
Create Or Update A Catalog Item
Create or update a catalog item
Update A User’s Shopping Cart Items
Update a user’s shopping cart items
Track A Purchase
Track a purchase
Send An Email To An Email Address
Send an email to an email address
Get An Email Template By TemplateId
Get an email template by templateId
Update Email Template
Update email template
Create Email Template
Create email template
Track An Event
Track an event (requires either email or userId)
Get Export Job Files
Get the downloadable files for an export job
Get Export Jobs
Get export jobs
Cancel Export Job
Stop a queued or running export job by jobId
Export Data To CSV
Export data to CSV (response is raw text/csv, not JSON)
Export Data To JSON
Export data to JSON (response is raw NDJSON text, not a JSON object)
Export User Events
Export user events
Start Export
Start export
Send An In-app Notification To A User
Send an in-app notification to a user (requires a Running In-App campaign)
Get Count Of Users In List
Get count of users in list
Get Lists
Get lists
Get Users In A List
Get users in a list (returns NDJSON text)
Preview Users In A List
Preview users in a list (returns CSV text)
Create A Static List
Create a static list
Delete A List
Delete a list
Add Subscribers To List
Add subscribers to list
Remove Users From A List
Remove users from a list
Send Push Notification To User
Send push notification to user
Send SMS Notification To User
Send SMS notification to user
Bulk Subscription Action On A List Of Users
Bulk subscription action on a list of users
Subscribe A Single User
Subscribe a single user
Subscribe A Single User By Their UserId
Subscribe a single user by their userId
Unsubscribe A Single User
Unsubscribe a single user
Unsubscribe A Single User By UserId
Unsubscribe a single user by userId
Get An Email Template By ClientTemplateId
Get an email template by clientTemplateId
Get Project Templates
Get project templates
Bulk Delete Templates
Bulk delete templates
Get Messages Sent To A User
Get messages sent to a user (one of email or userId is required)
Get A User By Email (query Parameter)
Get a user by email (query parameter)
Get A User By Email (path Parameter)
Get a user by email (path parameter)
Get A User By UserId (query Parameter)
Get a user by userId (query parameter)
Get A User By UserId (path Parameter)
Get a user by userId (path parameter)
Get All User Fields
Get all user fields
Bulk Update User Subscriptions
Bulk update user subscriptions
Bulk Update User Data
Bulk update user data
Update User Email
Update user email
Update User Subscriptions
Update user subscriptions
Update User Data
Update user data
Delete A User By Email
Delete a user by email (asynchronous)
Delete User By UserId
Delete user by userId
Get Hashed Forgotten Users In Compliance With GDPR
Get hashed forgotten users in compliance with GDPR
Forget A User In Compliance With GDPR
Forget a user in compliance with GDPR
Merge Users
Merge users
Unforget A User In Compliance With GDPR
Unforget a user in compliance with GDPR
Get Journeys (workflows)
Get journeys (workflows)
Trigger A Journey (workflow)
Trigger a journey (workflow)

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See the Projects Guide.
2

Configure the Connector

Enable the connector and set up a connector profile in your project. See Managing Connectors.
https://stackone-logos.com/api/iterable/filled/png

Connector Profile

Iterable - API Key
3

Link an Account

Connect an account using StackOne Hub or Auth Link.
https://stackone-logos.com/api/iterable/filled/png

Link Account

Iterable - API Key
4

Use Actions

Invoke actions using one of the methods below: