Get Recipient Suppression

GET

api

suppressions

{email}

curl --request GET \
  --url https://api.sequenzy.com/api/v1/suppressions/{email} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/suppressions/{email}', 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://api.sequenzy.com/api/v1/suppressions/{email}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/suppressions/{email}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/suppressions/{email}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "success": true,
  "suppression": {
    "email": "user@example.com",
    "knownRecipient": true,
    "suppressed": false,
    "local": {
      "suppressed": false,
      "suppressionType": null,
      "reason": null,
      "source": null,
      "suppressionId": null,
      "scope": null,
      "delistable": false
    },
    "ses": {
      "regionsChecked": [],
      "entries": []
    }
  }
}

Checks one exact recipient against Sequenzy’s bounce and complaint safeguards. This endpoint does not list unrelated recipients. Sequenzy suppresses recipients solely from its own bounce records. The email provider’s account-level suppression list is not consulted.

Request

string

required

Exact recipient email address. URL-encode the value when constructing the request URL.

string

deprecated

Accepted and ignored. It previously limited a provider-side suppression lookup, which no longer happens.

curl "https://api.sequenzy.com/api/v1/suppressions/user%40example.com" \
  -H "Authorization: Bearer API_KEY"

Response

{
  "success": true,
  "suppression": {
    "email": "user@example.com",
    "knownRecipient": true,
    "suppressed": false,
    "local": {
      "suppressed": false,
      "suppressionType": null,
      "reason": null,
      "source": null,
      "suppressionId": null,
      "scope": null,
      "delistable": false
    },
    "ses": {
      "regionsChecked": [],
      "entries": []
    }
  }
}

local.scope describes how far a local suppression reaches: global when the SMTP evidence conclusively identified an invalid destination and every workspace is blocked, company when the block is contained to your workspace (an ambiguous hard bounce, repeated delivery failures of your own sends, or a spam complaint against your email). Global invalid-recipient suppressions are protected; only company-scoped soft-bounce escalations can be removed. It is null when the address is not locally suppressed. Use List Suppressed Recipients to see every suppressed address at once. local.suppressionType uses the same stable values as the list: invalid_recipient, unknown_hard_bounce, soft_bounce_escalation, or complaint. local.delistable is true only for soft_bounce_escalation. knownRecipient indicates whether the address appears in this company’s subscriber or email-send history. Unknown addresses return an empty result so the endpoint cannot be used to probe suppressions belonging to another company. The ses object is deprecated and always returns regionsChecked: [] and entries: []. It is retained so existing integrations keep parsing. Read suppressed and local instead.

Get Recipient Suppression

curl --request GET \
  --url https://api.sequenzy.com/api/v1/suppressions/{email} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/suppressions/{email}', 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://api.sequenzy.com/api/v1/suppressions/{email}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/suppressions/{email}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/suppressions/{email}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "success": true,
  "suppression": {
    "email": "user@example.com",
    "knownRecipient": true,
    "suppressed": false,
    "local": {
      "suppressed": false,
      "suppressionType": null,
      "reason": null,
      "source": null,
      "suppressionId": null,
      "scope": null,
      "delistable": false
    },
    "ses": {
      "regionsChecked": [],
      "entries": []
    }
  }
}

​Request

​Response

Request

Response