Campaigns Tools
View email marketing campaigns and their performance statistics.
Required scope: promotions:read
All campaign tools are read-only.
Tools Overview
| Tool | Description | Read-only? |
|---|---|---|
list_campaigns | List email marketing campaigns | Yes |
get_campaign_stats | Get performance statistics for a campaign | Yes |
list_campaigns
List email marketing campaigns with optional filters.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
search | string | No | Search by campaign name |
status | string | No | Filter by status: draft, scheduled, sending, sent, cancelled |
get_campaign_stats
Get performance statistics for a specific email campaign, including delivery rates, open rates, click rates, and engagement metrics.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
campaign_id | integer | Yes | The campaign ID |
create_campaign
Create a new marketing email campaign as a draft. The user can refine recipients and send it later.
Required scope: campaigns:write
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Internal campaign name |
subject | string | No | Email subject line |
preview_text | string | No | Inbox preview text |
body | string | No | Email body (HTML or plain text) |
audience_type | string | No | all_customers (default), selected_customers, filter |
Returns
{
"success": true,
"message": "Campaign 'Spring Mountain Bike Promo' created as draft.",
"campaign": { "id": 5, "name": "Spring Mountain Bike Promo" }
}
Related
- Promotions Tools - Promo codes and vouchers