Skip to main content
PATCH
Update campaign
Requires campaigns:write. The request is {"action":"pause"} or {"action":"resume"}. This endpoint does not create campaigns or edit sequences. Resume additionally requires inbox:send and checks the credential creator’s ALLOW_CREATE_CAMPAIGN workspace permission. It may continue scheduled LinkedIn outreach. Pausing remains available under the REST lapsed-subscription policy to reduce outreach, subject to authentication and scopes. Use an Idempotency-Key for retries. REST applies the action directly; the MCP start_campaign tool adds its own preview/approval flow before resuming.

Authorizations

X-API-Key
string
header
required

API key for authentication (prefix: sp_live_ or sp_test_)

Path Parameters

id
string
required

Campaign ID

Body

application/json
action
enum<string>
required

Action to perform on the campaign

Available options:
pause,
resume
Example:

"pause"

Response

Campaign updated

success
boolean
required

Success status

Example:

true

campaignId
string
required

Campaign ID

Example:

"clxyz123..."

action
string
required

Action performed

Example:

"pause"

newStatus
string
required

New campaign status

Example:

"paused"

message
string
required

Message

Example:

"Campaign paused successfully"