Un-enroll contacts in bulk

curl --request POST \
  --url https://client-api.salesfinity.co/v2/sequencer/enrollments/bulk/finish \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "user_id": "507f1f77bcf86cd799439011",
  "ids": [
    "6702b4c1e8a9f3d2c1b0a987",
    "6702b4c1e8a9f3d2c1b0a988",
    "6702b4c1e8a9f3d2c1b0a989"
  ]
}
'

import requests

url = "https://client-api.salesfinity.co/v2/sequencer/enrollments/bulk/finish"

payload = {
    "user_id": "507f1f77bcf86cd799439011",
    "ids": ["6702b4c1e8a9f3d2c1b0a987", "6702b4c1e8a9f3d2c1b0a988", "6702b4c1e8a9f3d2c1b0a989"]
}
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',
    ids: [
      '6702b4c1e8a9f3d2c1b0a987',
      '6702b4c1e8a9f3d2c1b0a988',
      '6702b4c1e8a9f3d2c1b0a989'
    ]
  })
};

fetch('https://client-api.salesfinity.co/v2/sequencer/enrollments/bulk/finish', 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/enrollments/bulk/finish",
  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',
    'ids' => [
        '6702b4c1e8a9f3d2c1b0a987',
        '6702b4c1e8a9f3d2c1b0a988',
        '6702b4c1e8a9f3d2c1b0a989'
    ]
  ]),
  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/enrollments/bulk/finish"

	payload := strings.NewReader("{\n  \"user_id\": \"507f1f77bcf86cd799439011\",\n  \"ids\": [\n    \"6702b4c1e8a9f3d2c1b0a987\",\n    \"6702b4c1e8a9f3d2c1b0a988\",\n    \"6702b4c1e8a9f3d2c1b0a989\"\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/enrollments/bulk/finish")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"507f1f77bcf86cd799439011\",\n  \"ids\": [\n    \"6702b4c1e8a9f3d2c1b0a987\",\n    \"6702b4c1e8a9f3d2c1b0a988\",\n    \"6702b4c1e8a9f3d2c1b0a989\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://client-api.salesfinity.co/v2/sequencer/enrollments/bulk/finish")

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  \"ids\": [\n    \"6702b4c1e8a9f3d2c1b0a987\",\n    \"6702b4c1e8a9f3d2c1b0a988\",\n    \"6702b4c1e8a9f3d2c1b0a989\"\n  ]\n}"

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

{
  "ok": 2,
  "failed": [
    {
      "id": "6702b4c1e8a9f3d2c1b0a989",
      "reason": "Sequence state not found"
    }
  ]
}

{
  "message": [
    "ids must contain no more than 500 elements"
  ],
  "error": "Bad Request",
  "statusCode": 400,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Forbidden resource",
  "error": "Forbidden",
  "statusCode": 403,
  "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"
}

Enrollments

Un-enroll contacts in bulk

Finishes up to 500 enrollments in one call: the bulk form of Un-enroll a contact. Each one stops, its open tasks are cancelled and the contact comes off the owner’s dial queue. There is no delete: finished enrollments keep their timeline, and the contacts can be enrolled again.

The ids are processed one at a time and one failure does not stop the rest. ok counts the ids that succeeded, including enrollments that had already ended; failed lists each id that was not, with the reason — usually an id that is not on your team (Sequence state not found). note is accepted but not stored.

Any active team member can finish any of the team’s enrollments. Repeating the call is harmless; send an Idempotency-Key to get the original response back instead. Counts toward the Sequencer writes rate limit.

POST

sequencer

enrollments

bulk

finish

Un-enroll contacts in bulk

curl --request POST \
  --url https://client-api.salesfinity.co/v2/sequencer/enrollments/bulk/finish \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "user_id": "507f1f77bcf86cd799439011",
  "ids": [
    "6702b4c1e8a9f3d2c1b0a987",
    "6702b4c1e8a9f3d2c1b0a988",
    "6702b4c1e8a9f3d2c1b0a989"
  ]
}
'

import requests

url = "https://client-api.salesfinity.co/v2/sequencer/enrollments/bulk/finish"

payload = {
    "user_id": "507f1f77bcf86cd799439011",
    "ids": ["6702b4c1e8a9f3d2c1b0a987", "6702b4c1e8a9f3d2c1b0a988", "6702b4c1e8a9f3d2c1b0a989"]
}
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',
    ids: [
      '6702b4c1e8a9f3d2c1b0a987',
      '6702b4c1e8a9f3d2c1b0a988',
      '6702b4c1e8a9f3d2c1b0a989'
    ]
  })
};

fetch('https://client-api.salesfinity.co/v2/sequencer/enrollments/bulk/finish', 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/enrollments/bulk/finish",
  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',
    'ids' => [
        '6702b4c1e8a9f3d2c1b0a987',
        '6702b4c1e8a9f3d2c1b0a988',
        '6702b4c1e8a9f3d2c1b0a989'
    ]
  ]),
  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/enrollments/bulk/finish"

	payload := strings.NewReader("{\n  \"user_id\": \"507f1f77bcf86cd799439011\",\n  \"ids\": [\n    \"6702b4c1e8a9f3d2c1b0a987\",\n    \"6702b4c1e8a9f3d2c1b0a988\",\n    \"6702b4c1e8a9f3d2c1b0a989\"\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/enrollments/bulk/finish")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"507f1f77bcf86cd799439011\",\n  \"ids\": [\n    \"6702b4c1e8a9f3d2c1b0a987\",\n    \"6702b4c1e8a9f3d2c1b0a988\",\n    \"6702b4c1e8a9f3d2c1b0a989\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://client-api.salesfinity.co/v2/sequencer/enrollments/bulk/finish")

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  \"ids\": [\n    \"6702b4c1e8a9f3d2c1b0a987\",\n    \"6702b4c1e8a9f3d2c1b0a988\",\n    \"6702b4c1e8a9f3d2c1b0a989\"\n  ]\n}"

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

{
  "ok": 2,
  "failed": [
    {
      "id": "6702b4c1e8a9f3d2c1b0a989",
      "reason": "Sequence state not found"
    }
  ]
}

{
  "message": [
    "ids must contain no more than 500 elements"
  ],
  "error": "Bad Request",
  "statusCode": 400,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Forbidden resource",
  "error": "Forbidden",
  "statusCode": 403,
  "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"
}

Finishes up to 500 enrollments in one call, exactly as Un-enroll a contact does for one: each enrollment stops, its open tasks are cancelled, and the contact comes off the owner’s dial queue.

curl -X POST 'https://client-api.salesfinity.co/v2/sequencer/enrollments/bulk/finish' \
  -H 'x-api-key: YOUR_API_KEY' -H 'content-type: application/json' \
  -H 'Idempotency-Key: 7a2c9e4b-1d3f-4b6a-8e0c-9f5d2a7b3c1e' \
  -d '{ "user_id": "USER_ID", "ids": ["ENROLLMENT_ID_1", "ENROLLMENT_ID_2", "ENROLLMENT_ID_3"] }'

The response says how each id went, and arrives even when every id failed:

{
  "ok": 2,
  "failed": [{ "id": "6702b4c1e8a9f3d2c1b0a989", "reason": "Sequence state not found" }]
}

The ids are processed one at a time, and one failure does not stop the rest.
ok counts the ids that succeeded, including enrollments that had already ended.
failed lists the rest with the reason. Sequence state not found means the id is not an enrollment on your team.

Repeating the call is harmless. note is accepted but not stored. Any active member of the team can finish any of its enrollments. To stop everyone at one company without collecting their ids, use Finish or pause everyone at an account.

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.

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"

ids

string[]

required

Enrollment ids, 1 to 500.

Maximum array length: 500

note

string

Bulk approve and bulk reject record it on each approval decision and timeline event. Bulk finish and move accept it but do not store it.

Maximum string length: 500

Response

How many succeeded, and why each of the others did not. Returned even when every id failed.

The outcome of a bulk enrollment action. The ids are processed one at a time, in the order sent, and one failure does not stop the rest.

integer

required

How many ids the action succeeded for.

failed

object[]

required

Every id the action did not succeed for, in the order sent.

Show child attributes

reassigned

integer

Bulk reassign only: the same number as ok.

Get started

MCP server

MCP reference

MCP use cases

Dialer API

Calls and analytics API

Enrichment API

Sequencer API

Un-enroll contacts in bulk

Authorizations

Headers

Body

Response