campaigns

Pause one campaign (its remaining steps are held; `resume` continues it), or stop only chosen leads in it for good.

No endpoint ends or deletes a campaign: to stop one for good, pause it and never resume it (nothing else resumes a paused campaign). Stopping every lead with leadEmails leaves the campaign active in GET /campaigns.

post/campaigns/{id}/pause

Request

  • Base URL: https://api.coldrig.dev
  • URL: https://api.coldrig.dev/campaigns/{id}/pause
  • Auth: HTTP bearer

Path parameters

idstring required

The MCP tool campaign_results takes this same identifier as a campaignId argument (there is no URL path in MCP tool calls).

Request body

leadEmailsstring[]

Stop only these leads in this campaign (any capitalisation); the campaign keeps running. Omit the body to pause the whole campaign. An empty list is refused (400), never read as "pause everything".

Response

Paused (paused true), or the named leads stopped (paused false).

pausedboolean

Changes

No recorded changes to this operation across all 2 revisions of this API.