Skip to main content
PUT
Update 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.

stepId
integer
required

Numeric campaign step ID.

Body

application/json
dueDay
integer
required

Day of the campaign on which the step is due.

Required range: x >= 1
name
string

Step name.

description
string

Step description. An empty string is ignored, so a description cannot be cleared.

stepNumber
integer

New zero-based position of the step in the sequence. 0 is ignored; steps are renumbered by dueDay afterwards, so the stored position may differ from the value sent.

Required range: x >= 1
templateId
string

ID of an existing template to attach. When sent with templateData, it must be the step's current template, which is updated in place.

templateData
object

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

Response

The updated campaign step.

success
boolean
Example:

true

data
object