PlatformDocs

Email campaigns

Add every matching lead to an email campaign automatically.

View as Markdown

Connect the MCP server, then just ask.

create_automationCreates an automation that is active straight away and runs whenever a lead matches it.Changes data
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
update_automationChanges an existing automation: its name, rule, action settings or on/off state.Changes data

Use case

Add every hot lead to my 'Website visitors' campaign.

Called create_automationShow input
{
  "websiteId": "64b7f0a1c2d3e4f5a6b7c8d9",
  "name": "Hot leads to campaign",
  "trigger": {
    "then": "send-to-emailCampaign"
  },
  "actions": [
    {
      "emailCampaign": "6a3f00000000000000000004"
    }
  ]
}

Your assistant finds the campaign id first and confirms before creating it, because every future matching lead will be emailed:

Called list_campaignsShow input
{ "websiteId": "64b7f0a1c2d3e4f5a6b7c8d9" }

Use case

Only add leads with a verified email to the campaign.

Called update_automationShow input
{
  "automationId": "64b7f0a1c2d3e4f5a6b7c8e4",
  "trigger": {
    "emailVerification": { "allowOnlyValidEmails": true, "allowCatchAllEmails": false, "allowGuessedEmails": false, "allowWithoutEmails": false }
  }
}

Guessed and catch-all addresses are then skipped, so the campaign only emails people whose address we verified.

On this page