Skip to main content
PUT
Only the fields you send are changed. Read-only fields such as status, sent_at, or created_at are ignored. 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. You can send this value back unchanged. Read the settings from the top-level smart_delivery field.
integer
required
Campaign ID.
string
required
Campaign title. Maximum 255 characters.
string
Sender’s name. Maximum 150 characters. Send null to clear it.
string
Sender’s email address.
string
Reply-to email address.
string
Campaign subject line. Maximum 255 characters. Send null to clear it.
string
Preheader text shown after the subject line in the inbox. Maximum 255 characters. Send null to clear it.
string
Google Analytics campaign name. Send null to clear it.
string
HTML content of the campaign. When you send it, it must not be empty.
integer
ID of a template to copy into the campaign. The template content replaces the campaign content. When you send the ID of the template the campaign already uses, the campaign content stays unchanged.
array|object
Array of list IDs or an object with segments. The current smart delivery settings of the campaign are kept.
string
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 current settings stay unchanged. Send null or {"sending_policy_id": "unlimited"} to turn smart delivery off.