Campaigns

Create a campaign

Created in draft. Audience is everyone (all), a segment (segment + segmentId), or ad-hoc conditions (filter).

post/v1/campaigns

Request

  • Base URL: https://api.volanea.com
  • URL: https://api.volanea.com/v1/campaigns
  • Auth: HTTP bearer

Request body

namestring required
subjectstring required
previewTextstring nullable

Preheader — the preview line after the subject in the inbox. Supports {{variable}} placeholders.

bodystring required

HTML with {{variable}} placeholders.

fromEmailstring email required
fromNamestring
replyTostring email nullable

Sets the Reply-To header on every send.

audience'all' | 'segment' | 'filter'
segmentIdstring

Required when audience is "segment".

abSubjectBstring

Subject-line B for an A/B experiment; the winner is auto-sent to the remainder.

abSamplePctinteger

Percent of the audience used for the A/B sample (default 20).

Response

Created.

campaignIdstring required
projectIdstring
namestring required
subjectstring required
previewTextstring nullable

Preheader — the preview line inboxes show after the subject. Injected as a hidden block at the top of the body at send time.

bodystring required
fromNamestring nullable
fromEmailstring email required
replyTostring email nullable

Becomes the Reply-To header when set.

status'draft' | 'scheduled' | 'sending' | 'sent' | 'cancelled' required
audience'all' | 'segment' | 'filter' required
segmentIdstring nullable
abSubjectBstring nullable
abSamplePctinteger nullable
abDecideAtstring date-time nullable
abWinner'a' | 'b' | 'null' nullable
scheduledForstring date-time nullable
sentAtstring date-time nullable
totalRecipientsinteger
deliveredinteger
openedinteger
clickedinteger
bouncedinteger
complainedinteger
unsubscribedinteger
createdAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.