Iterable MCP Server, Iterable's official MCP server (beta)

• Shows the details of one campaign

  Get detailed information about a specific campaign. Available in the default read-only setup.

  Try: “Get details on campaign 12345”

  Read · get_campaign

• Shows a campaign's results over a date range

  Get campaign performance metrics. Requires a date range. Always use the narrowest window possible for performance. Available in the default read-only setup.

  Try: “How did campaign 12345 do last week?”

  Read · get_campaign_metrics

• Lists your campaigns

  Retrieve campaigns. Available in the default read-only setup.

  Try: “List my campaigns from this month”

  Read · get_campaigns

• Lists the campaigns a recurring campaign has created

  Get child campaigns generated by a recurring campaign. Available in the default read-only setup.

  Try: “Show the sends created by my weekly digest campaign”

  Read · get_child_campaigns

• Stops a campaign that is sending right now

  Abort a campaign that is currently running. Needs writes turned on for your key.

  Try: “Abort campaign 12345”

  Delete · abort_campaign

• Archives campaigns, cancelling or stopping any that are live

  Archive one or more campaigns. Scheduled/recurring campaigns will be cancelled, running campaigns will be aborted. Needs writes turned on for your key.

  Try: “Archive campaigns 101 and 102”

  Delete · archive_campaigns

• Cancels a scheduled or recurring campaign

  Cancel a scheduled or recurring campaign. Needs writes turned on for your key.

  Try: “Cancel the scheduled campaign 12345”

  Delete · cancel_campaign

• Creates a one-off campaign from a template

  Create a new one-off (blast) campaign from an existing template. Needs writes turned on for your key.

  Try: “Create a campaign called 'Holiday Sale' using template 456”

  Write · create_blast_campaign

• Creates a triggered campaign from a template, ready to activate

  Create a new triggered campaign from an existing template. The campaign is created in Ready state and must be activated before it can send. Needs writes turned on for your key.

  Try: “Create a triggered welcome campaign from template 789”

  Write · create_triggered_campaign

• Turns off a triggered campaign

  Deactivate a triggered campaign (requires API triggered campaign deactivation enabled). Needs writes turned on for your key.

  Try: “Deactivate triggered campaign 789”

  Write · deactivate_triggered_campaign

• Turns on a triggered campaign so it starts sending

  Activate a triggered campaign (requires API triggered campaign activation enabled). Needs writes and sends turned on for your key.

  Try: “Activate triggered campaign 789”

  Write · activate_triggered_campaign

• Schedules a campaign to send at a set time

  Schedule an existing campaign to be sent at a specific time. Needs writes and sends turned on for your key.

  Try: “Schedule campaign 12345 for tomorrow at 9am”

  Write · schedule_campaign

• Sends a scheduled campaign right away

  Send an existing scheduled campaign immediately. Needs writes and sends turned on for your key.

  Try: “Send campaign 12345 now”

  Write · send_campaign

• Sends a campaign to the lists you name

  Trigger a campaign to send to specified lists. Needs writes and sends turned on for your key.

  Try: “Trigger campaign 12345 for the VIP list”

  Write · trigger_campaign

• Shows one email template

  Get details for specific email template by ID. Available in the default read-only setup.

  Try: “Show email template 456”

  Read · get_email_template

• Shows one in-app template

  Get details for specific in-app message template by ID. Available in the default read-only setup.

  Try: “Show in-app template 987”

  Read · get_inapp_template

• Shows one push template

  Get details for specific push notification template by ID. Available in the default read-only setup.

  Try: “Show push template 654”

  Read · get_push_template

• Shows one SMS template

  Get details for specific SMS template by ID. Available in the default read-only setup.

  Try: “Show SMS template 321”

  Read · get_sms_template

• Finds a template by your own template ID

  Get template by client template ID. Available in the default read-only setup.

  Try: “Find the template with client ID welcome-v2”

  Read · get_template_by_client_id

• Lists your templates

  Retrieve templates. Available in the default read-only setup.

  Try: “What email templates are available?”

  Read · get_templates

• Renders an email template with sample data

  Preview email template with custom data. Returns fully rendered HTML with user, event, and/or data feed data substituted. Available in the default read-only setup.

  Try: “Preview template 456 for user@example.com”

  Read · preview_email_template

• Renders an in-app template with sample data

  Preview in-app message template with custom data. Returns fully rendered HTML with user, event, and/or data feed data substituted. Available in the default read-only setup.

  Try: “Preview in-app template 987 with this data”

  Read · preview_inapp_template

• Deletes one or more templates

  Delete one or more templates by ID. Needs writes turned on for your key.

  Try: “Delete templates 400 and 401”

  Delete · delete_templates

• Edits an existing email template

  Update existing email template by templateId. Needs writes turned on for your key.

  Try: “Change the subject of template 456”

  Write · update_email_template

• Edits an existing in-app template

  Update existing in-app message template by templateId. Needs writes turned on for your key.

  Try: “Update the button text in template 987”

  Write · update_inapp_template

• Edits an existing push template

  Update existing push notification template by templateId. Needs writes turned on for your key.

  Try: “Update the title of push template 654”

  Write · update_push_template

• Edits an existing SMS template

  Update existing SMS template by templateId. Needs writes turned on for your key.

  Try: “Shorten the text in SMS template 321”

  Write · update_sms_template

• Creates or updates an email template

  Create or update email template. If a template with the specified clientTemplateId exists, it will be updated; otherwise, a new template will be created. Needs writes turned on for your key.

  Try: “Build me an email template announcing our spring sale”

  Write · upsert_email_template

• Creates or updates an in-app template

  Create or update in-app message template. If a template with the specified clientTemplateId exists, it will be updated; otherwise, a new template will be created. Needs writes turned on for your key.

  Try: “Create an in-app template for the new feature”

  Write · upsert_inapp_template

• Creates or updates a push template

  Create or update push notification template. If a template with the specified clientTemplateId exists, it will be updated; otherwise, a new template will be created. Needs writes turned on for your key.

  Try: “Create a push template for cart reminders”

  Write · upsert_push_template

• Creates or updates an SMS template

  Create or update SMS template. If a template with the specified clientTemplateId exists, it will be updated; otherwise, a new template will be created. Needs writes turned on for your key.

  Try: “Create an SMS template for order shipped”

  Write · upsert_sms_template

• Sends a test email of a template to one person

  Send a proof of a email template to a specific user. Needs customer data (PII) access and writes and sends turned on for your key.

  Try: “Send me a proof of template 456”

  Write · send_email_template_proof

• Sends a test in-app message of a template to one person

  Send a proof of a in-app message template to a specific user. Needs customer data (PII) access and writes and sends turned on for your key.

  Try: “Send me a proof of in-app template 987”

  Write · send_inapp_template_proof

• Sends a test push of a template to one person

  Send a proof of a push notification template to a specific user. Needs customer data (PII) access and writes and sends turned on for your key.

  Try: “Send me a proof of push template 654”

  Write · send_push_template_proof

• Sends a test text of a template to one person

  Send a proof of a SMS template to a specific user. Needs customer data (PII) access and writes and sends turned on for your key.

  Try: “Send me a proof of SMS template 321”

  Write · send_sms_template_proof

• Lists your journeys, filtered by state if you like

  Get journeys (workflows) with optional pagination and state filtering. Available in the default read-only setup.

  Try: “What journeys are currently active?”

  Read · get_journeys

• Starts a journey for one user

  Trigger a journey (workflow) for a user. Needs customer data (PII) access and writes and sends turned on for your key.

  Try: “Start the onboarding journey for user@example.com”

  Write · trigger_journey

• Previews up to 5,000 users in a list

  Preview users in a list (up to 5000 users). Needs customer data (PII) access turned on for your key.

  Try: “Preview who is on the trial list”

  Read · get_list_preview_users

• Counts the users in a list

  Get the count of users in a specific list. Available in the default read-only setup.

  Try: “How many people are on the VIP list?”

  Read · get_list_size

• Lists the users in a list

  Get users in a specific list. Needs customer data (PII) access turned on for your key.

  Try: “List users in my 'VIP Customers' list”

  Read · get_list_users

• Lists your user lists

  Retrieve user lists. Available in the default read-only setup.

  Try: “Show all my lists”

  Read · get_lists

• Creates a new user list

  Create a new user list. Needs writes turned on for your key.

  Try: “Create a list called Webinar Attendees”

  Write · create_list

• Deletes a user list

  Delete a user list. Needs writes turned on for your key.

  Try: “Delete the old test list”

  Delete · delete_list

• Adds users to a list

  Subscribe users to a specific list. Needs customer data (PII) access and writes turned on for your key.

  Try: “Add these 20 emails to the Webinar Attendees list”

  Write · subscribe_to_list

• Removes users from a list

  Unsubscribe users from a specific list. Needs customer data (PII) access and writes turned on for your key.

  Try: “Remove user@example.com from the VIP list”

  Delete · unsubscribe_from_list

• Lists the messages sent to one user

  Get messages sent to a specific user with optional filtering. Needs customer data (PII) access turned on for your key.

  Try: “What have we sent user@example.com this month?”

  Read · get_sent_messages

• Shows a user's profile by email

  Get user profile information by email address. Needs customer data (PII) access turned on for your key.

  Try: “Look up user@example.com”

  Read · get_user_by_email

• Shows a user's profile by user ID

  Get user profile information by user ID. Needs customer data (PII) access turned on for your key.

  Try: “Look up user 42”

  Read · get_user_by_user_id

• Lists all user profile fields and their types

  Get all user profile field definitions and their types. Available in the default read-only setup.

  Try: “What profile fields do we store?”

  Read · get_user_fields

• Updates many user profiles at once

  Update multiple users at once. Needs customer data (PII) access and writes turned on for your key.

  Try: “Set region to EU for these 100 users”

  Write · bulk_update_users

• Deletes a user by email

  Delete a user by email address (asynchronous - does not prevent future data collection). Needs customer data (PII) access and writes turned on for your key.

  Try: “Delete the user test@example.com”

  Delete · delete_user_by_email

• Deletes a user by user ID

  Delete a user by user ID (asynchronous - does not prevent future data collection, deletes all users with same userId). Needs customer data (PII) access and writes turned on for your key.

  Try: “Delete user 42”

  Delete · delete_user_by_user_id

• Changes a user's email address

  Update a user's email address (only use with email-based projects; for userId/hybrid projects, use update_user instead). Needs customer data (PII) access and writes turned on for your key.

  Try: “Change user@example.com to new@example.com”

  Write · update_email

• Updates a user's profile fields

  Update user profile information (accepts email OR userId in params). Needs customer data (PII) access and writes turned on for your key.

  Try: “Set plan to pro for user@example.com”

  Write · update_user

• Overwrites a user's subscription settings

  Update user subscriptions (IMPORTANT: overwrites existing data for any non-null fields specified). Needs customer data (PII) access and writes turned on for your key.

  Try: “Set user 42's subscriptions to newsletter only”

  Write · update_user_subscriptions

• Shows a user's event history by email

  Get event history for a user by email address. Needs customer data (PII) access turned on for your key.

  Try: “Show me events for user@example.com from the last 30 days”

  Read · get_user_events_by_email

• Shows a user's event history by user ID

  Get event history for a user by user ID. Needs customer data (PII) access turned on for your key.

  Try: “Show events for user 42”

  Read · get_user_events_by_user_id

• Records many custom events at once

  Track multiple events in a single request for better performance. Needs customer data (PII) access and writes and sends turned on for your key.

  Try: “Track these 100 signup events”

  Write · track_bulk_events

• Records a custom event for a user

  Track a custom event for a user. Needs customer data (PII) access and writes and sends turned on for your key.

  Try: “Track a 'webinar_attended' event for user@example.com”

  Write · track_event

• Shows one experiment and its variants

  Get detailed information about a specific experiment by ID, including variants summary and constraints. Available in the default read-only setup.

  Try: “Show experiment 77”

  Read · get_experiment

• Shows A/B test results for an email experiment

  Get experiment metrics for A/B testing analysis (currently supports email experiments only). Available in the default read-only setup.

  Try: “Which subject line is winning in experiment 77?”

  Read · get_experiment_metrics

• Shows lifetime sends and conversions for an experiment

  Get lifetime send and conversion totals for a campaign experiment. Holdout is omitted, missing counts are 0, and lift and confidence are not included. Available in the default read-only setup.

  Try: “Total sends and conversions for experiment 77”

  Read · get_experiment_totals

• Shows an experiment's results over time

  Get the performance time series for a campaign experiment. Provide both startDateTime and endDateTime, or omit both to use the run window. The span is at most 31 days; a longer default window is clipped to the last 31 days. Available in the default read-only setup.

  Try: “Show the daily trend for experiment 77”

  Read · get_experiment_trends

• Shows each variant's subject, preheader and content

  Get variant content for an experiment, including subject lines, preheaders, HTML source, and plain text. Available in the default read-only setup.

  Try: “Show me the variants in experiment 77”

  Read · get_experiment_variants

• Lists your A/B experiments

  List experiments with optional filtering by campaign, status, and date range. Supports pagination. Available in the default read-only setup.

  Try: “List experiments running this month”

  Read · list_experiments

• Cancels an experiment without picking a winner

  Cancel a running or winner_found campaign experiment without declaring a winner. Needs writes turned on for your key.

  Try: “Cancel experiment 77”

  Delete · cancel_experiment

• Adds a template as a new variant to an experiment

  Copy a template into a new variant on a draft or ready campaign experiment. Needs writes turned on for your key.

  Try: “Add template 457 as a variant to experiment 77”

  Write · copy_experiment_variant

• Creates a draft A/B experiment for a campaign

  Create a draft campaign experiment. The campaign template becomes the control. Needs writes turned on for your key.

  Try: “Set up a subject line test on campaign 12345”

  Write · create_experiment

• Deletes a draft or unstarted experiment

  Delete a draft, ready, or errored campaign experiment. Needs writes turned on for your key.

  Try: “Delete draft experiment 78”

  Delete · delete_experiment

• Changes settings on a draft experiment

  Update settings on a draft or ready campaign experiment. Omit a field to leave it unchanged. Needs writes turned on for your key.

  Try: “Change experiment 77 to a 50/50 split”

  Write · update_experiment_settings

• Picks the winning variant and ends the experiment

  Declare a winning variant and end a running or winner_found campaign experiment. Needs writes and sends turned on for your key.

  Try: “Declare variant B the winner of experiment 77”

  Write · declare_experiment_winner

• Starts an experiment

  Start a draft or ready campaign experiment. Needs writes and sends turned on for your key.

  Try: “Start experiment 77”

  Write · start_experiment

• Shows a catalog's fields and their data types

  Get field mappings and data types for a catalog. Available in the default read-only setup.

  Try: “What fields does the products catalog have?”

  Read · get_catalog_field_mappings

• Shows one catalog item

  Get a specific catalog item by ID. Available in the default read-only setup.

  Try: “Show item sku-123 from the products catalog”

  Read · get_catalog_item

• Lists the items in a catalog

  Get items from a catalog with optional pagination and sorting. Available in the default read-only setup.

  Try: “Show 10 items from demo-catalog”

  Read · get_catalog_items

• Lists your product catalogs

  Get list of all catalogs with optional pagination. Available in the default read-only setup.

  Try: “Show me all my product catalogs”

  Read · get_catalogs

• Deletes many catalog items at once

  Bulk delete catalog items by their IDs. Needs writes turned on for your key.

  Try: “Delete these discontinued items”

  Delete · bulk_delete_catalog_items

• Creates a new catalog

  Create a new catalog. Needs writes turned on for your key.

  Try: “Create a catalog called stores”

  Write · create_catalog

• Deletes a whole catalog

  Delete a catalog. Needs writes turned on for your key.

  Try: “Delete the old-products catalog”

  Delete · delete_catalog

• Deletes one catalog item

  Delete a specific catalog item by ID. Needs writes turned on for your key.

  Try: “Delete sku-123 from the products catalog”

  Delete · delete_catalog_item

• Updates some fields of a catalog item

  Partial update (PATCH) a catalog item - updates only specified fields. Needs writes turned on for your key.

  Try: “Set the price of sku-123 to 19.99”

  Write · partial_update_catalog_item

• Updates fields on up to 1,000 catalog items at once

  Bulk partial update catalog items (up to 1000). Merges document fields per item ID. Needs writes turned on for your key.

  Try: “Mark these 200 items as on sale”

  Write · partial_update_catalog_items

• Replaces a whole catalog item

  Replace (PUT) a catalog item - replaces the entire item with new value. Needs writes turned on for your key.

  Try: “Replace item sku-123 with this data”

  Write · replace_catalog_item

• Replaces up to 1,000 catalog items at once

  Bulk replace catalog items (up to 1000). Each item becomes only the document fields provided. Needs writes turned on for your key.

  Try: “Replace these 50 catalog items”

  Write · replace_catalog_items

• Changes the data types of catalog fields

  Update catalog field mappings (data types). Valid types: boolean, date, geo_location, long, double, object, and string. Needs writes turned on for your key.

  Try: “Make the price field a double”

  Write · update_catalog_field_mappings

• Lists your messaging channels, such as email, SMS and push

  Get all available communication channels (email, SMS, push, etc.). Available in the default read-only setup.

  Try: “Which channels do we have set up?”

  Read · get_channels

• Shows a user's embedded messages by placement

  Get embedded messages for a user, grouped by placement ID. Needs customer data (PII) access turned on for your key.

  Try: “Show embedded messages for user 42”

  Read · get_embedded_messages

• Shows a user's in-app messages

  Get in-app messages for a user. Needs customer data (PII) access turned on for your key.

  Try: “What in-app messages does user@example.com have?”

  Read · get_in_app_messages

• Lists the message types in your project

  Get all message types within the project for use in templates. Available in the default read-only setup.

  Try: “List our message types”

  Read · get_message_types

• Cancels a scheduled email for one user

  Cancel scheduled email for specific user. Needs customer data (PII) access and writes turned on for your key.

  Try: “Cancel the scheduled email for user@example.com”

  Delete · cancel_email

• Cancels a scheduled in-app message for one user

  Cancel scheduled in-app message for specific user. Needs customer data (PII) access and writes turned on for your key.

  Try: “Cancel the in-app message for user 42”

  Delete · cancel_in_app

• Cancels a scheduled push for one user

  Cancel scheduled push notification for specific user. Needs customer data (PII) access and writes turned on for your key.

  Try: “Cancel the scheduled push for user 42”

  Delete · cancel_push

• Cancels a scheduled text for one user

  Cancel scheduled SMS message for specific user. Needs customer data (PII) access and writes turned on for your key.

  Try: “Cancel the scheduled SMS for user 42”

  Delete · cancel_sms

• Cancels a scheduled web push for one user

  Cancel scheduled web push notification for specific user. Needs customer data (PII) access and writes turned on for your key.

  Try: “Cancel the web push for user 42”

  Delete · cancel_web_push

• Cancels a scheduled WhatsApp message for one user

  Cancel scheduled WhatsApp message for specific user. Needs customer data (PII) access and writes turned on for your key.

  Try: “Cancel the WhatsApp message for user 42”

  Delete · cancel_whatsapp

• Sends an email to one user

  Send email to user. Needs customer data (PII) access and writes and sends turned on for your key.

  Try: “Send the receipt template to user@example.com”

  Write · send_email

• Sends an in-app message to one user

  Send in-app message to user. Needs customer data (PII) access and writes and sends turned on for your key.

  Try: “Send the upgrade in-app message to user 42”

  Write · send_in_app

• Sends a push notification to one user

  Send push notification to user. Needs customer data (PII) access and writes and sends turned on for your key.

  Try: “Send the reminder push to user 42”

  Write · send_push

• Sends a text message to one user

  Send SMS message to user. Needs customer data (PII) access and writes and sends turned on for your key.

  Try: “Text user 42 the reminder template”

  Write · send_sms

• Sends a web push notification to one user

  Send web push notification to user. Needs customer data (PII) access and writes and sends turned on for your key.

  Try: “Send the web push alert to user 42”

  Write · send_web_push

• Sends a WhatsApp message to one user

  Send WhatsApp message to user. Needs customer data (PII) access and writes and sends turned on for your key.

  Try: “Send the WhatsApp reminder to user 42”

  Write · send_whatsapp

• Shows one snippet

  Get a snippet by ID (numeric) or name (string). Available in the default read-only setup.

  Try: “Show the footer snippet”

  Read · get_snippet

• Lists your reusable content snippets

  Get all snippets for the current project. Available in the default read-only setup.

  Try: “List our snippets”

  Read · get_snippets

• Creates a reusable content snippet

  Create a new snippet with Handlebars templating support. Needs writes turned on for your key.

  Try: “Create a snippet for our legal footer”

  Write · create_snippet

• Deletes a snippet

  Delete a snippet by ID (numeric) or name (string). Needs writes turned on for your key.

  Try: “Delete the old-footer snippet”

  Delete · delete_snippet

• Updates a snippet

  Update a snippet by ID (numeric) or name (string). Needs writes turned on for your key.

  Try: “Update the footer snippet with the new address”

  Write · update_snippet

• Subscribes or unsubscribes many users at once

  Subscribe or unsubscribe multiple users to/from a subscription group. Needs customer data (PII) access and writes turned on for your key.

  Try: “Unsubscribe these 300 users from promotions”

  Write · bulk_update_subscriptions

• Subscribes a user to a subscription group by email

  Subscribe a user to a subscription group by email. Needs customer data (PII) access and writes turned on for your key.

  Try: “Subscribe user@example.com to the newsletter group”

  Write · subscribe_user_by_email

• Subscribes a user to a subscription group by user ID

  Subscribe a user to a subscription group by userId. Needs customer data (PII) access and writes turned on for your key.

  Try: “Subscribe user 42 to product updates”

  Write · subscribe_user_by_userid

• Unsubscribes a user from a group by email

  Unsubscribe a user from a subscription group by email. Needs customer data (PII) access and writes turned on for your key.

  Try: “Unsubscribe user@example.com from promotions”

  Delete · unsubscribe_user_by_email

• Unsubscribes a user from a group by user ID

  Unsubscribe a user from a subscription group by userId. Needs customer data (PII) access and writes turned on for your key.

  Try: “Unsubscribe user 42 from promotions”

  Delete · unsubscribe_user_by_userid

• Lists the kinds of data you can export

  Get the list of all available export data types that can be used with start_export_job. Returns an array of data type names that are supported by the Iterable API. Needs customer data (PII) access and writes turned on for your key.

  Try: “Which data types can I export?”

  Read · get_available_export_data_types

• Gets the status and download links of an export

  Get the job status and download URLs for files from a completed export job. Files are added to the list as the export job runs. Use 'startAfter' parameter to paginate through files. Each file is up to 10MB, with exports limited to 100GB total size. Needs customer data (PII) access turned on for your key.

  Try: “Is my export job done? Give me the files”

  Read · get_export_files

• Lists recent data export jobs

  Get a list of recent export jobs for the current project. Jobs can be filtered by state (enqueued, queued, running, completed, failed, cancelled, cancelling). Needs customer data (PII) access turned on for your key.

  Try: “Show my recent export jobs”

  Read · get_export_jobs

• Cancels an export that is queued or running

  Cancel a queued or running export job created with 'start_export_job'. Use the jobId returned from the start export endpoint. Needs customer data (PII) access and writes turned on for your key.

  Try: “Cancel export job 555”

  Delete · cancel_export_job

• Starts a data export, such as email events or user data

  Start a data export job that processes as a background job. Use 'get_export_files' to check status and obtain download links. Supports many data types including: email events (emailSend, emailOpen, emailClick, emailBounce, etc.), push events (pushSend, pushOpen, etc.), SMS events (smsSend, smsBounce, etc.), WhatsApp events, in-app message events, user data, purchase events, and more. Additional re

  Try: “Export all user data from January 2024”

  Write · start_export_job

• Lists your webhooks

  Get all webhooks for the project. Available in the default read-only setup.

  Try: “List our webhooks”

  Read · get_webhooks

• Changes a webhook's settings

  Update a webhook configuration. Needs writes turned on for your key.

  Try: “Point the bounce webhook at the new URL”

  Write · update_webhook

Watch out for

• With sends on, it can message real customers

  Sends let the agent trigger campaigns and send email, SMS and push. Only enable them on a sandbox project key. github.com

• With writes on, it can delete users and data

  Writes include deleting users, lists, catalogs and templates. Keep writes off for production keys. github.com

• Risky tools are not flagged to your app

  Send and delete tools are not marked as destructive, so your app may not warn you. Review each call before you allow it. github.com

• PII tools expose customer profiles

  With PII on, the assistant can read email addresses, phone numbers and custom fields. Leave it off unless you need it. github.com

Security advisories

In their words