Create a new marketing campaign in draft status.
A newly created campaign is always in draft status and does not send anything until you call /schedule (to queue it for a future time) or /send-now (to begin sending immediately). You can keep editing the campaign with PATCH until it enters sending or sent status.
Authorizations
Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.
Body
Campaign fields. Only name is required up front.
Request body for creating a marketing campaign. Only name is required; all other fields can be filled in later via PATCH or by calling /schedule or /send-now.
Internal campaign name
HTML body of the email
Company ID (falls back to the authenticated user's current company)
Field mapping for resolving recipient email from a list row, e.g. {"email": ["Email", "Work Email"]}
Display name shown in the From: header
ID of the smart list whose rows become recipients
Optional Reply-To email address. Must be a valid email if provided.
Schedule type (one of: now, scheduled). Default: now
ISO timestamp at which to send (required when scheduleType is "scheduled")
ID of the SequenceSenderProfile used to send this campaign
Email subject line sent to recipients
IANA timezone name used to interpret scheduledAt
Response
The created marketing campaign (in draft status)
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

