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
Email subject line sent to recipients
Display name shown in the From: header
Optional Reply-To email address. Must be a valid email if provided.
HTML body of the email
ID of the SequenceSenderProfile used to send this campaign
ID of the smart list whose rows become recipients
Field mapping for resolving recipient email from a list row, e.g. {"email": ["Email", "Work Email"]}
Schedule type (one of: now, scheduled). Default: now
ISO timestamp at which to send (required when scheduleType is "scheduled")
IANA timezone name used to interpret scheduledAt
Company ID (falls back to the authenticated user's current company)
Response
The created marketing campaign (in draft status)
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

