Skip to main content
POST
For list segments selection instead of a whole recipient list, use "recepient_lists": {"segments": [{"id": "segment_id", "list": 14}]}. Segment IDs can be obtained from the Show list detail endpoint. Once smart delivery is set on a campaign, the response returns recepient_lists in the segments format, with the smart delivery settings inside the first segment. The segments format stays after you turn smart delivery off. Read the settings from the top-level smart_delivery field instead.
string
required
Campaign title. Maximum 255 characters.
string
Sender’s name. Maximum 150 characters.
string
Sender’s email address.
string
Reply-to email address.
string
Campaign subject line. Maximum 255 characters.
string
HTML content of the campaign. When you send it, it must not be empty.
array|object
Array of list IDs or an object with segments. See the example above for the segments format.
string
default:"email"
Campaign type. Allowed values: email, sms, whatsapp, push_notification. Your account must have the channel enabled, otherwise the request fails with 403.
object
Smart delivery settings of the campaign. Smart delivery skips subscribers who would receive too many emails. Send either sending_policy_id, or the manual limits. When you send sending_policy_id, the manual limits are ignored. When you omit smart_delivery, the campaign gets the default sending policy of your account. Send null or {"sending_policy_id": "unlimited"} to turn smart delivery off.