pause
Pause ONE campaign: its status → 'paused', so the tick schedules no further steps (already-sent mail is unaffected; there is no resume tool). Input: campaignId. Returns { paused: true }. 404 if not found. Add leadEmails to stop ONLY those leads in this campaign instead (e.g. a donor who already gave): their remaining steps are cancelled, the campaign keeps running for everyone else, and nobody is suppressed — returns { paused: false }. Matching ignores capitalisation; if any address is not a lead of this campaign, nothing is stopped and the call is refused (404) naming them. Use pause_all to pause every active campaign at once.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| campaignId | Yes | The campaign id returned by launch_campaign. | |
| leadEmails | No | Optional. Stop ONLY these leads in this campaign (any capitalisation): their remaining steps are cancelled, the campaign keeps running for everyone else, and nobody is added to the suppression list. Every address must be a lead of this campaign, or nothing is stopped and the call is refused naming the ones that are not. Omit to pause the whole campaign. |