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.

Scopes

publicAPI.v2.all

Public API v2

Path Parameters

id
integer
required

Numeric campaign ID.

Body

application/json
type
enum<string>
required

Step type.

Available options:
auto-email,
manual-email,
call,
linkedin-message,
custom
name
string
required

Step name.

Example:

"Intro email"

dueDay
integer
required

Day of the campaign on which the step is due.

Required range: x >= 1
Example:

1

description
string

Step description.

templateId
string

ID of an existing template to attach. auto-email steps require templateId or templateData.template; the two cannot be combined.

templateData
object

Inline template content. Without templateId it is saved as a new template and attached to the step.

Response

The created campaign step.

success
boolean
Example:

true

data
object