Skip to main content
POST
Create a campaign

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
name
string
required

Campaign name.

Example:

"Summer Outreach"

emailAccountIds
string[]

Public-facing email account IDs to link as sending addresses.

steps
object[]

Steps to create inline with the campaign.

contactIds
integer[]

Contact IDs to enroll in the campaign (max 500).

Maximum array length: 500
maxActiveContacts
integer

Maximum number of contacts that may be actively engaged in the campaign at one time. Must be set to a value greater than 0 before the campaign can be started via POST /campaigns/{id}/actions (action START). Requires the Max Active Contacts feature to be enabled for your organization.

Required range: x >= 1
Example:

100

Response

The created campaign with its steps and the count of contacts added.

success
boolean
Example:

true

data
object