Sign in

v1

latestOpenAPI 3.0.32026-08-06561563.5 KB
Campaigns

Create a new campaign

Creates a campaign as a draft. To send it, use the send endpoint or provide scheduled_at. Subject lines cannot start with "RE:" or "FWD:". At least one list is required if scheduled_at is provided.

post/campaigns

Request body

titlestring required
subjectstring required
preview_textstring nullable

Inbox preview snippet shown beneath the subject line. Optional.

htmlstring required

Email body HTML content

from_namestring required
from_emailstring email required
scheduled_atstring date-time

Schedule send time (omit for draft). Must include at least one list.

listsinteger[]

Array of list IDs to send to

excluded_listsinteger[]

List IDs whose contacts should be excluded from the send. Exclusion wins over inclusion.

to_contact_tagsinteger[]

Tag IDs whose contacts should receive the campaign. Can be combined with lists.

excluded_contact_tagsinteger[]

Tag IDs whose contacts should be excluded from the send. Exclusion wins over inclusion.

Response

Campaign created successfully

idinteger
titlestring required
subjectstring required
preview_textstring nullable

Inbox preview snippet shown beneath the subject line in most email clients.

htmlstring required
from_namestring required
from_emailstring email required
scheduled_atstring date-time nullable
sent_atstring date-time nullable
timezonestring
created_atstring date-time
updated_atstring date-time