On this page

POST/campaigns/:campaignId/pause

Pause outreach. 0 credits. Rate class: campaign_control. Only when status is CAMPAIGN_IN_PROGRESS. Body: none.

Request

POST /campaigns/search-xyz/pause
X-API-Key: sk_live_...

{
  "campaignId": "search-xyz",
  "status": "CAMPAIGN_PAUSED",
  "action": "paused"
}

Error code	When
`validation_error`	Campaign is not `CAMPAIGN_IN_PROGRESS`
`not_found`	Unknown campaign

Tool: pause_campaign.