Finish or pause everyone at an account

curl --request POST \
  --url https://client-api.salesfinity.co/v2/sequencer/enrollments/bulk/account \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "user_id": "507f1f77bcf86cd799439011",
  "domain": "acme.com",
  "action": "finish",
  "scope": "team",
  "reason": "Meeting booked with their VP Sales",
  "dry_run": true
}
'

import requests

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

payload = {
    "user_id": "507f1f77bcf86cd799439011",
    "domain": "acme.com",
    "action": "finish",
    "scope": "team",
    "reason": "Meeting booked with their VP Sales",
    "dry_run": True
}
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',
    domain: 'acme.com',
    action: 'finish',
    scope: 'team',
    reason: 'Meeting booked with their VP Sales',
    dry_run: true
  })
};

fetch('https://client-api.salesfinity.co/v2/sequencer/enrollments/bulk/account', 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/account",
  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',
    'domain' => 'acme.com',
    'action' => 'finish',
    'scope' => 'team',
    'reason' => 'Meeting booked with their VP Sales',
    'dry_run' => true
  ]),
  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/account"

	payload := strings.NewReader("{\n  \"user_id\": \"507f1f77bcf86cd799439011\",\n  \"domain\": \"acme.com\",\n  \"action\": \"finish\",\n  \"scope\": \"team\",\n  \"reason\": \"Meeting booked with their VP Sales\",\n  \"dry_run\": true\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/account")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"507f1f77bcf86cd799439011\",\n  \"domain\": \"acme.com\",\n  \"action\": \"finish\",\n  \"scope\": \"team\",\n  \"reason\": \"Meeting booked with their VP Sales\",\n  \"dry_run\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"domain\": \"acme.com\",\n  \"action\": \"finish\",\n  \"scope\": \"team\",\n  \"reason\": \"Meeting booked with their VP Sales\",\n  \"dry_run\": true\n}"

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

{
  "account": {
    "kind": "domain",
    "value": "acme.com"
  },
  "matched": 7,
  "queued": false
}

{
  "message": [
    "scope must be one of the following values: sequence, team"
  ],
  "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": "Contact 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": "Could not identify the account: no company, corporate email domain or company name",
  "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"
}

Enrollments

Finish or pause everyone at an account

Finishes or pauses the enrollments of everyone at one company — the “we just booked a meeting there, stop emailing the rest” case. Send dry_run: true first: it returns how many enrollments would change and changes nothing.

Name the account with contact, domain or company_name; if you send more than one, contact wins, then domain. domain matches contacts whose email address is at that domain. company_name matches contacts whose company name is the same once case, punctuation and suffixes such as Inc or LLC are ignored. contact uses that contact’s company: its company record if it has one, otherwise its corporate email domain or website, otherwise its company name. Personal email domains such as gmail.com never identify a company.

finish ends every live enrollment (pending, active or paused). pause pauses only active ones, for days days or until someone resumes them. scope: sequence limits the action to sequence and needs the sequence’s author, the team owner or a team admin as user_id; scope: team covers every sequence and needs the team owner or a team admin.

Unless it is a dry run or nothing matched, the change is queued (queued: true) and the enrollments change in the background a moment later. One call considers at most 2,000 contacts at the account and changes at most 500 enrollments; if matched is above 500, call again once the first batch has gone through. Each changed enrollment gets an account_action timeline event carrying reason. Counts toward the Sequencer writes rate limit.

POST

sequencer

enrollments

bulk

account

Finish or pause everyone at an account

curl --request POST \
  --url https://client-api.salesfinity.co/v2/sequencer/enrollments/bulk/account \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "user_id": "507f1f77bcf86cd799439011",
  "domain": "acme.com",
  "action": "finish",
  "scope": "team",
  "reason": "Meeting booked with their VP Sales",
  "dry_run": true
}
'

import requests

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

payload = {
    "user_id": "507f1f77bcf86cd799439011",
    "domain": "acme.com",
    "action": "finish",
    "scope": "team",
    "reason": "Meeting booked with their VP Sales",
    "dry_run": True
}
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',
    domain: 'acme.com',
    action: 'finish',
    scope: 'team',
    reason: 'Meeting booked with their VP Sales',
    dry_run: true
  })
};

fetch('https://client-api.salesfinity.co/v2/sequencer/enrollments/bulk/account', 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/account",
  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',
    'domain' => 'acme.com',
    'action' => 'finish',
    'scope' => 'team',
    'reason' => 'Meeting booked with their VP Sales',
    'dry_run' => true
  ]),
  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/account"

	payload := strings.NewReader("{\n  \"user_id\": \"507f1f77bcf86cd799439011\",\n  \"domain\": \"acme.com\",\n  \"action\": \"finish\",\n  \"scope\": \"team\",\n  \"reason\": \"Meeting booked with their VP Sales\",\n  \"dry_run\": true\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/account")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"507f1f77bcf86cd799439011\",\n  \"domain\": \"acme.com\",\n  \"action\": \"finish\",\n  \"scope\": \"team\",\n  \"reason\": \"Meeting booked with their VP Sales\",\n  \"dry_run\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"domain\": \"acme.com\",\n  \"action\": \"finish\",\n  \"scope\": \"team\",\n  \"reason\": \"Meeting booked with their VP Sales\",\n  \"dry_run\": true\n}"

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

{
  "account": {
    "kind": "domain",
    "value": "acme.com"
  },
  "matched": 7,
  "queued": false
}

{
  "message": [
    "scope must be one of the following values: sequence, team"
  ],
  "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": "Contact 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": "Could not identify the account: no company, corporate email domain or company name",
  "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"
}

Finishes or pauses the enrollments of everyone at one company — the “we just booked a meeting there, stop emailing the rest” case.

Dry run first

This can touch many people, so send dry_run: true first. It counts the enrollments that would change and changes nothing:

curl -X POST 'https://client-api.salesfinity.co/v2/sequencer/enrollments/bulk/account' \
  -H 'x-api-key: YOUR_API_KEY' -H 'content-type: application/json' \
  -d '{ "user_id": "USER_ID", "domain": "acme.com", "action": "finish", "scope": "team", "dry_run": true }'

{ "account": { "kind": "domain", "value": "acme.com" }, "matched": 7, "queued": false }

Check that account is the company you meant and matched is the size you expect, then send the same body without dry_run, with an Idempotency-Key and a reason. The response then has queued: true, and the enrollments change in the background a moment later.

Naming the account

Send one of these. If you send more than one, contact wins, then domain.

Field	Matches
`contact`	Everyone at that contact’s company: its company record if it has one, otherwise its corporate email domain or website, otherwise its company name
`domain`	Contacts whose email address is at that domain. A URL or `www.` prefix is stripped.
`company_name`	Contacts with the same company name once case, punctuation and suffixes such as Inc or LLC are ignored

Personal email domains such as gmail.com never identify a company. An account that cannot be identified returns 422.

What changes

`action`	Effect
`finish`	Every live enrollment (`pending`, `active` or `paused`) is finished.
`pause`	Every `active` enrollment is paused, for `days` days or, without `days`, until someone resumes it. Its `pause_reason` is `account_action`.

`scope`	Covers	`user_id` must be
`sequence`	Only `sequence`	The sequence’s author, the team owner or a team admin
`team`	Every sequence the team runs	The team owner or a team admin

Each changed enrollment gets an account_action event on its timeline, carrying your reason.

Limits

One call considers at most 2,000 contacts at the account and changes at most 500 enrollments. If matched is above 500, call again once the first batch has gone through; enrollments already finished or paused no longer match.

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"

action

enum<string>

required

finish ends every live enrollment at the account. pause pauses the active ones.

Available options:

finish,

pause

scope

enum<string>

required

sequence limits it to one sequence and needs the sequence's author, the team owner or a team admin as user_id. team covers every sequence the team runs and needs the team owner or a team admin.

Available options:

sequence,

team

contact

string

A contact on your team; the action targets that contact's company. Send this, domain or company_name. When more than one is sent, contact wins, then domain.

domain

string

A company domain, such as acme.com. A URL or www. prefix is stripped. Matches contacts whose email address is at this domain.

Maximum string length: 253

company_name

string

A company name. Matches contacts with the same company name once case, punctuation and suffixes such as Inc or LLC are ignored.

Maximum string length: 200

sequence

string

The sequence to act on. Required when scope is sequence, and ignored otherwise.

days

number

How long a pause lasts, in whole days; the enrollments resume themselves after it. Leave it out to pause until someone resumes them. Ignored for finish.

Required range: 1 <= x <= 365

reason

string

Why. Recorded on each changed enrollment's account_action timeline event.

Maximum string length: 500

dry_run

boolean

default:false

Count the enrollments that would change, and change nothing.

Response

How many enrollments matched, and whether the change was queued.

account

object

required

The account the action resolved to. kind is company (a company record id), domain (an email domain) or name (a normalized company name).

Show child attributes

matched

integer

required

Enrollments the action applies to: every live enrollment for finish, every active one for pause.

queued

boolean

required

True when the change was queued. False for a dry run, or when nothing matched.

Get started

MCP server

MCP reference

MCP use cases

Dialer API

Calls and analytics API

Enrichment API

Sequencer API

Finish or pause everyone at an account

Dry run first

Naming the account

What changes

Limits

Authorizations

Headers

Body

Response

​Dry run first

​Naming the account

​What changes

​Limits

Authorizations

Headers

Body

Response

Dry run first

Naming the account

What changes

Limits