PlatformDocs

Sequences

The emails of a campaign: what each one says, when it is sent and in what order.

View as Markdown

Connect the MCP server, then just ask.

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
add_campaign_stepAdds one email at the end of a campaign's sequence, sent delayDays after the previous one (the first step of an empty campaign becomes the opening email).Changes data
update_campaign_stepRewrite one email (step) of an existing campaign: its subject, body and/or delay.Changes data
delete_campaign_stepRemoves one email from a campaign's sequence for good.Deletes data
reorder_campaign_stepsPuts a campaign's emails in a new order.Changes data
get_email_templateReturns one email (step) of a campaign in full: subject and body templates with their merge fields, the sender, the delay before it is sent and its position in the sequence.Read-only
spam_check_emailChecks an email subject and body for words and patterns that send mail to spam, and returns a score with each issue and how to fix it.Read-only
generate_campaign_emails_aiWrites a sequence of emails for a campaign with AI, from your website, offer and ideal customer, and saves them as the campaign steps.Changes data

Use case

Add a third email to “Pricing page visitors”, 4 days after the second.

Called add_campaign_stepShow input
{
  "websiteId": "64b7f0a1c2d3e4f5a6b7c8d9",
  "campaignId": "6530c1d2e3f4a5b6c7d8e9f5",
  "subject": "One last idea",
  "body": "Hi {{ first_name | there }},\n\u2026\n{{sender_signature}}\n{{unsubscribe_text}}",
  "delayDays": 4
}

On this page