Create a campaign
create_campaignUse this when the user wants a new outreach campaign. Creates a draft that will write to the people on up to 10 people lists. A manual campaign (the default) gets one empty step per channel to be written; an ai-generated campaign has its steps written from prompt in the background, so read the campaign until that writing has finished; a templateId copies a saved template's steps. Nothing is sent until the campaign is launched. Messages go out from 9:00 to 17:00 in the campaign's time zone, Monday to Friday unless set otherwise, and open and click tracking are off unless turned on. Free. Calling again creates a second campaign.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"name": "<name>",
"listIds": "<listIds>"
},
"name": "create_campaign"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The campaign's name. | |
| type | No | `manual` (the default): you write every step. `ai-generated`: the steps are written from `prompt` in the background. | |
| prompt | No | `ai-generated` only: what you offer and to whom, up to 5,000 characters. The steps are written from it. | |
| ctaLink | No | The link steps insert where they write `{CTA Link}`: an http or https URL, or null or empty for none. | |
| listIds | Yes | 1 to 10 of your people lists. Their people are enrolled once each, in the order the lists are given, when the campaign launches. | |
| channels | No | One empty step is made for each channel, in order: `email`, `linkedin_connection` (an invitation), `linkedin_message` (to a connection) or `inmail`. `["email"]` when left out. At most one `linkedin_connection`, before every `linkedin_message`. Not with `templateId`. | |
| timezone | No | The IANA time zone the sending days and hours (9:00 to 17:00) are read in, such as `Europe/Lisbon`: a region, not an abbreviation such as EST. UTC when a campaign is created without one. | |
| emailDays | No | The days messages may go out, by English name with a capital first letter. Monday to Friday when left out. | |
| isDynamic | No | Enrolls people added to the campaign's lists after launch, as they arrive. False when left out. | |
| startDate | No | When sending may start, as an ISO 8601 date-time. Now when left out. | |
| templateId | No | A campaign template whose steps are copied into the campaign; they decide its channels, so send no `channels` with it. | |
| excludeLists | No | Up to 10 people lists whose people are never enrolled, matched by person, email address or LinkedIn profile. An id that is not one of your lists excludes nobody. | |
| knowledgeHubId | No | `ai-generated` only: the knowledge hub the steps draw on. Your default hub when left out. | |
| writingStyleId | No | `ai-generated` only: the writing style the steps follow. Your default style when left out. | |
| dailyEmailLimit | No | The most emails the campaign sends a day, 1 to 10,000, or null for no limit. | |
| excludeContacted | No | Skips people your campaigns already wrote to: `none` (the default) skips nobody, `ever` skips everyone written to, and `last_1_month` to `last_1_year` skip those written to in that time. | |
| addUnsubscribeLink | No | Ends every email with a one-click unsubscribe link. True when left out. | |
| excludeCompanyLists | No | Up to 20 company or people lists: nobody who works at one of their companies is enrolled. A list the organization does not have answers `422` `exclude_company_lists_invalid`. | |
| clickTrackingEnabledAt | No | Turns click tracking on from this ISO 8601 date-time, or off with null. Off when left out. A step that waits for a click needs it on. | |
| excludeEngagedContacts | No | Skips people who replied to one of your campaigns. False when left out. | |
| dailyLinkedinMessageLimit | No | The most LinkedIn messages and InMails the campaign sends a day, 1 to 10,000, or null for no limit. | |
| openRateTrackingEnabledAt | No | Turns open tracking on from this ISO 8601 date-time, or off with null. Off when left out. | |
| dailyLinkedinConnectionLimit | No | The most LinkedIn invitations the campaign sends a day, 1 to 10,000, or null for no limit. | |
| sendOnlyToValidatedEmailsEnabledAt | No | From this ISO 8601 date-time, enrolls only people whose email address checked `valid`; null also enrolls catch-all and unchecked addresses. |