Sign in
Campaigns

Create a campaign

Create a new draft campaign. An empty email message is created automatically and its emailMessageId is returned. Use the /email-messages/{emailMessageId} endpoint to set subject, sender, preview text, and LMX content. The audience (mailing list, segment, or filter), group, and scheduling can be set on create or later via update.

post/v1/campaigns

Request body

namestring required

The campaign name.

campaignGroupIdstring

The ID of the group to add this campaign to. Defaults to the team's default group when omitted.

mailingListIdstring nullable

The ID of the mailing list to send to.

audienceSegmentIdstring nullable

The ID of an audience segment. Setting this clears any audienceFilter.

Example request

{
  "name": "Spring announcement"
}

Response

Campaign created.

idstring required
namestring required
statusstring required
createdAtstring date-time required
updatedAtstring date-time required
emailMessageIdstring nullable required

The ID of the empty email message created for this campaign. Use /email-messages/{emailMessageId} to set its fields and LMX content.

emailMessageContentRevisionIdstring nullable required

The contentRevisionId of the newly created email message. Pass this as expectedRevisionId on your first update.

campaignGroupIdstring nullable required
mailingListIdstring nullable required
audienceSegmentIdstring nullable required

Example response

{
  "status": "Draft"
}

Changes