campaigns

Create or prepare a campaign (frozen draft)

Idempotent by campaignKey: an existing campaign must have identical content (otherwise 409). Marketing campaigns need the marketing footer configured first. Providing audience freezes an audience snapshot.

post/campaigns

Request

  • Base URL: https://api.mailly.site (the document declares no server; this is the origin it was published from)
  • URL: https://api.mailly.site/campaigns
  • Auth: HTTP bearer

Request body

campaignKeystring
namestring
emailType'transactional' | 'lifecycle' | 'marketing'

Default marketing

senderEmailstring
fromNamestring
replyTostring
topicstring
subjectstring
htmlstring
textstring
frequencyCapDaysnumber
frequencyCapMaxnumber
topicExclusionDaysnumber
recipientReasonstring
templateKeystring
templateVersionnumber
audienceDefinitionunknown
audienceobject

Frozen audience selection

sourceAppstring
utmobject
businessGoalstring

Response

Created

successboolean required
campaignobject required
audienceSnapshotobject nullable required

Changes

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