Campaigns

Activate or deactivate a campaign

Set the campaign active flag, like the campaign's switch in the app. An active campaign runs its outreach automatically: enrolled contacts move through the sequence. Activating needs a sequence and a LinkedIn or email sender. A deactivated campaign stops sending new steps (messages and invitations already sent are not retracted): contacts are held where they are, and lead finding is not affected. Needs the campaigns:write scope.

patchhttps://app.replysparrow.com/api/v1/campaigns/{id}/status

Authorizations

Authorizationstringheaderrequired

Your API key from Settings → API, sent as Bearer <token>.

Path Parameters

idstringrequired

Campaign id

Body

application/json

activebooleanrequired

Response

application/json

Campaign status updated

idstringrequired

Unique identifier for the campaign (the agent id in the app)

namestringrequired

Name of the campaign

activebooleanrequired

Whether the campaign is active: outreach is on and enrolled contacts move through the sequence

channelenum<string>required

Channels the campaign uses

Available options: linkedinmultiemail

exclude_first_degreebooleanrequired

Exclude first degree connections from the campaign (contacts already connected on LinkedIn)

split_messagesbooleanrequired

When enabled, LinkedIn message steps with several paragraphs are sent as 2-4 shorter messages

list_idsstring[]required

Other lists whose contacts the campaign reaches

stepsobject[]required

The sequence, LinkedIn track first, each track in order

created_atstring<date-time>required

Creation timestamp

updated_atstring<date-time>required

Last update timestamp

statusenum<string>

Lead finding state of the agent behind the campaign (managed in the Agents section)

Available options: draftactivepaused

goalenum<string>

Campaign goal: what replies should lead to

Available options: conversationsmeetings

toneenum<string>

Campaign tone, used by AI-written messages

Available options: professionalconversationaldirect

languagestring

Campaign language, used by AI-written messages; null = the account language

booking_urlstring

Meeting link AI-written messages may offer

skip_invitation_after_daysnumber

Number of days after which a pending invitation is skipped and only email steps are sent (default 7; 0 = never, though no invitation waits more than 60 days). Set on the sequence's first connect step; null when the sequence has none

linkedin_account_idstring

The first LinkedIn account of linkedin_account_ids (the primary), kept for existing integrations

email_account_idstring

The first mailbox of email_account_ids (the primary), kept for existing integrations

linkedin_account_idsstring[]

LinkedIn accounts sending the LinkedIn steps. Contacts are spread across them; each contact keeps one account for its whole sequence

email_account_idsstring[]

Mailboxes sending the email steps. Contacts are spread across them; each contact keeps one mailbox for its whole sequence

list_idstring

The campaign's own list: contacts its agent finds and enrolls land here

workflow_idstring

The sequence behind the campaign

Ctrl+I

Activate or deactivate a campaign

curl --request PATCH \  --url https://app.replysparrow.com/api/v1/campaigns/string/status \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{  "active": true}'

{  "id": "5b0c6c1e-8a43-4f7e-9d7d-1f8a2b3c4d5e",  "name": "Q4 founders",  "active": true,  "channel": "linkedin",  "status": "draft",  "goal": "conversations",  "tone": "professional",  "language": null,  "booking_url": null,  "exclude_first_degree": true,  "split_messages": false,  "skip_invitation_after_days": 7,  "linkedin_account_id": "acc_123",  "email_account_id": null,  "linkedin_account_ids": [    "acc_123"  ],  "email_account_ids": [],  "list_id": "9f8e7d6c-0000-4000-8000-000000000001",  "list_ids": [    "9f8e7d6c-0000-4000-8000-000000000002"  ],  "workflow_id": "wf_123",  "steps": [    {      "id": "st_1",      "track": "linkedin",      "order": 1,      "type": "connect",      "delay_days": null,      "message": null,      "connect_note": null,      "email_subject": null,      "email_body": null,      "ai": true    },    {      "id": "st_2",      "track": "linkedin",      "order": 2,      "type": "delay",      "delay_days": 1,      "message": null,      "connect_note": null,      "email_subject": null,      "email_body": null,      "ai": false    },    {      "id": "st_3",      "track": "linkedin",      "order": 3,      "type": "message",      "delay_days": null,      "message": "Hi {{first_name}}, thanks for connecting!",      "connect_note": null,      "email_subject": null,      "email_body": null,      "ai": false    }  ],  "created_at": "2026-10-24T09:12:44.000Z",  "updated_at": "2026-10-24T09:12:44.000Z"}