Sign in
Campaigns

Create

Create a new campaign

post/campaigns/create

Headers

X-Batch-Projectstring required

The unique project key, identifying a project on the Batch platform

Request body

namestring required

Display name of the campaign on the dashboard

state'DRAFT' | 'RUNNING' | 'STOPPED' required

State of the campaign to create. Draft campaigns are not sent until they are started (updated to RUNNING). Stopped campaigns are paused and can be resumed by updating them to RUNNING.

send_rateinteger

Determines the maximum number of messages to be sent per minute.

labelsstring[]

An array of labels to assign to the campaign for organizational and capping purposes. Limited at 5 labels per campaign.

Response

Request successful, campaign created

idstring required

The campaign id associated with the campaign to use for further requests.

Changes