Update a campaign | Swarmhit Developers

JavaScript SDK: swarmhit.campaigns.update(campaignId, params)

Updates any subset of a campaign's writable fields: name, status (set active to start sending, paused to stop), the sender pool (linkedinAccountIds), the outreach sequence, the send schedule, aiInterestEnabled, the email unsubscribe line and tracking, and the lead-exclusion rules (excludeListIds plus the exclude* flags). sequence and schedule are replaced wholesale — send the complete object you want, not a partial patch of it.

A full sequence replacement can update the content of any step or A/B variant. For variant A, keep the step's legacy flat copy/media fields identical to the corresponding values in config.variants[0]; conflicting values are rejected with 400. Updating a later variant only requires changing that variant object. For a single existing step or variant, prefer PATCH /campaigns/{id}/sequence/{stepId} so unrelated sequence structure cannot be overwritten.

Once a campaign has leads in progress, the sequence may only be edited safely: you can change step messages and delays and append new steps, but removing, reordering or retyping existing steps is rejected with 400 (a lead's progress is pinned to a step id). Duplicate the campaign to rework its sequence from scratch.

An active campaign must keep at least one sender: sending an empty linkedinAccountIds while the campaign is (or is being set) active is rejected with 400.

A campaign won't go active while a step has nothing to send: a message, inmail, email or whatsapp_message variant with no text (a file alone will do on a message or whatsapp_message), a voice_note without its recording, an ai_voice_note without its script, or the first email of a path without a subject. That is a 400 with code: empty-step: message names the steps by their number in the sequence, and details.steps lists them ([{ id, type }]) to fix with PATCH /campaigns/{id}/sequence/{stepId}. Once a campaign has been launched, a sequence that empties a step is refused the same way.

With accounts of senders in its pools, a campaign won't go active, nor an active one change its pools, while a sender (or an account without one on the primary channel: LinkedIn when the sequence has a LinkedIn step or no step, else email, else WhatsApp) has no account on a channel the sequence uses and no account without a sender is there to share: a 400 with code: sender-no-mailbox or sender-no-whatsapp. Attaching senders with senderIds has its own refusals, listed there.

Authorization

bearerAuth

AuthorizationBearer <token>

An API key created on the Access tokens page.

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Any subset of these fields. For a copy-only change to an existing sequence step, use PATCH /campaigns/{id}/sequence/{stepId}. If a full sequence contains both legacy flat content fields and config.variants, their variant-A copy and media values must agree.

name?string

status?string

Value in

"draft"
"active"
"paused"
"finished"

linkedinAccountIds?array<string>

Replace the campaign's sender pool. An empty array is rejected with 400 while the campaign is active and its sequence has LinkedIn steps (pause it first); on a paused campaign it clears the pool and leads wait until a sender is added. Removing a sender moves its not-yet-contacted leads to the remaining senders right away; leads it already contacted stay with it and wait, and carry on if it is added back. Every id must be a sender account in this workspace.

emailAccountIds?array<string>

Replace the campaign's mailbox pool. An empty array is rejected with 400 while the campaign is active and its sequence has email steps. Every id must be a mailbox in this workspace.

whatsappAccountIds?array<string>

Replace the campaign's WhatsApp number pool. An empty array is rejected with 400 while the campaign is active and its sequence has WhatsApp steps. Every id must be a number in this workspace.

senderIds?array<string>

Replace the campaign's senders. Adding one brings its accounts on the channels the sequence uses; removing one takes its accounts out of the pools, except a mailbox or number still in a conversation with a lead outside that sender. A pool sent in the same request keeps exactly what it says. The same refusals as on create.

aiInterestEnabled?boolean

Label each reply with AI, at the Reply analysis price per reply read (Settings → Credits usage, for owners and admins).

unsubscribe?

Either key alone updates just that key.

tracking?

Either key alone updates just that kind; mailbox goes back to the mailboxes' settings.

excludeListIds?array<string>

Replace the campaign's exclusion lists — lead list ids whose members are never contacted. Pass an empty array to clear them. Every id must be a lead list in this workspace.

excludeOtherCampaigns?boolean

Skip leads any other campaign has already contacted (invited or messaged).

excludeOtherSenders?boolean

Skip leads already messaged by a different sender account.

excludeSameSenderOtherCampaigns?boolean

Skip leads the lead's assigned sender already contacted from another campaign.

companyLimit?|

At most max new people per company per day or week; null turns it off. Changing it lets the leads it holds go again at the next sending time, counted against the new limit.

pauseCompanyOnReply?boolean

A real reply pauses this campaign's other leads at the same company (pausedReason: company_replied). See Campaign.

outOfOffice?

Either key alone updates just that key.

matchEmailProvider?boolean

Provider matching ("Provider Matching" or "Email provider matchmaker" in other tools). A lead whose mail Google or Microsoft receives (read from its email domain's MX records; personal Outlook and Hotmail count as Microsoft) gets its emails from one of the campaign's mailboxes on the same provider when there is one, and waits for it when it is at its daily cap. A lead on another provider, or one the campaign has no mailbox for, uses any mailbox, and so does a lead whose domain hasn't been read yet when its first email is due. It can lower sending volume when most leads use a provider the campaign has few mailboxes for. Default false.

schedule?

Send-window schedule. Replaces the whole schedule — send every field you want to keep; omitted fields fall back to the defaults (Etc/GMT, 09:00-19:00, Mon-Fri). Rejected with 400 if the timezone is unknown, activeDays is empty, activeHours.from is not before to, or startDate is after endDate.

sequence?

Replace the campaign's outreach sequence wholesale. See SequenceStepInput for linear vs. branching wiring. This can update all step variants, but the complete sequence must be sent. For variant A, legacy flat copy/media fields and the corresponding values in config.variants[0] must agree. Prefer PATCH /campaigns/{id}/sequence/{stepId} for a change confined to one existing step or variant.

Response Body

`application/json`

curl -X PATCH "https://example.com/campaigns/string" \  -H "Content-Type: application/json" \  -d '{    "status": "active"  }'

{  "data": {    "id": "string",    "name": "string",    "status": "draft",    "stats": {      "total": 0,      "done": 0,      "failed": 0    },    "aiInterestEnabled": true,    "unsubscribe": {      "enabled": true,      "text": "string"    },    "tracking": {      "opens": "mailbox",      "clicks": "mailbox"    },    "linkedinAccountIds": [      "string"    ],    "emailAccountIds": [      "string"    ],    "whatsappAccountIds": [      "string"    ],    "senderIds": [      "string"    ],    "excludeListIds": [      "string"    ],    "listId": "string",    "excludeOtherCampaigns": true,    "excludeOtherSenders": true,    "excludeSameSenderOtherCampaigns": true,    "companyLimit": {      "max": 1,      "period": "day",      "scope": "campaign"    },    "pauseCompanyOnReply": true,    "outOfOffice": {      "enabled": true,      "fallbackDays": 7    },    "matchEmailProvider": true,    "schedule": {      "startDate": "2019-08-24T14:15:22Z",      "endDate": "2019-08-24T14:15:22Z",      "timezone": "string",      "activeHours": {        "from": "string",        "to": "string"      },      "activeDays": [        0      ]    },    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "sequence": {      "steps": [        {          "id": "string",          "type": "if_connected",          "parent": "string",          "branch": "yes",          "config": {},          "nextDelayHours": 0,          "branchDelays": {            "yes": 0,            "no": 0          }        }      ]    }  }}

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`