|
1 | 1 | # Available Iterable MCP Tools (104 tools) |
2 | 2 |
|
3 | | -**Legend:** 🔒 = Contains PII, ✏️ = Write operation |
| 3 | +**Legend:** |
| 4 | +- 🔒 = Requires enabling user PII access |
| 5 | +- ✏️ = Requires enabling writes |
| 6 | +- ✉️ = Requires enabling sends |
| 7 | + |
4 | 8 |
|
5 | 9 | ## Campaigns (13 tools) |
6 | 10 | - **abort_campaign** ✏️: Abort a campaign that is currently running |
7 | | -- **activate_triggered_campaign** ✏️: Activate a triggered campaign (requires API triggered campaign activation enabled) |
| 11 | +- **activate_triggered_campaign** ✏️✉️: Activate a triggered campaign (requires API triggered campaign activation enabled) |
8 | 12 | - **archive_campaigns** ✏️: Archive one or more campaigns. Scheduled/recurring campaigns will be cancelled, running campaigns will be aborted. |
9 | 13 | - **cancel_campaign** ✏️: Cancel a scheduled or recurring campaign |
10 | | -- **create_campaign** ✏️: Create a new blast or triggered campaign from an existing template. If listIds are provided, the campaign will be a blast campaign, otherwise it will be a triggered campaign. Blast campaigns will be sent immediately if sendAt is not provided. |
| 14 | +- **create_campaign** ✏️✉️: Create a new blast or triggered campaign from an existing template. If listIds are provided, the campaign will be a blast campaign, otherwise it will be a triggered campaign. Blast campaigns will be sent immediately if sendAt is not provided. |
11 | 15 | - **deactivate_triggered_campaign** ✏️: Deactivate a triggered campaign (requires API triggered campaign deactivation enabled) |
12 | 16 | - **get_campaign**: Get detailed information about a specific campaign |
13 | 17 | - **get_campaign_metrics**: Get campaign performance metrics |
14 | 18 | - **get_campaigns**: Retrieve campaigns |
15 | 19 | - **get_child_campaigns**: Get child campaigns generated by a recurring campaign |
16 | | -- **schedule_campaign** ✏️: Schedule an existing campaign to be sent at a specific time |
17 | | -- **send_campaign** ✏️: Send an existing scheduled campaign immediately |
18 | | -- **trigger_campaign** ✏️: Trigger a campaign to send to specified lists |
| 20 | +- **schedule_campaign** ✏️✉️: Schedule an existing campaign to be sent at a specific time |
| 21 | +- **send_campaign** ✏️✉️: Send an existing scheduled campaign immediately |
| 22 | +- **trigger_campaign** ✏️✉️: Trigger a campaign to send to specified lists |
19 | 23 |
|
20 | 24 | ## Catalogs (12 tools) |
21 | 25 | - **bulk_delete_catalog_items** ✏️: Bulk delete catalog items by their IDs |
|
41 | 45 | ## Events (4 tools) |
42 | 46 | - **get_user_events_by_email** 🔒: Get event history for a user by email address |
43 | 47 | - **get_user_events_by_user_id** 🔒: Get event history for a user by user ID |
44 | | -- **track_bulk_events** 🔒✏️: Track multiple events in a single request for better performance |
45 | | -- **track_event** 🔒✏️: Track a custom event for a user |
| 48 | +- **track_bulk_events** 🔒✏️✉️: Track multiple events in a single request for better performance |
| 49 | +- **track_event** 🔒✏️✉️: Track a custom event for a user |
46 | 50 |
|
47 | 51 | ## Experiments (1 tools) |
48 | 52 | - **get_experiment_metrics**: Get experiment metrics for A/B testing analysis (currently supports email experiments only) |
49 | 53 |
|
50 | 54 | ## Journeys (2 tools) |
51 | 55 | - **get_journeys**: Get journeys (workflows) with optional pagination and state filtering |
52 | | -- **trigger_journey** 🔒✏️: Trigger a journey (workflow) for a user |
| 56 | +- **trigger_journey** 🔒✏️✉️: Trigger a journey (workflow) for a user |
53 | 57 |
|
54 | 58 | ## Lists (8 tools) |
55 | 59 | - **create_list** ✏️: Create a new user list |
|
72 | 76 | - **get_embedded_messages** 🔒: Get embedded messages for a user, grouped by placement ID |
73 | 77 | - **get_in_app_messages** 🔒: Get in-app messages for a user |
74 | 78 | - **get_message_types**: Get all message types within the project for use in templates |
75 | | -- **send_email** 🔒✏️: Send email to user |
76 | | -- **send_in_app** 🔒✏️: Send in-app message to user |
77 | | -- **send_push** 🔒✏️: Send push notification to user |
78 | | -- **send_sms** 🔒✏️: Send SMS message to user |
79 | | -- **send_web_push** 🔒✏️: Send web push notification to user |
80 | | -- **send_whatsapp** 🔒✏️: Send WhatsApp message to user |
| 79 | +- **send_email** 🔒✏️✉️: Send email to user |
| 80 | +- **send_in_app** 🔒✏️✉️: Send in-app message to user |
| 81 | +- **send_push** 🔒✏️✉️: Send push notification to user |
| 82 | +- **send_sms** 🔒✏️✉️: Send SMS message to user |
| 83 | +- **send_web_push** 🔒✏️✉️: Send web push notification to user |
| 84 | +- **send_whatsapp** 🔒✏️✉️: Send WhatsApp message to user |
81 | 85 |
|
82 | 86 | ## Snippets (5 tools) |
83 | 87 | - **create_snippet** ✏️: Create a new snippet with Handlebars templating support |
|
103 | 107 | - **get_templates**: Retrieve templates |
104 | 108 | - **preview_email_template**: Preview email template with custom data. Returns fully rendered HTML with user, event, and/or data feed data substituted. |
105 | 109 | - **preview_inapp_template**: Preview in-app message template with custom data. Returns fully rendered HTML with user, event, and/or data feed data substituted. |
106 | | -- **send_email_template_proof** 🔒✏️: Send a proof of a email template to a specific user |
107 | | -- **send_inapp_template_proof** 🔒✏️: Send a proof of a in-app message template to a specific user |
108 | | -- **send_push_template_proof** 🔒✏️: Send a proof of a push notification template to a specific user |
109 | | -- **send_sms_template_proof** 🔒✏️: Send a proof of a SMS template to a specific user |
| 110 | +- **send_email_template_proof** 🔒✏️✉️: Send a proof of a email template to a specific user |
| 111 | +- **send_inapp_template_proof** 🔒✏️✉️: Send a proof of a in-app message template to a specific user |
| 112 | +- **send_push_template_proof** 🔒✏️✉️: Send a proof of a push notification template to a specific user |
| 113 | +- **send_sms_template_proof** 🔒✏️✉️: Send a proof of a SMS template to a specific user |
110 | 114 | - **update_email_template** ✏️: Update existing email template by templateId |
111 | 115 | - **update_inapp_template** ✏️: Update existing in-app message template by templateId |
112 | 116 | - **update_push_template** ✏️: Update existing push notification template by templateId |
|
0 commit comments