Sign in

v1

latestOpenAPI 3.0.32026-08-06561563.5 KB
Campaigns

Update a draft campaign

Only draft campaigns (not yet sent) can be updated. All fields are optional.

patch/campaigns/{id}

Request body

titlestring
subjectstring
preview_textstring nullable

Inbox preview snippet. Pass null to clear.

htmlstring
from_namestring
from_emailstring email
scheduled_atstring date-time nullable

Set to null to unschedule, or a datetime to schedule

listsinteger[]

Replaces all list assignments

excluded_listsinteger[]

Replaces the excluded lists (contacts in these lists are removed from the send).

to_contact_tagsinteger[]

Replaces the included tag audience (contacts carrying these tags receive the campaign).

excluded_contact_tagsinteger[]

Replaces the excluded tag audience (contacts carrying these tags are removed from the send).

Response

Campaign updated 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