campaigns
Create Campaign
post/api/v1/campaigns
Request body
namestring required
source_list_idstring uuid nullable
enrollment_type'list_snapshot' | 'trigger'
How recipients enter a campaign.
list_snapshot freezes the audience from a ContactList at creation. trigger enrolls live off interaction events (evaluator lands in a later PR); modeled now so trigger campaigns need no rework.
approval_mode'autonomous' | 'review'
Whether drafts send autonomously or wait for human review.
goalstring nullable
template_keystring nullable
offerstring nullable
promo_codestring nullable
stay_window_startstring date nullable
stay_window_endstring date nullable
cta_labelstring nullable
email_background_colorstring nullable
email_accent_colorstring nullable
email_logo_urlstring nullable
sender_identity_idstring uuid nullable
Response
Successful Response
idstring uuid required
tenant_idstring uuid required
namestring required
status'draft' | 'generating' | 'review' | 'scheduled' | 'sending' | 'sent' | 'paused' | 'failed' required
Lifecycle of a campaign (see state_machine.LEGAL_TRANSITIONS).
enrollment_type'list_snapshot' | 'trigger' required
How recipients enter a campaign.
list_snapshot freezes the audience from a ContactList at creation. trigger enrolls live off interaction events (evaluator lands in a later PR); modeled now so trigger campaigns need no rework.
approval_mode'autonomous' | 'review' required
Whether drafts send autonomously or wait for human review.
source_list_idstring uuid nullable
goalstring nullable
template_keystring nullable
offerstring nullable
promo_codestring nullable
stay_window_startstring date nullable
stay_window_endstring date nullable
cta_labelstring nullable
email_background_colorstring nullable
email_accent_colorstring nullable
email_logo_urlstring nullable
sender_identity_idstring uuid nullable
created_by_user_idstring uuid nullable
audience_countinteger required
drafted_countinteger required
approved_countinteger required
sent_countinteger required
delivered_countinteger required
opened_countinteger required
clicked_countinteger required
replied_countinteger required
positive_countinteger required
bounced_countinteger required
converted_countinteger required
revenue_centsinteger required
scheduled_atstring date-time nullable
sending_started_atstring date-time nullable
sent_atstring date-time nullable
archived_atstring date-time nullable
created_atstring date-time required
updated_atstring date-time required
Changes
No recorded changes to this endpoint across all 1 revision of this API.