Disable a sequence

curl --request POST \
  --url https://client-api.salesfinity.co/v2/sequencer/sequences/{id}/disable \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "user_id": "507f1f77bcf86cd799439011"
}
'

import requests

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

payload = { "user_id": "507f1f77bcf86cd799439011" }
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'})
};

fetch('https://client-api.salesfinity.co/v2/sequencer/sequences/{id}/disable', 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/{id}/disable",
  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'
  ]),
  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/{id}/disable"

	payload := strings.NewReader("{\n  \"user_id\": \"507f1f77bcf86cd799439011\"\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/{id}/disable")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"507f1f77bcf86cd799439011\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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}"

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

{
  "sequence": {
    "_id": "6650c1f2a9b8c7d6e5f40123",
    "team": "64f1a2b3c4d5e6f7a8b9c0d1",
    "user": "64f1a2b3c4d5e6f7a8b9c0d2",
    "name": "Q4 outbound - VP Operations",
    "description": "Call, email, follow-up task over five days",
    "tags": [
      "outbound",
      "q4"
    ],
    "enabled": false,
    "enabled_at": "2026-09-02T14:05:11.000Z",
    "archived_at": null,
    "policy": null,
    "sequence_type": "interval",
    "throttle_max_adds_per_day": 50,
    "throttle_capacity": 300,
    "throttle_paused": false,
    "transactional": false,
    "primary_reply_action": "finish",
    "schedule": {
      "timezone_source": "prospect",
      "timezone": "America/New_York",
      "days_of_week": [
        1,
        2,
        3,
        4,
        5
      ],
      "start_hour": 8,
      "end_hour": 17
    },
    "email_account_ids": [],
    "track_opens": true,
    "track_links": true,
    "sequence_step_count": 3,
    "duration_in_days": 5,
    "automation_percentage": 33,
    "num_contacted_prospects": 118,
    "num_replied_prospects": 9,
    "reply_rate": 8,
    "deliver_count": 201,
    "open_count": 143,
    "click_count": 12,
    "reply_count": 10,
    "bounce_count": 3,
    "opt_out_count": 1,
    "failure_count": 0,
    "schedule_count": 260,
    "last_activity_at": "2026-10-02T16:41:00.000Z",
    "created_at": "2026-08-28T10:12:44.000Z",
    "updated_at": "2026-10-02T16:41:00.000Z"
  },
  "paused": 64
}

{
  "message": "Invalid ObjectId",
  "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": "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"
}

Sequences

Disable a sequence

Turns the sequence off. Returns the sequence and paused, the number of enrollments paused. Every active enrollment becomes paused, with pause_reason sequence_disabled and no due time. Open tasks from the sequence are put on hold, hidden from reps’ queues and refused if someone tries to complete them, and call tasks are taken out of reps’ dial lists. Nothing is finished or deleted: enabling again resumes exactly these enrollments and releases the tasks. pending enrollments stay pending.

Already disabled: returns paused: 0 and changes nothing, so a retry is safe. Disabling does not unlock reordering or deleting steps, or deleting the sequence: paused enrollments still block those.

user_id must be the author, the team owner or a team admin. Counts toward the Sequencer writes rate limit.

POST

sequencer

sequences

{id}

disable

Disable a sequence

curl --request POST \
  --url https://client-api.salesfinity.co/v2/sequencer/sequences/{id}/disable \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "user_id": "507f1f77bcf86cd799439011"
}
'

import requests

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

payload = { "user_id": "507f1f77bcf86cd799439011" }
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'})
};

fetch('https://client-api.salesfinity.co/v2/sequencer/sequences/{id}/disable', 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/{id}/disable",
  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'
  ]),
  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/{id}/disable"

	payload := strings.NewReader("{\n  \"user_id\": \"507f1f77bcf86cd799439011\"\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/{id}/disable")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"507f1f77bcf86cd799439011\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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}"

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

{
  "sequence": {
    "_id": "6650c1f2a9b8c7d6e5f40123",
    "team": "64f1a2b3c4d5e6f7a8b9c0d1",
    "user": "64f1a2b3c4d5e6f7a8b9c0d2",
    "name": "Q4 outbound - VP Operations",
    "description": "Call, email, follow-up task over five days",
    "tags": [
      "outbound",
      "q4"
    ],
    "enabled": false,
    "enabled_at": "2026-09-02T14:05:11.000Z",
    "archived_at": null,
    "policy": null,
    "sequence_type": "interval",
    "throttle_max_adds_per_day": 50,
    "throttle_capacity": 300,
    "throttle_paused": false,
    "transactional": false,
    "primary_reply_action": "finish",
    "schedule": {
      "timezone_source": "prospect",
      "timezone": "America/New_York",
      "days_of_week": [
        1,
        2,
        3,
        4,
        5
      ],
      "start_hour": 8,
      "end_hour": 17
    },
    "email_account_ids": [],
    "track_opens": true,
    "track_links": true,
    "sequence_step_count": 3,
    "duration_in_days": 5,
    "automation_percentage": 33,
    "num_contacted_prospects": 118,
    "num_replied_prospects": 9,
    "reply_rate": 8,
    "deliver_count": 201,
    "open_count": 143,
    "click_count": 12,
    "reply_count": 10,
    "bounce_count": 3,
    "opt_out_count": 1,
    "failure_count": 0,
    "schedule_count": 260,
    "last_activity_at": "2026-10-02T16:41:00.000Z",
    "created_at": "2026-08-28T10:12:44.000Z",
    "updated_at": "2026-10-02T16:41:00.000Z"
  },
  "paused": 64
}

{
  "message": "Invalid ObjectId",
  "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": "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"
}

Turns the sequence off. Nothing is finished or deleted, so enabling it again picks up exactly where it stopped.

What changes

Every active enrollment becomes paused, with pause_reason set to sequence_disabled and no due time. The response’s paused is how many.
Open tasks from the sequence go on hold: they disappear from reps’ queues and cannot be completed, and call tasks are taken out of reps’ dial lists.
pending enrollments stay pending, and enrollments a rep paused by hand stay paused.

Enabling again resumes the enrollments this call paused and returns the held tasks to their reps.

Example

curl -X POST https://client-api.salesfinity.co/v2/sequencer/sequences/6650c1f2a9b8c7d6e5f40123/disable \
  -H 'x-api-key: YOUR_API_KEY' -H 'content-type: application/json' \
  -d '{ "user_id": "507f1f77bcf86cd799439011" }'

The response holds the sequence, now with enabled: false, and paused, the number of enrollments this call paused.

Things to know

Disabling a sequence that is already disabled returns paused: 0 and changes nothing, so a retry is safe.
Disabling does not unlock reordering or deleting steps, or deleting the sequence. Those are refused while enrollments are paused, too.
user_id must be the 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

string

required

24-character sequence id.

Body

application/json

user_id

string

required

The team member this call acts as. Must be an active member of the team the API key belongs to.

Example:

"507f1f77bcf86cd799439011"

Response

The sequence and how many enrollments were paused.

sequence

object

required

A Sequencer sequence (a cadence). can_manage is returned by list and get only; step_type_counts and enrollment_counts by list only.

Show child attributes

Example:

{
  "_id": "6650c1f2a9b8c7d6e5f40123",
  "team": "64f1a2b3c4d5e6f7a8b9c0d1",
  "user": "64f1a2b3c4d5e6f7a8b9c0d2",
  "name": "Q4 outbound - VP Operations",
  "description": "Call, email, follow-up task over five days",
  "tags": ["outbound", "q4"],
  "enabled": true,
  "enabled_at": "2026-09-02T14:05:11.000Z",
  "archived_at": null,
  "policy": null,
  "sequence_type": "interval",
  "throttle_max_adds_per_day": 50,
  "throttle_capacity": 300,
  "throttle_paused": false,
  "transactional": false,
  "primary_reply_action": "finish",
  "schedule": {
    "timezone_source": "prospect",
    "timezone": "America/New_York",
    "days_of_week": [1, 2, 3, 4, 5],
    "start_hour": 8,
    "end_hour": 17
  },
  "email_account_ids": [],
  "track_opens": true,
  "track_links": true,
  "sequence_step_count": 3,
  "duration_in_days": 5,
  "automation_percentage": 33,
  "num_contacted_prospects": 118,
  "num_replied_prospects": 9,
  "reply_rate": 8,
  "deliver_count": 201,
  "open_count": 143,
  "click_count": 12,
  "reply_count": 10,
  "bounce_count": 3,
  "opt_out_count": 1,
  "failure_count": 0,
  "schedule_count": 260,
  "last_activity_at": "2026-10-02T16:41:00.000Z",
  "created_at": "2026-08-28T10:12:44.000Z",
  "updated_at": "2026-10-02T16:41:00.000Z",
  "can_manage": true
}

paused

integer

required

Enrollments moved from active to paused. 0 when the sequence was already disabled.

Get started

MCP server

MCP reference

MCP use cases

Dialer API

Calls and analytics API

Enrichment API

Sequencer API

Disable a sequence

What changes

Example

Things to know

Authorizations

Headers

Path Parameters

Body

Response

​What changes

​Example

​Things to know

Authorizations

Headers

Path Parameters

Body

Response

What changes

Example

Things to know