Create campaign
create_campaignCreates a campaign in the workspace. The campaign starts as a DRAFT and sends nothing. A new campaign has no emails in it, so it cannot be launched until a sequence is written with replace_campaign_sequence and a sender email is attached. Sending limits and deliverability settings can be set here or changed later with update_campaign.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| flow | No | Campaign flow. Defaults to multiple_leads_scheduled, which behaves exactly like a campaign created in the app. Only pass api if you specifically want lead validation skipped at launch | |
| name | Yes | Campaign name | |
| emoji | No | Campaign emoji shown in the app. Defaults to a generic one | |
| timezone | No | IANA timezone, e.g. America/New_York | |
| dailyLimit | No | Cap on the total emails (initial + follow-ups) the campaign may schedule per calendar day in its timezone. Omit for no campaign-level cap; per-mailbox limits still apply | |
| isEnabledLlm | No | Enable AI (LLM) features for this campaign | |
| minimumHealthScore | No | Minimum email account health score for this campaign, 1-100 (see healthScore in list_sender_emails). An account below it, or with no score yet, sends nothing in this campaign, first emails and follow-ups alike, until its score is back at or above it; its conversations wait for it and never move to another account. 0 means no minimum; omit it to leave the setting as it is | |
| allowNonBusinessEmails | No | Allow sending to free mailbox providers (gmail.com, etc.) | |
| isEnabledEmailVerifier | No | Verify lead emails before sending | |
| ignoreOutOfOfficeReplies | No | Do not stop follow-ups on out-of-office replies | |
| maximumTimeBetweenEmails | No | Maximum gap between two sends, in minutes | |
| minimumTimeBetweenEmails | No | Minimum gap between two sends, in minutes | |
| isEnabledCatchallValidated | No | Send to catch-all validated addresses | |
| isEnabledStopFollowUpsOnReply | No | Stop follow-ups to a lead once they reply | |
| isEnabledIgnoreHardBouncedLeads | No | Skip leads that previously hard-bounced | |
| isEnabledSkipLeadIfAlreadyExists | No | Skip leads that already exist in the workspace | |
| maximumSendingLimitPerSenderEmail | No | Daily sending limit per sender email account | |
| isEnabledStopFollowUpsForSameCompany | No | Company reply stop: once a lead replies (out-of-office and other automatic replies don't count), stop emailing the other leads at the same company in this campaign. Subdomains count as the same company; personal addresses like @gmail.com never do. On by default | |
| isEnabledIgnoreLeadsWhoAlreadyResponded | No | Skip leads who already responded in another campaign | |
| maximumSendingLimitPerSenderEmailVariation | No | Random daily variation applied to the sending limit |