Docs
Toolkits
Reference
Cookbooks
Search
⌘
K
Ask AI
⌘
I
Playground
All Toolkits
Iterable
ITERABLE
Latest version
00000000_00
Cross-channel marketing platform for creating, executing, and optimizing campaigns
Copy page
Authentication Details
API Key
Tools (116)
Abort Campaign
ITERABLE_ABORT_CAMPAIGN
Activate a triggered campaign
ITERABLE_ACTIVATE_TRIGGERED_CAMPAIGN
Archive Campaigns
ITERABLE_ARCHIVE_CAMPAIGNS
Bulk Update Users
ITERABLE_BULK_UPDATE_USERS
Cancel Campaign
ITERABLE_CANCEL_CAMPAIGN
Cancel Email
ITERABLE_CANCEL_EMAIL
Cancel Export
ITERABLE_CANCEL_EXPORT
Cancel In-App Message
ITERABLE_CANCEL_IN_APP
Cancel Push
ITERABLE_CANCEL_PUSH
Cancel Web Push
ITERABLE_CANCEL_WEB_PUSH
Cancel WhatsApp
ITERABLE_CANCEL_WHATS_APP
Create a new campaign
ITERABLE_CREATE_CAMPAIGN
Create a catalog
ITERABLE_CREATE_CATALOG
Create Catalog Items
ITERABLE_CREATE_CATALOG_ITEMS
Create a new list
ITERABLE_CREATE_LIST
Create snippet
ITERABLE_CREATE_SNIPPET
Deactivate Triggered Campaign
ITERABLE_DEACTIVATE_TRIGGERED_CAMPAIGN
Bulk delete templates
ITERABLE_DELETE_BULK_TEMPLATES
Delete a catalog
ITERABLE_DELETE_CATALOG
Delete a Catalog Item
ITERABLE_DELETE_CATALOG_ITEM
Delete Catalog Items
ITERABLE_DELETE_CATALOG_ITEMS
Delete a list
ITERABLE_DELETE_LIST
Delete Metadata Table
ITERABLE_DELETE_METADATA_TABLE
Delete snippet
ITERABLE_DELETE_SNIPPET
Delete User By ID
ITERABLE_DELETE_USER_BY_ID
Export data to CSV
ITERABLE_EXPORT_DATA_CSV
Export Campaign Data to JSON
ITERABLE_EXPORT_DATA_JSON
Export User Events
ITERABLE_EXPORT_USER_EVENTS
Forget User
ITERABLE_FORGET_USER
Get campaign by ID
ITERABLE_GET_CAMPAIGN
Get Campaign Metrics
ITERABLE_GET_CAMPAIGN_METRICS
Get Catalog Field Mappings
ITERABLE_GET_CATALOG_FIELD_MAPPINGS
Get catalog item by ID
ITERABLE_GET_CATALOG_ITEM
Get email template by ID
ITERABLE_GET_EMAIL_TEMPLATE
Get Embedded Messages
ITERABLE_GET_EMBEDDED_MESSAGES
Get Embedded Template
ITERABLE_GET_EMBEDDED_TEMPLATE
Get Experiment Metrics
ITERABLE_GET_EXPERIMENT_METRICS
Get In-App Messages
ITERABLE_GET_IN_APP_MESSAGES
Get in-app template by ID
ITERABLE_GET_IN_APP_TEMPLATE
Get List Size
ITERABLE_GET_LIST_SIZE
Get push template by ID
ITERABLE_GET_PUSH_TEMPLATE
Get SMS template
ITERABLE_GET_SMS_TEMPLATE
Get snippet by ID or name
ITERABLE_GET_SNIPPET
Get template by client template ID
ITERABLE_GET_TEMPLATE_BY_CLIENT_ID
Get User By ID
ITERABLE_GET_USER_BY_ID
Get User By ID (Path)
ITERABLE_GET_USER_BY_ID_PATH
Get User Events
ITERABLE_GET_USER_EVENTS
Get User Sent Messages
ITERABLE_GET_USER_SENT_MESSAGES
Get Web In-App Messages
ITERABLE_GET_WEB_IN_APP_MESSAGES
List all campaigns
ITERABLE_LIST_CAMPAIGNS
List Catalog Items
ITERABLE_LIST_CATALOG_ITEMS
List Catalogs
ITERABLE_LIST_CATALOGS
List Channels
ITERABLE_LIST_CHANNELS
List export files
ITERABLE_LIST_EXPORT_FILES
List Export Jobs
ITERABLE_LIST_EXPORT_JOBS
List Forgotten User IDs
ITERABLE_LIST_FORGOTTEN_USER_IDS
List Journeys
ITERABLE_LIST_JOURNEYS
List Lists
ITERABLE_LIST_LISTS
List List Users
ITERABLE_LIST_LIST_USERS
List Message Types
ITERABLE_LIST_MESSAGE_TYPES
List Metadata Keys
ITERABLE_LIST_METADATA_KEYS
List Metadata Tables
ITERABLE_LIST_METADATA_TABLES
List recurring campaign child campaigns
ITERABLE_LIST_RECURRING_CHILD_CAMPAIGNS
List Snippets
ITERABLE_LIST_SNIPPETS
List all templates
ITERABLE_LIST_TEMPLATES
List User Fields
ITERABLE_LIST_USER_FIELDS
List Webhooks
ITERABLE_LIST_WEBHOOKS
Merge Users
ITERABLE_MERGE_USERS
Preview email template
ITERABLE_PREVIEW_EMAIL_TEMPLATE
Preview in-app template
ITERABLE_PREVIEW_IN_APP_TEMPLATE
Preview List Users
ITERABLE_PREVIEW_LIST_USERS
Replace Catalog Item
ITERABLE_REPLACE_CATALOG_ITEM
Replace Metadata Item
ITERABLE_REPLACE_METADATA_ITEM
Schedule Campaign
ITERABLE_SCHEDULE_CAMPAIGN
Send Campaign
ITERABLE_SEND_CAMPAIGN
Send email template proof
ITERABLE_SEND_EMAIL_PROOF
Send in-app notification to target
ITERABLE_SEND_IN_APP
Send in-app template proof
ITERABLE_SEND_IN_APP_PROOF
Send push to target
ITERABLE_SEND_PUSH
Send push template proof
ITERABLE_SEND_PUSH_PROOF
Send SMS template proof
ITERABLE_SEND_SMS_PROOF
Send WhatsApp to target
ITERABLE_SEND_WHATS_APP
Start Export
ITERABLE_START_EXPORT
Subscribe to List
ITERABLE_SUBSCRIBE_TO_LIST
Subscribe User By ID
ITERABLE_SUBSCRIBE_USER_BY_ID
Track Embedded Click
ITERABLE_TRACK_EMBEDDED_CLICK
Track Embedded Received
ITERABLE_TRACK_EMBEDDED_RECEIVED
Track Embedded Session
ITERABLE_TRACK_EMBEDDED_SESSION
Track Event
ITERABLE_TRACK_EVENT
Track Events in Bulk
ITERABLE_TRACK_EVENTS_BULK
Track Purchase
ITERABLE_TRACK_PURCHASE
Trigger Campaign
ITERABLE_TRIGGER_CAMPAIGN
Trigger Journey
ITERABLE_TRIGGER_JOURNEY
Unforget User
ITERABLE_UNFORGET_USER
Unsubscribe from list
ITERABLE_UNSUBSCRIBE_FROM_LIST
Unsubscribe User By ID
ITERABLE_UNSUBSCRIBE_USER_BY_ID
Update Shopping Cart
ITERABLE_UPDATE_CART
Update Catalog Field Mappings
ITERABLE_UPDATE_CATALOG_FIELD_MAPPINGS
Update Catalog Item
ITERABLE_UPDATE_CATALOG_ITEM
Update email template
ITERABLE_UPDATE_EMAIL_TEMPLATE
Update Embedded Template
ITERABLE_UPDATE_EMBEDDED_TEMPLATE
Update in-app template
ITERABLE_UPDATE_IN_APP_TEMPLATE
Update push template
ITERABLE_UPDATE_PUSH_TEMPLATE
Update SMS template
ITERABLE_UPDATE_SMS_TEMPLATE
Update snippet by ID or name
ITERABLE_UPDATE_SNIPPET
Update User
ITERABLE_UPDATE_USER
Update User Email
ITERABLE_UPDATE_USER_EMAIL
Update User Subscriptions
ITERABLE_UPDATE_USER_SUBSCRIPTIONS
Bulk Update User Subscriptions
ITERABLE_UPDATE_USER_SUBSCRIPTIONS_BULK
Update Webhook
ITERABLE_UPDATE_WEBHOOK
Upsert email template
ITERABLE_UPSERT_EMAIL_TEMPLATE
Upsert Embedded Template
ITERABLE_UPSERT_EMBEDDED_TEMPLATE
Upsert in-app template
ITERABLE_UPSERT_IN_APP_TEMPLATE
Upsert push template
ITERABLE_UPSERT_PUSH_TEMPLATE
Upsert SMS template
ITERABLE_UPSERT_SMS_TEMPLATE
Verify SMS Code
ITERABLE_VERIFY_SMS_CODE
Edit this page on GitHub