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.
Internal campaign name
Email subject line
Display name shown in the From: header
Optional Reply-To email address. Must be a valid email if provided.
HTML body of the email
Sender profile ID
Smart list ID whose rows become recipients
Field mapping for resolving recipient email from a list row
Schedule type (one of: now, scheduled)
ISO timestamp at which to send
IANA timezone name
Response
The updated marketing campaign
Marketing campaign object
Campaign ID
Company this campaign belongs to
User ID that created the campaign
Internal campaign name
Email subject line
Display name shown in the From: header
Reply-To email address used on outgoing emails
HTML body of the email
Sender profile ID
Smart list ID whose rows become recipients
Field mapping for resolving recipient email from a list row
Schedule type (now, scheduled)
ISO timestamp at which sending begins (for scheduled campaigns)
IANA timezone used to interpret scheduledAt
Campaign status (draft, scheduled, sending, sent, failed, cancelled)
Number of recipients the email has been sent to
Number of recipients that failed to send
Number of list rows skipped (missing email, duplicate, etc.)
Total rows in the associated smart list at read time
ISO timestamp when sending started
ISO timestamp when sending completed
ISO timestamp when the campaign was created
ISO timestamp when the campaign was last updated
Summary of the associated smart list
Summary of the sender profile

