PlatformDocs

Email campaigns

Send email sequences to your leads from your own mailboxes, on the days and hours you choose.

View as Markdown

Connect the MCP server, then just ask.

list_campaignsList the email campaigns of one website, newest first, with their status (isActive), schedule, steps (emailCampaignTemplates), health and a cached stats snapshot (statsRollup: contacted, sent, opens, clicks, replies, bounces and rates, refreshed about every 5 minutes; see computedAt).Read-only
create_campaignCreate a new email sequence: the campaign plus one email per entry in steps (the first is the initial email, the rest follow-ups).Changes data
get_campaignGet one email campaign with live analytics: settings (isActive, schedule, timezone), its steps in emailCampaignTemplates[] (each with _id = templateId for update_campaign_step, subject, body and per-step stats), stats (prospect total, scheduledCount, uniqueContacted, totalEmailsSent, opens, clicks, replies, warm replies, bounced, unsubscribed and their rates), steps[] (per-step sent/opened/clicked/replied), statusBuckets (prospect counts per status) and statistics (sent vs scheduled over time).Read-only
update_campaignRenames a campaign, starts it (status active: emails start going out to its contacts) or pauses it, or changes its sending days (0 Sunday to 6 Saturday), hours (timeSlot start and end, 0-24), timezone or open/click tracking.Changes data
clone_campaignCopies a campaign with its steps and settings, named '<name> (copy)'.Changes data
delete_campaignPermanently delete an email campaign together with all its steps and every prospect in it; scheduled emails are never sent and the history is lost.Deletes data

Use case

Create a 3-email campaign for website visitors who saw our pricing page.

Called create_campaignShow input
{
  "websiteId": "64b7f0a1c2d3e4f5a6b7c8d9",
  "name": "Pricing page visitors",
  "emailAccountId": "6530c1d2e3f4a5b6c7d8e9f6",
  "steps": [
    {
      "subject": "Saw you checking our pricing",
      "body": "Hi {{ first_name | there }},\nQuick question about pricing\u2026\n{{sender_signature}}\n{{unsubscribe_text}}",
      "delayDays": 0
    }
  ]
}

The campaign is created with the default window (Monday to Friday, 9:00–17:00) unless you say otherwise. emailAccountId is required by the tool but any connected mailbox id will do: the sending mailbox is chosen per contact. Nothing is sent until contacts are added.

Use case

Which of my campaigns are running, and how are they doing?

Called list_campaignsShow input
{
  "websiteId": "64b7f0a1c2d3e4f5a6b7c8d9",
  "page": 1,
  "limit": 100,
  "sortProperty": "createdAt",
  "order": "desc"
}

Each campaign comes back with isActive (running or paused), its steps, a health status and a statsRollup snapshot (sent, opens, clicks, replies, bounces and their rates, refreshed about every 5 minutes). totalDocs is how many campaigns the website has; up to 100 come per page. For exact live numbers of one campaign your assistant uses get_campaign.

On this page