Generated from Postwind commit a19b2e4 OpenAPI 0.1.0 synced

Campaigns

Campaigns: a template sent to lists of the project

The same group in the HTTP API

ToolConfirmProjectWhat it does
list_campaignsoptionalLists the campaigns of a project, oldest first, at most 100 per call, optionally of one status.
create_campaignoptionalCreates a campaign in a project, a draft: one message template sent to one or more of its lists.
get_campaignoptionalReads one campaign: its status, lists, template, sender and the other fields, and what its launch fixed.
update_campaignoptionalChanges a campaign’s fields: name, lists, template, sender, reply-to, subject, transport, tracking, throttle.
cancel_campaignconfirmoptionalCancels a scheduled, sending or paused campaign for good: its letters not sent yet are cancelled; letters already sent stay sent.
launch_campaignconfirmoptionalLaunches a draft campaign: its recipients’ messages are queued and sending starts.
pause_campaignoptionalPauses a sending campaign: no new letter of it goes out until resume_campaign; the letters under way finish.
preflight_campaignoptionalShows what launching a draft campaign would do now: its recipients after deduplication and suppression, its sender’s sending domain with its warnings, its…
resume_campaignoptionalResumes a paused campaign: it is sending again and its remaining letters go out.
get_campaign_statsoptionalReads where a campaign’s sending is: its status, how many recipients its launch wrote, and its deliveries by status (queued, deferred, sent, bounced…