Preview a draft rule set
curl --request POST \
--url https://client-api.salesfinity.co/v2/sequencer/policies/preview \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"user_id": "507f1f77bcf86cd799439011",
"rules": [
{
"name": "<string>",
"action": {
"type": "<string>",
"params": {}
},
"scope": [
"<string>"
],
"id": "<string>",
"enabled": true,
"condition_group": {}
}
]
}
'import requests
url = "https://client-api.salesfinity.co/v2/sequencer/policies/preview"
payload = {
"user_id": "507f1f77bcf86cd799439011",
"rules": [
{
"name": "<string>",
"action": {
"type": "<string>",
"params": {}
},
"scope": ["<string>"],
"id": "<string>",
"enabled": True,
"condition_group": {}
}
]
}
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',
rules: [
{
name: '<string>',
action: {type: '<string>', params: {}},
scope: ['<string>'],
id: '<string>',
enabled: true,
condition_group: {}
}
]
})
};
fetch('https://client-api.salesfinity.co/v2/sequencer/policies/preview', 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/policies/preview",
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',
'rules' => [
[
'name' => '<string>',
'action' => [
'type' => '<string>',
'params' => [
]
],
'scope' => [
'<string>'
],
'id' => '<string>',
'enabled' => true,
'condition_group' => [
]
]
]
]),
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/policies/preview"
payload := strings.NewReader("{\n \"user_id\": \"507f1f77bcf86cd799439011\",\n \"rules\": [\n {\n \"name\": \"<string>\",\n \"action\": {\n \"type\": \"<string>\",\n \"params\": {}\n },\n \"scope\": [\n \"<string>\"\n ],\n \"id\": \"<string>\",\n \"enabled\": true,\n \"condition_group\": {}\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/policies/preview")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"user_id\": \"507f1f77bcf86cd799439011\",\n \"rules\": [\n {\n \"name\": \"<string>\",\n \"action\": {\n \"type\": \"<string>\",\n \"params\": {}\n },\n \"scope\": [\n \"<string>\"\n ],\n \"id\": \"<string>\",\n \"enabled\": true,\n \"condition_group\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://client-api.salesfinity.co/v2/sequencer/policies/preview")
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 \"rules\": [\n {\n \"name\": \"<string>\",\n \"action\": {\n \"type\": \"<string>\",\n \"params\": {}\n },\n \"scope\": [\n \"<string>\"\n ],\n \"id\": \"<string>\",\n \"enabled\": true,\n \"condition_group\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{}{
"message": [
"limit must not be greater than 100"
],
"error": "Bad Request",
"statusCode": 400
}{
"message": "Forbidden resource",
"error": "Forbidden",
"statusCode": 403
}{
"message": "Too many requests",
"error": "Too Many Requests",
"statusCode": 429
}{
"message": "Internal server error",
"error": "Internal Server Error",
"statusCode": 500
}Sequencer Policies
Preview a draft rule set
Replays an unsaved rule set against the team’s recent enrolments and reports what it would have done. Run this before saving. A rule that is too broad silently blocks every enrolment team-wide, and this is the cheapest way to find that out.
POST
/
v2
/
sequencer
/
policies
/
preview
Preview a draft rule set
curl --request POST \
--url https://client-api.salesfinity.co/v2/sequencer/policies/preview \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"user_id": "507f1f77bcf86cd799439011",
"rules": [
{
"name": "<string>",
"action": {
"type": "<string>",
"params": {}
},
"scope": [
"<string>"
],
"id": "<string>",
"enabled": true,
"condition_group": {}
}
]
}
'import requests
url = "https://client-api.salesfinity.co/v2/sequencer/policies/preview"
payload = {
"user_id": "507f1f77bcf86cd799439011",
"rules": [
{
"name": "<string>",
"action": {
"type": "<string>",
"params": {}
},
"scope": ["<string>"],
"id": "<string>",
"enabled": True,
"condition_group": {}
}
]
}
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',
rules: [
{
name: '<string>',
action: {type: '<string>', params: {}},
scope: ['<string>'],
id: '<string>',
enabled: true,
condition_group: {}
}
]
})
};
fetch('https://client-api.salesfinity.co/v2/sequencer/policies/preview', 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/policies/preview",
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',
'rules' => [
[
'name' => '<string>',
'action' => [
'type' => '<string>',
'params' => [
]
],
'scope' => [
'<string>'
],
'id' => '<string>',
'enabled' => true,
'condition_group' => [
]
]
]
]),
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/policies/preview"
payload := strings.NewReader("{\n \"user_id\": \"507f1f77bcf86cd799439011\",\n \"rules\": [\n {\n \"name\": \"<string>\",\n \"action\": {\n \"type\": \"<string>\",\n \"params\": {}\n },\n \"scope\": [\n \"<string>\"\n ],\n \"id\": \"<string>\",\n \"enabled\": true,\n \"condition_group\": {}\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/policies/preview")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"user_id\": \"507f1f77bcf86cd799439011\",\n \"rules\": [\n {\n \"name\": \"<string>\",\n \"action\": {\n \"type\": \"<string>\",\n \"params\": {}\n },\n \"scope\": [\n \"<string>\"\n ],\n \"id\": \"<string>\",\n \"enabled\": true,\n \"condition_group\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://client-api.salesfinity.co/v2/sequencer/policies/preview")
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 \"rules\": [\n {\n \"name\": \"<string>\",\n \"action\": {\n \"type\": \"<string>\",\n \"params\": {}\n },\n \"scope\": [\n \"<string>\"\n ],\n \"id\": \"<string>\",\n \"enabled\": true,\n \"condition_group\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{}{
"message": [
"limit must not be greater than 100"
],
"error": "Bad Request",
"statusCode": 400
}{
"message": "Forbidden resource",
"error": "Forbidden",
"statusCode": 403
}{
"message": "Too many requests",
"error": "Too Many Requests",
"statusCode": 429
}{
"message": "Internal server error",
"error": "Internal Server Error",
"statusCode": 500
}Replays an unsaved rule set against the team’s recent enrolments and reports what it would have done. Run this before saving. A rule that is too broad silently blocks every enrolment team-wide, and this is the cheapest way to find that out.
Authorizations
Team-scoped API key generated in the Salesfinity dashboard under Settings -> Connections & API. A missing or invalid key returns HTTP 403.
Body
application/json
Response
Success.
The outcome of an action. Shape varies by endpoint — for example enable returns the sequence and how many enrollments it activated, and a bulk verb returns how many rows it moved.