On this page
POST/campaigns/:campaignId/pause
Credits: 0
LinkedIn risk: Low (stops dispatch; does not send LinkedIn traffic)
Purpose
Pause an in-progress campaign. Same rules as the dashboard Pause control (cancels queued outbound work for that campaign and clears outbound queue flags on leads).
| Current status | Behavior |
|---|---|
CAMPAIGN_IN_PROGRESS | Pause → CAMPAIGN_PAUSED (action: paused) |
CAMPAIGN_PAUSED | No-op success (action: noop) |
| Other | 409 conflict |
Extension import active (extensionStatus: FINDING_LEADS) | Pause still succeeds — outreach stops; lead import keeps finishing in the background |
Request
POST /campaigns/search_abc/pause
X-API-Key: sk_live_...
Body must be empty or {}. Any other fields → 400 validation_error.
Response 200
{
"campaignId": "search_abc",
"action": "paused",
"status": "CAMPAIGN_PAUSED",
"campaign": {
"id": "search_abc",
"name": "Broker outreach",
"status": "CAMPAIGN_PAUSED",
"totalLeads": 9,
"assignedTemplateId": "tmpl_…",
"stats": {}
}
}
| Field | Notes |
|---|---|
action | paused | noop |
status | Always CAMPAIGN_PAUSED on success |
campaign | Same allowlisted shape as GET /campaigns/:id |
Errors
| Code | When |
|---|---|
validation_error | Non-empty body |
not_found | Unknown campaign |
conflict | Not in progress (resume/start is blocked while leads are still being imported) |
upstream_unavailable | Unexpected pause failure — retry |
MCP
Tool: pause_campaign — arg: campaignId.