Import suppression entries

curl --request POST \
  --url https://client-api.salesfinity.co/v2/sequencer/suppression/import \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "user_id": "64b7f0c2e4b0a1b2c3d4e5f1",
  "entries": [
    {
      "type": "email",
      "value": "[email protected]",
      "reason": "unsubscribed"
    },
    {
      "type": "domain",
      "value": "competitor.com"
    },
    {
      "type": "phone",
      "value": "+1 (512) 555-0199",
      "reason": "dnc"
    }
  ]
}
'

import requests

url = "https://client-api.salesfinity.co/v2/sequencer/suppression/import"

payload = {
    "user_id": "64b7f0c2e4b0a1b2c3d4e5f1",
    "entries": [
        {
            "type": "email",
            "value": "[email protected]",
            "reason": "unsubscribed"
        },
        {
            "type": "domain",
            "value": "competitor.com"
        },
        {
            "type": "phone",
            "value": "+1 (512) 555-0199",
            "reason": "dnc"
        }
    ]
}
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: '64b7f0c2e4b0a1b2c3d4e5f1',
    entries: [
      {type: 'email', value: '[email protected]', reason: 'unsubscribed'},
      {type: 'domain', value: 'competitor.com'},
      {type: 'phone', value: '+1 (512) 555-0199', reason: 'dnc'}
    ]
  })
};

fetch('https://client-api.salesfinity.co/v2/sequencer/suppression/import', 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/suppression/import",
  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' => '64b7f0c2e4b0a1b2c3d4e5f1',
    'entries' => [
        [
                'type' => 'email',
                'value' => '[email protected]',
                'reason' => 'unsubscribed'
        ],
        [
                'type' => 'domain',
                'value' => 'competitor.com'
        ],
        [
                'type' => 'phone',
                'value' => '+1 (512) 555-0199',
                'reason' => 'dnc'
        ]
    ]
  ]),
  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/suppression/import"

	payload := strings.NewReader("{\n  \"user_id\": \"64b7f0c2e4b0a1b2c3d4e5f1\",\n  \"entries\": [\n    {\n      \"type\": \"email\",\n      \"value\": \"[email protected]\",\n      \"reason\": \"unsubscribed\"\n    },\n    {\n      \"type\": \"domain\",\n      \"value\": \"competitor.com\"\n    },\n    {\n      \"type\": \"phone\",\n      \"value\": \"+1 (512) 555-0199\",\n      \"reason\": \"dnc\"\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/suppression/import")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"64b7f0c2e4b0a1b2c3d4e5f1\",\n  \"entries\": [\n    {\n      \"type\": \"email\",\n      \"value\": \"[email protected]\",\n      \"reason\": \"unsubscribed\"\n    },\n    {\n      \"type\": \"domain\",\n      \"value\": \"competitor.com\"\n    },\n    {\n      \"type\": \"phone\",\n      \"value\": \"+1 (512) 555-0199\",\n      \"reason\": \"dnc\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://client-api.salesfinity.co/v2/sequencer/suppression/import")

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\": \"64b7f0c2e4b0a1b2c3d4e5f1\",\n  \"entries\": [\n    {\n      \"type\": \"email\",\n      \"value\": \"[email protected]\",\n      \"reason\": \"unsubscribed\"\n    },\n    {\n      \"type\": \"domain\",\n      \"value\": \"competitor.com\"\n    },\n    {\n      \"type\": \"phone\",\n      \"value\": \"+1 (512) 555-0199\",\n      \"reason\": \"dnc\"\n    }\n  ]\n}"

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

{
  "imported": 998,
  "skipped": [
    {
      "value": "   ",
      "reason": "empty after normalization"
    },
    {
      "value": "n/a",
      "reason": "empty after normalization"
    }
  ]
}

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

{
  "message": "The acting user is not an active member of this team",
  "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"
}

Suppression

Import suppression entries

Adds up to 1,000 entries to the do-not-contact list in one request; values already on the list are left unchanged.

Normalization and matching are the same as POST /v2/sequencer/suppression.

A value already on the list is left exactly as it is: its reason is not overwritten and no duplicate is created, so replaying the same list is safe. A value that is empty once normalized (a blank value, or a phone value with no digits) is returned in skipped with the reason empty after normalization, and the rest are imported. imported counts every row now on the list, including rows that were already there.

New entries are recorded with source: import. Acts as user_id. Counts against the Sequencer writes rate limit.

POST

sequencer

suppression

import

Import suppression entries

curl --request POST \
  --url https://client-api.salesfinity.co/v2/sequencer/suppression/import \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "user_id": "64b7f0c2e4b0a1b2c3d4e5f1",
  "entries": [
    {
      "type": "email",
      "value": "[email protected]",
      "reason": "unsubscribed"
    },
    {
      "type": "domain",
      "value": "competitor.com"
    },
    {
      "type": "phone",
      "value": "+1 (512) 555-0199",
      "reason": "dnc"
    }
  ]
}
'

import requests

url = "https://client-api.salesfinity.co/v2/sequencer/suppression/import"

payload = {
    "user_id": "64b7f0c2e4b0a1b2c3d4e5f1",
    "entries": [
        {
            "type": "email",
            "value": "[email protected]",
            "reason": "unsubscribed"
        },
        {
            "type": "domain",
            "value": "competitor.com"
        },
        {
            "type": "phone",
            "value": "+1 (512) 555-0199",
            "reason": "dnc"
        }
    ]
}
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: '64b7f0c2e4b0a1b2c3d4e5f1',
    entries: [
      {type: 'email', value: '[email protected]', reason: 'unsubscribed'},
      {type: 'domain', value: 'competitor.com'},
      {type: 'phone', value: '+1 (512) 555-0199', reason: 'dnc'}
    ]
  })
};

fetch('https://client-api.salesfinity.co/v2/sequencer/suppression/import', 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/suppression/import",
  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' => '64b7f0c2e4b0a1b2c3d4e5f1',
    'entries' => [
        [
                'type' => 'email',
                'value' => '[email protected]',
                'reason' => 'unsubscribed'
        ],
        [
                'type' => 'domain',
                'value' => 'competitor.com'
        ],
        [
                'type' => 'phone',
                'value' => '+1 (512) 555-0199',
                'reason' => 'dnc'
        ]
    ]
  ]),
  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/suppression/import"

	payload := strings.NewReader("{\n  \"user_id\": \"64b7f0c2e4b0a1b2c3d4e5f1\",\n  \"entries\": [\n    {\n      \"type\": \"email\",\n      \"value\": \"[email protected]\",\n      \"reason\": \"unsubscribed\"\n    },\n    {\n      \"type\": \"domain\",\n      \"value\": \"competitor.com\"\n    },\n    {\n      \"type\": \"phone\",\n      \"value\": \"+1 (512) 555-0199\",\n      \"reason\": \"dnc\"\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/suppression/import")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"64b7f0c2e4b0a1b2c3d4e5f1\",\n  \"entries\": [\n    {\n      \"type\": \"email\",\n      \"value\": \"[email protected]\",\n      \"reason\": \"unsubscribed\"\n    },\n    {\n      \"type\": \"domain\",\n      \"value\": \"competitor.com\"\n    },\n    {\n      \"type\": \"phone\",\n      \"value\": \"+1 (512) 555-0199\",\n      \"reason\": \"dnc\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://client-api.salesfinity.co/v2/sequencer/suppression/import")

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\": \"64b7f0c2e4b0a1b2c3d4e5f1\",\n  \"entries\": [\n    {\n      \"type\": \"email\",\n      \"value\": \"[email protected]\",\n      \"reason\": \"unsubscribed\"\n    },\n    {\n      \"type\": \"domain\",\n      \"value\": \"competitor.com\"\n    },\n    {\n      \"type\": \"phone\",\n      \"value\": \"+1 (512) 555-0199\",\n      \"reason\": \"dnc\"\n    }\n  ]\n}"

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

{
  "imported": 998,
  "skipped": [
    {
      "value": "   ",
      "reason": "empty after normalization"
    },
    {
      "value": "n/a",
      "reason": "empty after normalization"
    }
  ]
}

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

{
  "message": "The acting user is not an active member of this team",
  "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"
}

Adds a list of up to 1,000 emails, domains and phone numbers in one call, for example an unsubscribe export from another tool.

Handling the response

{ "imported": 998, "skipped": [{ "value": "n/a", "reason": "empty after normalization" }] }

imported counts every row now on the list, including values that were already there. skipped lists rows that were empty once normalized, such as a phone value with no digits.

Good to know

Values already on the list are left exactly as they are, so replaying the same file is safe and does not change their reason.
Each value is normalized and matched the same way as Add a suppression entry.
For more than 1,000 values, send batches of 1,000.

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. Recorded on each new entry.

Example:

"507f1f77bcf86cd799439011"

entries

object[]

required

1 to 1,000 entries. A value already on the list is left unchanged.

Maximum array length: 1000

Show child attributes

Response

How many rows are on the list, and which were skipped.

imported

integer

required

Rows now on the list, including values that were already there.

skipped

object[]

required

Rows not added, with the reason.

Show child attributes

Get started

MCP server

MCP reference

MCP use cases

Dialer API

Calls and analytics API

Enrichment API

Sequencer API

Import suppression entries

Handling the response

Good to know

Authorizations

Headers

Body

Response

​Handling the response

​Good to know

Authorizations

Headers

Body

Response

Handling the response

Good to know