Update a campaign | Swarmhit Developers

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, 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.

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.

Authorization

bearerAuth

AuthorizationBearer <token>

An API key created under Settings → API & Webhooks.

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Any subset of these fields.

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 (pause it first); on a paused campaign it clears the pool and leads wait until a sender is added. Removing a sender reassigns its in-flight leads to the remaining pool on their next run. Every id must be a sender account in this workspace.

aiInterestEnabled?boolean

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.

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.

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,    "linkedinAccountIds": [      "string"    ],    "excludeListIds": [      "string"    ],    "excludeOtherCampaigns": true,    "excludeOtherSenders": true,    "excludeSameSenderOtherCampaigns": 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": "visit_profile",          "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`