Sign in

v1

latestOpenAPI 3.0.3“Commons Clause” License Condition v1.02026-07-17231343.3 KB
campaigns

Add a new campaign

Add a new campaign. When the campaign is firstly created, it has a draft status. After a campaign has been created it can either be sent, scheduled or deleted. In order to send a campaign you will need to connect your AWS account.

post/campaigns

Request body

namestring required

The name of the new campaign, must be unique.

template_namestring required

The name of the template to be used for the campaign content.

Example request

{
  "name": "January Newsletter",
  "template_name": "HelloWorld"
}

Response

OK

idinteger

The ID of the resource.

created_atstring date-time

The date and time when the resource was created.

updated_atstring date-time

The date and time when the resource was last updated.

namestring

The name of the campaign.

status'draft' | 'scheduled' | 'sending' | 'sent'

The campaign's status.

started_atstring date-time

The date and time when the campaign was started.

completed_atstring date-time

The date and time when the campaign was completed (the e-mail has been sent to all of the subscribers).

Example response

{
  "id": 111,
  "name": "January Newsletter",
  "status": "draft",
  "template": {
    "id": 111,
    "name": "Welcome",
    "subject_part": "Welcome to Mailbadger {{name}}!"
  }
}