Skip to main content
POST
Update campaign settings

Authorizations

X-Api-Key
string
header
required

Your LinkedCamp API key.

Body

application/json
campaignId
string
required

Campaign id, from campaign_list or campaign_create.

title
string

Short label.

linkedAccountId
string

The ONE LinkedIn account this campaign sends from. Required for any LinkedIn step. A campaign cannot use two. If linkedin_account_list returns more than one, ask the user which — do not pick for them.

emailAccountIds
string[]

Mailboxes for EMAIL steps. Unlike the LinkedIn account, several are allowed and sends rotate across them. Only attach these if the user wants email steps, and ask which mailboxes.

timezone
string

IANA timezone, e.g. "America/New_York". Governs the schedule.

schedule
object

Sending window per weekday, keyed 0 (Sunday) to 6 (Saturday), in the campaign timezone.

campaginLimits
object

Per-day caps per step type. Note the field spelling.

tags
string[]

Tag ids applied to every lead in this campaign — this identifies the campaign's leads, so it should be a tag belonging to THIS campaign. Never reuse another campaign's tag: the two campaigns' leads then become indistinguishable. Mint one with tag_create (short label, interest NEUTRAL) and pass its id. Pass [] to remove all tags.

assignTo
object

Assign leads to team members. Shape mirrors the web app.

leadsPriority
string

Ordering strategy for working the lead queue, e.g. "newest" / "oldest".

stopOnReply
boolean

Halt a lead's sequence as soon as they reply. Default true.

skipProfiles
boolean

Skip prospects you already have an open conversation with.

uniqueProfiles
boolean

Never enrol the same profile in two campaigns. Default true.

premiumProfiles
boolean

Only target LinkedIn Premium / Open Profile members.

connectionOutreach
boolean

Target existing 1st-degree connections instead of new ones.

snOutreach
boolean

Use Sales Navigator messaging. Requires a Premium LinkedIn account.

prioritizeNewLeads
boolean

Work newly-found prospects before older ones.

reload
boolean

Re-run the search periodically to pull in newly matching prospects.

trackOpens
boolean

EMAIL steps: insert an open-tracking pixel.

trackClicks
boolean

EMAIL steps: rewrite links for click tracking.

emailAsText
boolean

Send email as plain text. Better deliverability, no tracking.

pauseCampaign
boolean

Pause the campaign without changing its status.

scheduledAt

Future timestamp to auto-start the campaign, instead of launching it now with campaign_launch.

agentId
string | null

AI agent that answers replies in this campaign's inbox. Pass null to detach it. Never set this on your own: an agent writes to real prospects without further approval. Ask the user whether they want one, and offer both routes — pick an existing agent from agent_list, or build one with agent_upsert, give it material with kb_upsert and kb_attach, then agent_train. A campaign with no agent is perfectly normal; replies just come to the inbox.

Response

The result, as JSON. Writes answer { "ok": true, "message": ..., "data": ... }.

The response is of type object.