campaigns

Generate Campaign Drafts Route

Kick off personalized-draft generation (fans out over pending recipients).

post/api/v1/campaigns/{campaign_id}/generate

Path parameters

campaign_idstring uuid required

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

Changed in 1 of the 4 revisions of this API.2

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog