Campaigns

​

campaign_activity_summary

Read-only Aggregate counts of pending, completed and failed actions across the campaign. Three numbers for the whole campaign — the cheapest “is it working” check. For the same split per step use sequence_step_stats, and for the leads behind one step sequence_leads_at_step.

​

Parameters

​

campaign_add_prospects

Write Destructive Top up an already-running campaign with prospects from a new source, without touching its sequence or existing leads. Runs in the background and can take several minutes. Two hard preconditions, both enforced by the backend as thrown errors: the campaign must be ACTIVE — a DRAFTED one fails with “Campaign is not active!” — and it must have finished filtering its first batch. So this is never how a new campaign gets its audience: for that use campaign_set_source (a search URL) or campaign_upload_leads (CSV rows) before launching. It also does not add leads to this campaign directly — the backend creates a child campaign pointing at this one, which is why campaign_delete reports removing active children.

​

Parameters

​

campaign_create

Write Create a DRAFTED campaign. Nothing sends until campaign_launch. Pass sourceUrl to set the prospect source at the same time (a LinkedIn or Sales Navigator search URL, a group, an event, or a post). For a CSV-driven campaign, omit sourceUrl and follow up with campaign_upload_leads. This is the right starting point for EVERY new campaign. Never begin one with campaign_duplicate unless the user named a campaign to copy — see that tool for why. It creates the campaign and nothing else: the sequence comes from flow_set, accounts and limits from campaign_update, and it only sends after campaign_launch.

​

Parameters

​

campaign_create_ab_variant

Write Split a campaign into an A/B pair so two versions of the sequence run against comparable halves of the audience. Compare them later with analytics_campaign. This SPLITS, it does not copy: the backend moves half of the not-yet-contacted leads out of the original into a new DRAFTED campaign, copies the flow, and renames the original to “<title> [A]”. The original therefore ends up with half the audience it had. It needs more than 10 leads still waiting to be contacted and refuses otherwise with “Not enough leads to do AB testing, Duplicate campaign instead!” — in which case campaign_duplicate is the backend’s own suggestion. Use campaign_duplicate when the audience should be left alone, and this when the point is to compare two versions on one audience.

​

Parameters

​

campaign_delete

Write Destructive Remove a campaign from your account by moving it to DELETED. Nothing is erased — the campaign, its leads, sequences and activity records all stay in the database, and the campaign simply stops appearing in listings. There is no tool to bring it back, so confirm with the user first. Sending stops because the workers only pick up ACTIVE campaigns; to stop sending without removing the campaign, that is a pause, which belongs in the web app. The only tool allowed to write a campaign status, and the only value it writes is DELETED — campaign_update has no status parameter and nothing sets ACTIVE, PAUSED or ARCHIVED. Deleted campaigns vanish from campaign_list, so confirm before calling: there is no undelete.

​

Parameters

​

campaign_duplicate

Write Copy one specific existing campaign — its settings and its whole sequence — into a new DRAFTED campaign, without copying the leads. Use this ONLY when the user asks to duplicate a campaign they have named. It is not a way to start a new campaign: a new campaign has nothing to duplicate, and the copied sequence carries the original audience’s messaging. To start fresh, use campaign_create. The copied steps cannot be rewritten from here either — sequence_update edits are reverted at launch on a campaign that has not launched yet, so a duplicate is only useful when the existing copy is meant to be kept.

​

Parameters

​

campaign_export_stats

Write Generate a CSV export of campaign performance. Returns a filename; the file is served from the CDN and also emailed to the account owner — so it leaves the conversation, which is worth mentioning before calling it. Performance numbers, not people: for a file of prospects use lead_export, and to read the numbers here instead use analytics_campaign.

​

Parameters

​

campaign_generate_ai_sequence

Write Ask the platform’s own AI to draft a whole campaign — copy and multi-step sequence — from a brief, and create it as a draft. Requires an AI provider connected in the web app under Settings - Integrations. Use this when the user wants the platform to write the sequence for them; to author one yourself, use flow_set.

​

Parameters

​

campaign_get

Read-only Everything about one campaign: settings, schedule, limits, attached accounts, lead source, live counters and the flow outline. This is the tool to call before changing anything — it also reports what is still missing before the campaign can launch, in _readiness.blockers, which must be empty before campaign_launch. Read status here before choosing how to edit copy: flow_set for a DRAFTED campaign, sequence_update only once it is ACTIVE or PAUSED. A settings-and-counters snapshot: for the sequence in detail use flow_get, for performance analytics_campaign, and for the people lead_list.

​

Parameters

​

campaign_launch

Write Destructive Start a campaign. THIS BEGINS SENDING REAL OUTREACH to real people from the connected LinkedIn account and mailboxes — invitations, messages and emails go out on the configured schedule. Run campaign_get first and clear every blocker: a saved flow, a lead source, a sending account, and (for CSV campaigns) a finished import. Show the user the full sequence and the audience and get an explicit yes in the conversation before calling — not an assumed one. Launch rebuilds every step from the saved flow graph, so any sequence_update edit made while the campaign was a draft is overwritten here; fix a draft’s copy with flow_set instead. This is the only tool that starts a campaign. Pausing or resuming one afterwards has no tool at all and happens in the web app.

​

Parameters

​

campaign_list

Read-only Campaigns in your account, newest first, 20 per page. Use status to filter — DRAFTED campaigns are the ones still being built, ACTIVE ones are sending right now. DELETED campaigns never appear here, which is why a deletion looks like a disappearance. The list view, a few fields each: for one campaign in full use campaign_get, and for performance analytics_campaign. Passing userId to read a sub-account’s campaigns is accepted only from an account owner.

​

Parameters

​

campaign_logs

Read-only Chronological record of everything that happened to a campaign: created, started, paused, resumed, lead sources added, settings changed, limits hit. Changes to the CAMPAIGN, written by whoever made them — the audit trail to read when a user asks why a campaign stopped or who changed a limit. Not what happened to the prospects: that is activity_list, lead_get or sequence_step_stats.

​

Parameters

​

campaign_preview_message

Read-only Render a draft message against a real lead from the campaign so you can see how the merge fields resolve before committing the copy to a step. Nothing is sent and nothing is saved — this is the safe way to check a {{placeholder}} actually resolves, since an unknown one renders empty rather than failing. Save the copy with flow_set; to put a real email in front of yourself instead, campaign_send_test_email.

​

Parameters

​

campaign_send_test_email

Write Destructive Send one real email to an address you control, using a campaign mailbox, so you can check rendering and deliverability before launch. This does send mail: show the user the recipient, subject and body and get an explicit yes first. Only ever to an address they control — it is not a way to message a prospect, and there is no tool for that. To check merge fields without sending anything, use campaign_preview_message.

​

Parameters

​

campaign_set_source

Write Destructive Point a DRAFTED campaign at where its prospects come from: a LinkedIn/Sales Navigator search URL, a group, an event, a post, or a CRM segment. For an ACTIVE campaign use campaign_add_prospects instead — that adds to the existing pool rather than replacing the source.

​

Parameters

​

campaign_update

Write Change a campaign’s SETTINGS: title, sending accounts, schedule, daily limits, timezone and every safety toggle. Only the fields you pass are changed. Attaching accounts is done here: one linkedAccountId for LinkedIn steps, and emailAccountIds — a list — for EMAIL steps. Ask the user which accounts when there is a choice. NOT this tool: campaign status. It cannot start, pause, resume, archive or delete a campaign, and there is no status parameter. To start one use campaign_launch; to remove one use campaign_delete. Pausing, resuming and archiving are web-app only and have no tool at all — say so rather than looking for a substitute. Nor does it touch the sequence (flow_set) or the audience (campaign_set_source). One side effect worth knowing: changing linkedAccountId rewrites that account onto every lead already in the campaign, not just future ones.

​

Parameters

​

campaign_upload_leads

Write Bulk-load prospects into a campaign from parsed CSV rows. header maps each column name to a platform field — profileUrl, salesNavUrl, recruiterUrl, email, firstName, lastName, fullName, personalization, phone, website, or “customVariable” to keep it as a merge field. Rows with neither a profile URL nor an email are skipped silently. Import runs asynchronously; the campaign is only launchable once isFiltered flips true. Use this when the user has a list in hand. When they describe an audience instead, the audience is a LinkedIn search and belongs in campaign_set_source — build the URL with search_url_build. For a campaign that is already running, neither applies: that is campaign_add_prospects.

​

Parameters

​

search_url_build

Read-only Turn an audience description into a LinkedIn or Sales Navigator people-search URL, so a campaign source can be described rather than pasted. Returns the url plus what it managed to express — hand it to campaign_set_source. What it can build: job titles (included and excluded) and free-text keywords with boolean operators. What it CANNOT build: geography, industry, company size, seniority and years-in-role. Sales Navigator only accepts those as numeric ids from its own typeahead (id:103644278 is United States), they cannot be derived from a name, and a wrong id silently searches the wrong audience. For those, either ask the user to paste a Sales Navigator URL with the filters already set, or pass the ids through extraFilters if the user supplies them. Never guess one. Recruiter (/talent/) URLs cannot be built at all — ask the user for one.

​

Parameters