Update a step
Changes a step in place. Send only the fields to change; the rest keep their values. Position is not editable here: use PUT /v2/sequencer/sequences/{sequence_id}/steps/reorder.
The resulting step is checked against the same rules as adding a step (400 when broken). Changing step_type clears what no longer applies: leaving call drops call_purpose, and leaving auto_email/manual_email drops templates and sets new_thread to false. No field may be null. templates, when sent, replaces the whole list and must hold 1 to 10 entries.
Allowed while people are in the sequence: anyone who has not reached the step yet gets the new version, and a task the step already created keeps the note, priority and draft it was created with. Safe to retry. user_id must be the author, the team owner or a team admin. Counts toward the Sequencer writes rate limit.
Example
Wait three days before this step instead of two, and raise its priority:Rules
- The step as it would be after the change is checked against the same rules as Add a step, and a broken rule is a 400.
- A change that makes a different
auto_emailstep start a thread, such as changing the first email step’sstep_type, is also a 400 when that step has a template with no subject. - Changing
step_typeclears what no longer applies: moving away fromcalldropscall_purpose, and moving away fromauto_emailormanual_emaildropstemplatesand setsnew_threadtofalse. templatesreplaces the step’s whole list and must hold 1 to 10 entries. To take a template off a step, send the list without it.- No field may be
null.
Editing a running sequence
Editing a step is allowed while people are in the sequence. Anyone who has not reached the step yet gets the new version. A task the step already created keeps the note, priority and draft it was created with. Sending the same body twice leaves the same result, so a retry is safe.user_id must be the sequence’s
author, the team owner or a team admin.Authorizations
Team-scoped API key generated in the Salesfinity dashboard under Settings → Connections → API & Webhooks. A missing or invalid key returns HTTP 403.
Path Parameters
24-character sequence id.
24-character step id.
Body
The team member making the change. Must be the sequence's author, the team owner or a team admin, and have an active plan or seat. A 24-character hexadecimal ID.
"507f1f77bcf86cd799439011"
auto_email sends an email on its own; manual_email, call and task create a task for the rep who owns the enrollment. Changing the type clears what no longer applies: leaving call drops call_purpose, and leaving auto_email/manual_email drops templates and sets new_thread to false.
auto_email, manual_email, call, task Required on an interval sequence, refused on a date sequence. Seconds to wait after the previous step finished (an email sent, or a task completed or skipped); for the first step, after enrollment. Whole number.
x >= 0Required on a date sequence, refused on an interval sequence. ISO 8601 date-time when the step comes due.
Step label, up to 200 characters. Becomes the title of the task the step creates.
200auto_email and manual_email only. true starts a new email thread with this step's template subject; otherwise the email replies in the previous email's thread and the template's subject is not sent. The first email step always starts a thread.
Up to 2,000 characters, copied onto the task the step creates.
2000high, medium, low Seconds after the task is created at which a still-open task expires and the enrollment moves on. Whole number. Omit to let tasks wait indefinitely.
x >= 0call steps only.
auto_email and manual_email only; auto_email needs at least one. 1 to 10 templates, each on your team (archived ones are accepted), picked by weight each time the step runs. Replaces the step's whole list.
10Response
The updated step.
One step of a cadence.
24-character hexadecimal id.
"507f1f77bcf86cd799439011"
The sequence the step belongs to (24-character id).
"507f1f77bcf86cd799439011"
The team that owns the step (24-character id).
1-based position in the cadence. Steps run in this order; change it with PUT /v2/sequencer/sequences/{sequence_id}/steps/reorder.
auto_email sends an email on its own. manual_email creates a task with the email drafted from a template, for the rep to edit and send. call creates a call task. task creates a to-do. Tasks go to the rep who owns the enrollment.
auto_email, manual_email, call, task On an interval sequence: seconds to wait after the previous step finished (an email sent, or a task completed or skipped) before this step comes due. For the first step, the wait after enrollment. Absent on a date sequence.
On a date sequence: when the step comes due. Absent on an interval sequence.
Step label. Becomes the title of the task the step creates.
Email steps: true starts a new email thread with this step's template subject; false replies in the previous email's thread, so the template's subject is not sent. The first email step always starts a thread.
Note copied onto the task the step creates.
Priority copied onto the task the step creates. Defaults to medium.
high, medium, low Seconds after the task is created (when the step comes due) at which a still-open task expires and the enrollment moves on to the next step. Absent means tasks wait indefinitely.
Email steps: the templates to pick from, by weight. Empty for call and task steps.
Call steps only: the call purpose set on the step. Absent when none is set.
Number of deliveries from this step, counted as events. Rebuilt every 15 minutes.
Number of opens from this step, counted as events. Rebuilt every 15 minutes.
Number of link clicks from this step, counted as events. Rebuilt every 15 minutes.
Number of replies from this step, counted as events. Rebuilt every 15 minutes.
Number of bounces from this step, counted as events. Rebuilt every 15 minutes.
Number of opt-outs from this step, counted as events. Rebuilt every 15 minutes.
Number of failed sends from this step, counted as events. Rebuilt every 15 minutes.
Times this step ran and produced work: emails sent plus tasks created. Rebuilt every 15 minutes.
When the step was created.
When it last changed.