Add a step

curl --request POST \
  --url https://client-api.salesfinity.co/v2/sequencer/sequences/{sequence_id}/steps \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "user_id": "507f1f77bcf86cd799439011",
  "step_type": "auto_email",
  "interval_seconds": 172800,
  "display_name": "Follow-up email",
  "templates": [
    {
      "template": "6650c2b7a9b8c7d6e5f40456",
      "weight": 1
    },
    {
      "template": "6650c2b7a9b8c7d6e5f40457",
      "weight": 3
    }
  ]
}
'

import requests

url = "https://client-api.salesfinity.co/v2/sequencer/sequences/{sequence_id}/steps"

payload = {
    "user_id": "507f1f77bcf86cd799439011",
    "step_type": "auto_email",
    "interval_seconds": 172800,
    "display_name": "Follow-up email",
    "templates": [
        {
            "template": "6650c2b7a9b8c7d6e5f40456",
            "weight": 1
        },
        {
            "template": "6650c2b7a9b8c7d6e5f40457",
            "weight": 3
        }
    ]
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    user_id: '507f1f77bcf86cd799439011',
    step_type: 'auto_email',
    interval_seconds: 172800,
    display_name: 'Follow-up email',
    templates: [
      {template: '6650c2b7a9b8c7d6e5f40456', weight: 1},
      {template: '6650c2b7a9b8c7d6e5f40457', weight: 3}
    ]
  })
};

fetch('https://client-api.salesfinity.co/v2/sequencer/sequences/{sequence_id}/steps', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://client-api.salesfinity.co/v2/sequencer/sequences/{sequence_id}/steps",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'user_id' => '507f1f77bcf86cd799439011',
    'step_type' => 'auto_email',
    'interval_seconds' => 172800,
    'display_name' => 'Follow-up email',
    'templates' => [
        [
                'template' => '6650c2b7a9b8c7d6e5f40456',
                'weight' => 1
        ],
        [
                'template' => '6650c2b7a9b8c7d6e5f40457',
                'weight' => 3
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://client-api.salesfinity.co/v2/sequencer/sequences/{sequence_id}/steps"

	payload := strings.NewReader("{\n  \"user_id\": \"507f1f77bcf86cd799439011\",\n  \"step_type\": \"auto_email\",\n  \"interval_seconds\": 172800,\n  \"display_name\": \"Follow-up email\",\n  \"templates\": [\n    {\n      \"template\": \"6650c2b7a9b8c7d6e5f40456\",\n      \"weight\": 1\n    },\n    {\n      \"template\": \"6650c2b7a9b8c7d6e5f40457\",\n      \"weight\": 3\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://client-api.salesfinity.co/v2/sequencer/sequences/{sequence_id}/steps")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"507f1f77bcf86cd799439011\",\n  \"step_type\": \"auto_email\",\n  \"interval_seconds\": 172800,\n  \"display_name\": \"Follow-up email\",\n  \"templates\": [\n    {\n      \"template\": \"6650c2b7a9b8c7d6e5f40456\",\n      \"weight\": 1\n    },\n    {\n      \"template\": \"6650c2b7a9b8c7d6e5f40457\",\n      \"weight\": 3\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://client-api.salesfinity.co/v2/sequencer/sequences/{sequence_id}/steps")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user_id\": \"507f1f77bcf86cd799439011\",\n  \"step_type\": \"auto_email\",\n  \"interval_seconds\": 172800,\n  \"display_name\": \"Follow-up email\",\n  \"templates\": [\n    {\n      \"template\": \"6650c2b7a9b8c7d6e5f40456\",\n      \"weight\": 1\n    },\n    {\n      \"template\": \"6650c2b7a9b8c7d6e5f40457\",\n      \"weight\": 3\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "_id": "6650fa11b2c3d4e5f6a7b804",
  "sequence": "6650c1f2a9b8c7d6e5f40123",
  "team": "64f1a2b3c4d5e6f7a8b9c0d1",
  "order": 4,
  "step_type": "auto_email",
  "interval_seconds": 172800,
  "display_name": "Follow-up email",
  "new_thread": false,
  "task_priority": "medium",
  "templates": [
    {
      "template": "6650c2b7a9b8c7d6e5f40456",
      "weight": 1
    },
    {
      "template": "6650c2b7a9b8c7d6e5f40457",
      "weight": 3
    }
  ],
  "deliver_count": 0,
  "open_count": 0,
  "click_count": 0,
  "reply_count": 0,
  "bounce_count": 0,
  "opt_out_count": 0,
  "failure_count": 0,
  "schedule_count": 0,
  "created_at": "2026-10-03T10:10:00.000Z",
  "updated_at": "2026-10-03T10:10:00.000Z"
}

{
  "message": "interval_seconds is required on an interval sequence",
  "error": "Bad Request",
  "statusCode": 400,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Only the sequence owner or a team admin can change this sequence",
  "error": "Forbidden",
  "statusCode": 403,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Sequence not found",
  "error": "Not Found",
  "statusCode": 404,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "This Idempotency-Key was already used with a different request body.",
  "error": "Conflict",
  "statusCode": 409,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "A sequence cannot have more than 50 steps",
  "error": "Unprocessable Entity",
  "statusCode": 422,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Rate limit of 300 requests per minute exceeded. Retry in 12s.",
  "error": "Too Many Requests",
  "statusCode": 429,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Internal server error",
  "error": "Internal Server Error",
  "statusCode": 500,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Sequencer service unreachable",
  "error": "Bad Gateway",
  "statusCode": 502,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Sequencer service timed out",
  "error": "Gateway Timeout",
  "statusCode": 504,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

Steps

Add a step

Adds a step at the end of the cadence; its order is the current number of steps plus one. Move it with PUT /v2/sequencer/sequences/{sequence_id}/steps/reorder. A sequence holds at most 50 steps.

The body is checked against the sequence (400 when a rule is broken): an interval sequence needs interval_seconds and refuses date, and a date sequence needs date and refuses interval_seconds. auto_email needs at least one template. templates and new_thread are only for auto_email and manual_email, and call_purpose only for call. Every template must be on your team; archived templates are accepted. LinkedIn, meeting and SMS exist as one-off task types but cannot be cadence steps.

Adding a step while people are in the sequence is allowed: anyone still partway through reaches it after the earlier steps, and anyone already finished does not. user_id must be the author, the team owner or a team admin. Send an Idempotency-Key: without one, a retry appends a second step. Counts toward the Sequencer writes rate limit.

POST

sequencer

sequences

{sequence_id}

steps

Add a step

curl --request POST \
  --url https://client-api.salesfinity.co/v2/sequencer/sequences/{sequence_id}/steps \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "user_id": "507f1f77bcf86cd799439011",
  "step_type": "auto_email",
  "interval_seconds": 172800,
  "display_name": "Follow-up email",
  "templates": [
    {
      "template": "6650c2b7a9b8c7d6e5f40456",
      "weight": 1
    },
    {
      "template": "6650c2b7a9b8c7d6e5f40457",
      "weight": 3
    }
  ]
}
'

import requests

url = "https://client-api.salesfinity.co/v2/sequencer/sequences/{sequence_id}/steps"

payload = {
    "user_id": "507f1f77bcf86cd799439011",
    "step_type": "auto_email",
    "interval_seconds": 172800,
    "display_name": "Follow-up email",
    "templates": [
        {
            "template": "6650c2b7a9b8c7d6e5f40456",
            "weight": 1
        },
        {
            "template": "6650c2b7a9b8c7d6e5f40457",
            "weight": 3
        }
    ]
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    user_id: '507f1f77bcf86cd799439011',
    step_type: 'auto_email',
    interval_seconds: 172800,
    display_name: 'Follow-up email',
    templates: [
      {template: '6650c2b7a9b8c7d6e5f40456', weight: 1},
      {template: '6650c2b7a9b8c7d6e5f40457', weight: 3}
    ]
  })
};

fetch('https://client-api.salesfinity.co/v2/sequencer/sequences/{sequence_id}/steps', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://client-api.salesfinity.co/v2/sequencer/sequences/{sequence_id}/steps",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'user_id' => '507f1f77bcf86cd799439011',
    'step_type' => 'auto_email',
    'interval_seconds' => 172800,
    'display_name' => 'Follow-up email',
    'templates' => [
        [
                'template' => '6650c2b7a9b8c7d6e5f40456',
                'weight' => 1
        ],
        [
                'template' => '6650c2b7a9b8c7d6e5f40457',
                'weight' => 3
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://client-api.salesfinity.co/v2/sequencer/sequences/{sequence_id}/steps"

	payload := strings.NewReader("{\n  \"user_id\": \"507f1f77bcf86cd799439011\",\n  \"step_type\": \"auto_email\",\n  \"interval_seconds\": 172800,\n  \"display_name\": \"Follow-up email\",\n  \"templates\": [\n    {\n      \"template\": \"6650c2b7a9b8c7d6e5f40456\",\n      \"weight\": 1\n    },\n    {\n      \"template\": \"6650c2b7a9b8c7d6e5f40457\",\n      \"weight\": 3\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://client-api.salesfinity.co/v2/sequencer/sequences/{sequence_id}/steps")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"507f1f77bcf86cd799439011\",\n  \"step_type\": \"auto_email\",\n  \"interval_seconds\": 172800,\n  \"display_name\": \"Follow-up email\",\n  \"templates\": [\n    {\n      \"template\": \"6650c2b7a9b8c7d6e5f40456\",\n      \"weight\": 1\n    },\n    {\n      \"template\": \"6650c2b7a9b8c7d6e5f40457\",\n      \"weight\": 3\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://client-api.salesfinity.co/v2/sequencer/sequences/{sequence_id}/steps")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user_id\": \"507f1f77bcf86cd799439011\",\n  \"step_type\": \"auto_email\",\n  \"interval_seconds\": 172800,\n  \"display_name\": \"Follow-up email\",\n  \"templates\": [\n    {\n      \"template\": \"6650c2b7a9b8c7d6e5f40456\",\n      \"weight\": 1\n    },\n    {\n      \"template\": \"6650c2b7a9b8c7d6e5f40457\",\n      \"weight\": 3\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "_id": "6650fa11b2c3d4e5f6a7b804",
  "sequence": "6650c1f2a9b8c7d6e5f40123",
  "team": "64f1a2b3c4d5e6f7a8b9c0d1",
  "order": 4,
  "step_type": "auto_email",
  "interval_seconds": 172800,
  "display_name": "Follow-up email",
  "new_thread": false,
  "task_priority": "medium",
  "templates": [
    {
      "template": "6650c2b7a9b8c7d6e5f40456",
      "weight": 1
    },
    {
      "template": "6650c2b7a9b8c7d6e5f40457",
      "weight": 3
    }
  ],
  "deliver_count": 0,
  "open_count": 0,
  "click_count": 0,
  "reply_count": 0,
  "bounce_count": 0,
  "opt_out_count": 0,
  "failure_count": 0,
  "schedule_count": 0,
  "created_at": "2026-10-03T10:10:00.000Z",
  "updated_at": "2026-10-03T10:10:00.000Z"
}

{
  "message": "interval_seconds is required on an interval sequence",
  "error": "Bad Request",
  "statusCode": 400,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Only the sequence owner or a team admin can change this sequence",
  "error": "Forbidden",
  "statusCode": 403,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Sequence not found",
  "error": "Not Found",
  "statusCode": 404,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "This Idempotency-Key was already used with a different request body.",
  "error": "Conflict",
  "statusCode": 409,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "A sequence cannot have more than 50 steps",
  "error": "Unprocessable Entity",
  "statusCode": 422,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Rate limit of 300 requests per minute exceeded. Retry in 12s.",
  "error": "Too Many Requests",
  "statusCode": 429,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Internal server error",
  "error": "Internal Server Error",
  "statusCode": 500,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Sequencer service unreachable",
  "error": "Bad Gateway",
  "statusCode": 502,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Sequencer service timed out",
  "error": "Gateway Timeout",
  "statusCode": 504,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

Adds a step at the end of the cadence. To put it somewhere else, add it and then reorder the steps. A sequence holds at most 50 steps.

Step types

`step_type`	When it comes due
`auto_email`	Sends an email on its own, picking one of the step’s `templates` by weight. Needs at least one template.
`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. display_name becomes the task’s title, and task_note and task_priority are copied onto it. LinkedIn, meeting and SMS exist as one-off task types but cannot be cadence steps.

Examples

A call on the day someone is enrolled:

curl -X POST https://client-api.salesfinity.co/v2/sequencer/sequences/6650c1f2a9b8c7d6e5f40123/steps \
  -H 'x-api-key: YOUR_API_KEY' -H 'content-type: application/json' \
  -H 'Idempotency-Key: 1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f' \
  -d '{
    "user_id": "507f1f77bcf86cd799439011",
    "step_type": "call",
    "interval_seconds": 0,
    "display_name": "Intro call",
    "task_priority": "high",
    "task_autoskip_delay": 172800
  }'

Two days later, an email that A/B tests two templates, sending the second three times as often:

curl -X POST https://client-api.salesfinity.co/v2/sequencer/sequences/6650c1f2a9b8c7d6e5f40123/steps \
  -H 'x-api-key: YOUR_API_KEY' -H 'content-type: application/json' \
  -H 'Idempotency-Key: 2d3e4f5a-6b7c-4d8e-9f0a-1b2c3d4e5f6a' \
  -d '{
    "user_id": "507f1f77bcf86cd799439011",
    "step_type": "auto_email",
    "interval_seconds": 172800,
    "templates": [
      { "template": "6650c2b7a9b8c7d6e5f40456", "weight": 1 },
      { "template": "6650c2b7a9b8c7d6e5f40457", "weight": 3 }
    ]
  }'

Rules

Each of these is a 400 naming the problem:

An interval sequence needs interval_seconds and refuses date. A date sequence needs date and refuses interval_seconds.
auto_email needs at least one template.
An auto_email step that starts a thread (the first email step, or one with new_thread: true) needs a subject on every template it uses. A step that replies in a thread does not.
templates and new_thread are only for auto_email and manual_email; call_purpose only for call.
Every template must be on your team. Archived templates are accepted.

A 51st step is refused with 422.

Things to know

Subjects and threads. An email step replies in the thread of the previous email unless you set new_thread: true, and a reply does not send its template’s subject. The first email step always starts a thread, so its template’s subject is the one the prospect sees.
Weights are relative. weight 0 keeps a template on the step but never picks it. An auto_email step whose templates all weigh 0 cannot send.
Adding to a running sequence. Allowed. People still partway through reach the new step after the earlier ones; people who already finished do not.
Retries. Without an Idempotency-Key, a retry appends the step twice.
user_id must be the sequence’s author, the team owner or a team admin.

Authorizations

x-api-key

string

header

required

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

Headers

Idempotency-Key

string

Makes this write safe to retry. Send a unique value, such as a UUID, and send the same value again when you retry the same request. A retry with the same key and the same request (method, path including the query string, and JSON body) returns the original successful response without acting twice. The same key with a different body or path returns 409, and so does a retry while the first request is still running; that one is safe to repeat after a moment. A request that fails frees its key, so a retry runs the write again: after a 5xx on a create, confirm with a GET before retrying. Keys are kept for 24 hours and are scoped to your team.

Path Parameters

sequence_id

string

required

24-character sequence id.

Body

application/json

step_type

enum<string>

required

auto_email sends an email on its own; manual_email, call and task create a task for the rep who owns the enrollment.

Available options:

auto_email,

manual_email,

call,

task

user_id

string

required

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.

Example:

"507f1f77bcf86cd799439011"

interval_seconds

number

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.

Required range: x >= 0

date

string<date-time>

Required on a date sequence, refused on an interval sequence. ISO 8601 date-time when the step comes due.

display_name

string

Step label, up to 200 characters. Becomes the title of the task the step creates.

Maximum string length: 200

new_thread

boolean

auto_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.

task_note

string

Up to 2,000 characters, copied onto the task the step creates.

Maximum string length: 2000

task_priority

enum<string>

default:medium

Available options:

high,

medium,

low

task_autoskip_delay

number

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.

Required range: x >= 0

call_purpose

object

call steps only.

Show child attributes

templates

object[]

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.

Maximum array length: 10

Show child attributes

Response

The new step.

One step of a cadence.

_id

string

24-character hexadecimal id.

Example:

"507f1f77bcf86cd799439011"

sequence

string

The sequence the step belongs to (24-character id).

Example:

"507f1f77bcf86cd799439011"

team

string

The team that owns the step (24-character id).

order

integer

1-based position in the cadence. Steps run in this order; change it with PUT /v2/sequencer/sequences/{sequence_id}/steps/reorder.

step_type

enum<string>

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.

Available options:

auto_email,

manual_email,

call,

task

interval_seconds

integer | null

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.

date

string<date-time> | null

On a date sequence: when the step comes due. Absent on an interval sequence.

display_name

string | null

Step label. Becomes the title of the task the step creates.

new_thread

boolean

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.

task_note

string | null

Note copied onto the task the step creates.

task_priority

enum<string>

Priority copied onto the task the step creates. Defaults to medium.

Available options:

high,

medium,

low

task_autoskip_delay

integer | null

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.

templates

object[]

Email steps: the templates to pick from, by weight. Empty for call and task steps.

Show child attributes

call_purpose

object

Call steps only: the call purpose set on the step. Absent when none is set.

Show child attributes

deliver_count

integer

Number of deliveries from this step, counted as events. Rebuilt every 15 minutes.

open_count

integer

Number of opens from this step, counted as events. Rebuilt every 15 minutes.

click_count

integer

Number of link clicks from this step, counted as events. Rebuilt every 15 minutes.

reply_count

integer

Number of replies from this step, counted as events. Rebuilt every 15 minutes.

bounce_count

integer

Number of bounces from this step, counted as events. Rebuilt every 15 minutes.

opt_out_count

integer

Number of opt-outs from this step, counted as events. Rebuilt every 15 minutes.

failure_count

integer

Number of failed sends from this step, counted as events. Rebuilt every 15 minutes.

schedule_count

integer

Times this step ran and produced work: emails sent plus tasks created. Rebuilt every 15 minutes.

created_at

string<date-time>

When the step was created.

updated_at

string<date-time>

When it last changed.

Get started

MCP server

MCP reference

MCP use cases

Dialer API

Calls and analytics API

Enrichment API

Sequencer API

Add a step

Step types

Examples

Rules

Things to know

Authorizations

Headers

Path Parameters

Body

Response

​Step types

​Examples

​Rules

​Things to know

Authorizations

Headers

Path Parameters

Body

Response

Step types

Examples

Rules

Things to know