Schedule an email
postfjord_schedule_campaignSchedules a draft email to send now or at a set time to its stored audience or a chosen segment, optionally running an A/B subject test before delivery to real inboxes.
Instructions
Schedules a draft email at a time or now, to the audience stored on the draft (its tags or segment; everyone who confirmed when it has none), or to one saved segment given here. The email then goes to real inboxes and cannot be taken back once sent. Confirm the email, the audience and the time with the person first. Postfjord runs the same checks as the app: sending must be open for the workspace, the content must pass the checks, and this month must have emails left. A large first email waits for Postfjord to look at it (status review), and a first email goes to a small sample first. With abTest it tests a second subject line: a share of the list gets one of the two, split evenly, and after the wait the rest get the one with more unique clicks (or the one a person picks in the app). Each subject must reach at least 10 people. Needs the Schedule and publish level. On a retry after a timeout or error, send the same idempotency_key: the first answer comes back and nothing is made or sent twice.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| when | Yes | "now", or an ISO 8601 date-time with its time zone, e.g. 2026-10-06T09:00:00-05:00. | |
| abTest | No | An A/B test of the subject line. null switches off a test stored on the email; left out keeps it. | |
| segmentId | No | A saved segment id from postfjord_mail_overview. Leave out to use the audience stored on the draft. | |
| campaignId | Yes | ||
| idempotency_key | No | Your own id for this one action. Send the same one again only when you retry after a timeout. Left out, every call runs, so calling it again after a change publishes or schedules the new version. |