get_drip
Fetch ONE drip campaign in full: every step with its delay and content, a summary of the audience, and the sending settings. Read-only. The drip object is passed through exactly as the API sends it, in PascalCase, so read drip.Status and drip.BlockedReason before offering the user a pause or resume, and drip.StaffHold before promising anything will send. Each entry of drip.Steps carries StepToken, Name, Delay (Unit and Value) and Content (Subject, Preheader, Blocks); the drip also carries Audience and Settings. The documented field table also lists Trigger (join, existing or both), Settings (Language, SendWindow, ExitOnClick, ExitOnWin, MaxEnrollmentsPerDay and HasTemplate) and Audience (Sources and AcquisitionChannels, plus how many Groups, Lists and Agents are selected — counts, not tokens). One field is absent from that table and was seen on a live drip on 2026-10-13: Origin. Settings.SendWindow limits the hours and days anything goes out. What happens to someone who enters OUTSIDE that window is neither documented nor observed — whether they are enrolled and simply wait, or not enrolled at all — so never tell a user which of the two it will be. Step numbering is NOT consistent across this category: drip.Steps[].Index here is 0-BASED — verified against a live two-step drip on 2026-10-12, not just documented — and so is steps[].Index in fetch_drip_report, while NextStep in fetch_drip_enrollments and the Step on each top_links entry of fetch_drip_report are 1-BASED. Index N is the same step as NextStep N+1. Convert before quoting one against the other, and give the user a step number in one scheme only. Step content comes back with its wildcards unresolved, exactly as written — they look like [FIRST_NAME] and are filled per contact at send time: never show a raw wildcard as if it were the final copy, and never treat one as a typo to fix. Account-gated, and the two sides of this category are gated differently: the reads need only the Drip Marketing module, while pause_drip, resume_drip and remove_drip_contact need Drip Marketing plus Send Message. 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) |