Skip to main content
POST
Create a new campaign

Authorizations

x-api-token
string
header
required

Body

application/json

The input required to create a campaign

name
string
required

The name of the campaign

startDate
string
required

The start date of the campaign

endDate
string
required

The end date of the campaign

status
enum<string>

Set the campaign status, by default will be set to draft if not provided

Available options:
archived,
draft,
expired,
live,
scheduled

Response

Successful response

A campaign

id
string
required

The id of the campaign

Pattern: ^[0-9a-fA-F]{24}$
organisationId
string
required

The id of the organisation the campaign belongs to

Pattern: ^[0-9a-fA-F]{24}$
name
string
required

The name of the campaign

startDate
string
required

The start date of the campaign

endDate
string
required

The end date of the campaign

status
enum<string>
required

The status of the campaign

Available options:
archived,
draft,
expired,
live,
scheduled
createdAt
string
required

The date the campaign was created

updatedAt
string
required

The date the campaign was last updated

createdBy
string
required

The user who created this campaign

Pattern: ^[0-9a-fA-F]{24}$
updatedBy
string
required

The user who last updated this campaign

Pattern: ^[0-9a-fA-F]{24}$