Skip to main content
PATCH
Update a step
Changes a step in place. Its position is not editable here — use reorder, which is refused while enrollments are live.

Authorizations

x-api-key
string
header
required

Team-scoped API key generated in the Salesfinity dashboard under Settings -> Connections & API. A missing or invalid key returns HTTP 403.

Path Parameters

sequence_id
string
required

24-character sequence id.

step_id
string
required

24-character step id.

Body

application/json
user_id
string
required

The team member making the change.

step_type
enum<string>

auto_email sends itself; the other three create a task for the owning rep.

Available options:
auto_email,
manual_email,
call,
task
interval_seconds
number

Delay from the previous step, in seconds. For the first step it is measured from enrolment. Used when the sequence is interval.

date
string<date-time>

ISO 8601. Used when the sequence is date.

display_name
string
new_thread
boolean

Email steps: start a new thread rather than replying on the existing one.

task_note
string

Shown to the rep on the resulting task.

task_priority
enum<string>
default:medium
Available options:
high,
medium,
low
task_autoskip_delay
number

Seconds after the due date at which an untouched task is auto-skipped and the cadence moves on.

call_purpose
object
templates
object[]

Email steps only. Several templates are picked between by weight.

Response

Success.

One step of a cadence.

_id
string

24-character hexadecimal id.

Example:

"507f1f77bcf86cd799439011"

sequence
string

24-character hexadecimal id.

Example:

"507f1f77bcf86cd799439011"

order
integer

1-based position in the cadence.

step_type
enum<string>
Available options:
auto_email,
manual_email,
call,
task
interval_seconds
integer | null

Delay from the previous step.

date
string<date-time> | null
display_name
string | null
new_thread
boolean
task_note
string | null
task_priority
enum<string>
Available options:
high,
medium,
low
task_autoskip_delay
integer | null
templates
object[]