Skip to main content
POST
Create campaign

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

Campaign name.

automationId
string<uuid>
required

Automation that sends this campaign.

variables
object

Variable values passed into the campaign automation.

scheduledAt
string<date-time> | null

When the campaign is scheduled to run (ISO 8601), or null.

recurrence
object | null

Recurrence settings for scheduled campaigns.

Response

OK

success
enum<boolean>
required
Available options:
true
data
object
required