Update a marketing campaign. Editable only while the campaign is in draft,
scheduled, cancelled, or failed status. Editing a scheduled campaign drops it back to draft until you re-schedule it.
Authorizations
Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.
Path Parameters
Body
Fields to update (include only fields you want to change)
Request body for updating a marketing campaign (only include fields to change). Editable only while the campaign is in draft, scheduled, cancelled, or failed status.
HTML body of the email
Field mapping for resolving recipient email from a list row
Display name shown in the From: header
Smart list ID whose rows become recipients
Internal campaign name
Optional Reply-To email address. Must be a valid email if provided.
Schedule type (one of: now, scheduled)
ISO timestamp at which to send
Sender profile ID
Email subject line
IANA timezone name
Response
The updated marketing campaign
Marketing campaign object
HTML body of the email
Company this campaign belongs to
ISO timestamp when sending completed
ISO timestamp when the campaign was created
Number of recipients that failed to send
Field mapping for resolving recipient email from a list row
Display name shown in the From: header
Campaign ID
Smart list ID whose rows become recipients
Internal campaign name
Reply-To email address used on outgoing emails
Schedule type (now, scheduled)
ISO timestamp at which sending begins (for scheduled campaigns)
Summary of the sender profile
Sender profile ID
Number of recipients the email has been sent to
Number of list rows skipped (missing email, duplicate, etc.)
Summary of the associated smart list
ISO timestamp when sending started
Campaign status (draft, scheduled, sending, sent, failed, cancelled)
Email subject line
IANA timezone used to interpret scheduledAt
Total rows in the associated smart list at read time
User ID that created the campaign
ISO timestamp when the campaign was last updated

