Skip to main content
POST
Create a campaign

Authorizations

Authorization
string
header
required

An API token. The "read" ability: GET routes only. "read + write": every route.

Headers

Idempotency-Key
string

Replay a write safely: the same key gives back the first answer for 24 hours (header Idempotent-Replay: true).

Maximum string length: 255

Body

application/json
name
string
required

Seen by the team only.

Maximum string length: 255
list
string<uuid>
required
editor
enum<string>
required
Available options:
blocks,
markdown,
html,
mjml
subject
string | null
Maximum string length: 255
content
string | null

500,000 characters at most. For "blocks", the editor's JSON document.

track_opens
boolean
default:true
track_clicks
boolean
default:true

Response

The campaign that was created.

data
object