Skip to main content
POST
Create a campaign step

Authorizations

Authorization
string
header
required

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

Path Parameters

id
integer
required

Numeric campaign ID.

Body

application/json
type
string
required

Step type (e.g. EMAIL, CALL, TASK).

Example:

"EMAIL"

name
string
required

Step name.

Example:

"Welcome message"

dueDay
integer
required

Day offset (>= 1) on which the step is due.

Required range: x >= 1
Example:

1

description
string

Step description.

templateId
integer

Template ID to attach to the step.

templateData
object

Inline template data for the step.

Response

The created campaign step.

success
boolean
Example:

true

data
object