List and read your campaigns, make and edit drafts, and cancel one that is scheduled but has not started sending.
The API makes and edits drafts, and never sends one. A draft is sent by a person in PristineSend, or asked for through Bulk send, which holds for explicit approval by the workspace owner before a single recipient is enqueued. An endpoint that created and sent a campaign in one call would go around that, so none exists. Making and editing drafts is on Campaign drafts.
Listing and reading require campaigns:read. Cancelling requires campaigns:cancel, a scope named for what it can do and nothing else; it can stop a send, never start one.
Status, timing and identity. name is the campaign's subject line, which is what the app calls it, and null when the subject is blank. version is raised each time a draft's email, sender or topic changes, open_notes counts the notes a person left on it for their AI that nobody has resolved, and app_url is where it opens in PristineSend: the editor, its report once it is sent, or the approval screen while a bulk send waits there. The email itself is not in the list: read one campaign with GET /api/v1/campaigns/{id}.
GET /api/v1/campaigns — newest first, cursor-paginated (see Pagination). status keeps one status: draft, scheduled, sending, sent, paused, cancelled or pending_approval.
GET /api/v1/campaigns/{id}/links — every link in the campaign that was clicked, ranked most-clicked first. Requires campaigns:read.
This is a leaderboard, not a paginated collection, so there is no cursor. limit takes the top N and total_links tells you how many distinct links were clicked — so a truncated list is visible as one.
Unsubscribe links are never in data. They are counted in opt_out_clicks and never named, because those URLs carry a live one-click opt-out token — returning one would let a read-only key opt a recipient out. Two consequences worth planning for: an empty data beside a non-zero opt_out_clicks means the only thing anyone pressed was the way out, which is not the same as nobody clicking; and opt_out_clicks counts presses on an opt-out link rather than completed unsubscribes, so quote unsubscribed from Metrics for that.
clicks counts presses and unique_clicks counts people, so any rate you compute against the number of readers must use unique_clicks — otherwise one enthusiastic recipient can push it over 100%.
reconstructed_clicks above zero means some of these totals were rebuilt from an older record that kept only the most recent click per recipient, so report them as a minimum. null there means we could not determine it, which is not the same as 0.
A transactional message belongs to no campaign, so its clicks are read from GET /api/v1/emails/{id}/clicks instead.
POST /api/v1/campaigns/{id}/cancel — only a campaign in scheduled can be cancelled.
The check is race-safe. If the send worker claimed the campaign moments before your request, nothing is cancelled and you get a 404 — rather than a success for something that did not happen.
One narrow window remains and is worth knowing about: if the worker had already claimed a batch when the cancel landed, that one batch may still go out. Every subsequent batch is stopped.
A campaign that cannot be cancelled — already sending, already sent, or not yours — returns 404 not_found. These are deliberately the same response: telling them apart would confirm the existence of another workspace's campaign id. See Errors.