pause_drip
Pause an ACTIVE drip campaign: no new contact is enrolled and no step goes out until it is resumed. Reversible with resume_drip, which is why this needs no confirmation. Pausing is immediate and atomic, with one caveat to state up front: steps already handed to delivery still finish, so a message can land just after the pause — do not promise it stopped everything in flight. Contacts keep their place in the sequence. On success (verified live) the drip comes back with Status paused and PausedAt set, alongside released_units: the allowance reserved for queued messages that is handed back to the monthly balance while it is paused. It was 0 on a drip with nothing queued, which is correct and not a failure to report. Only an ACTIVE drip can be paused: every other status answers 409 with a message naming the status it is actually in — a draft answers "This drip cannot be paused: its status is "draft". Only an active drip can be paused." — quoted exactly, inner quotes included (verified live through this server on 2026-10-13) — and that refusal ALSO carries api_data.Status naming the status it is in, the first api_data ever observed on a drip refusal, and an already-paused drip answers 409 the same way and simply stays paused. Read that message back to the user instead of retrying. The action is recorded in the account log. Account-gated, and the two sides of this category are gated differently: this write needs BOTH the Drip Marketing module AND the Send Message module — two separate 403 messages, and either one missing fails the call — while the reads need only Drip Marketing. The gate was NOT observed on the test account, so on a 403 read back which module the API named instead of guessing. Drips are created, edited, activated and deleted ONLY in the Sweeppea app: those actions run a launch checklist (template, sender, 10DLC registration, content screening, plan allowance) that this API deliberately does not reproduce. There is no create endpoint and that is by design, not a gap — the API leaves these writes out on purpose (confirmed by the API maintainer, October 2026) — say so plainly instead of hunting for a workaround, and never propose or invent a tool for it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| drip_token | Yes | The drip campaign token (UUID v4) of a drip in status active |