Upload suppression rules (append)
curl --request POST \
--url https://api.aws53.cloud/v1/data/suppression-rules \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"rules": [
{
"type": "domain",
"value": "mycompany.com"
},
{
"type": "email",
"value": "ceo@partner.com"
},
{
"type": "company_domain",
"value": "https://www.competitor.com/pricing"
},
{
"type": "industry",
"value": "Higher Education"
}
]
}
'import requests
url = "https://api.aws53.cloud/v1/data/suppression-rules"
payload = { "rules": [
{
"type": "domain",
"value": "mycompany.com"
},
{
"type": "email",
"value": "ceo@partner.com"
},
{
"type": "company_domain",
"value": "https://www.competitor.com/pricing"
},
{
"type": "industry",
"value": "Higher Education"
}
] }
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({
rules: [
{type: 'domain', value: 'mycompany.com'},
{type: 'email', value: 'ceo@partner.com'},
{type: 'company_domain', value: 'https://www.competitor.com/pricing'},
{type: 'industry', value: 'Higher Education'}
]
})
};
fetch('https://api.aws53.cloud/v1/data/suppression-rules', 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.aws53.cloud/v1/data/suppression-rules",
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([
'rules' => [
[
'type' => 'domain',
'value' => 'mycompany.com'
],
[
'type' => 'email',
'value' => 'ceo@partner.com'
],
[
'type' => 'company_domain',
'value' => 'https://www.competitor.com/pricing'
],
[
'type' => 'industry',
'value' => 'Higher Education'
]
]
]),
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://api.aws53.cloud/v1/data/suppression-rules"
payload := strings.NewReader("{\n \"rules\": [\n {\n \"type\": \"domain\",\n \"value\": \"mycompany.com\"\n },\n {\n \"type\": \"email\",\n \"value\": \"ceo@partner.com\"\n },\n {\n \"type\": \"company_domain\",\n \"value\": \"https://www.competitor.com/pricing\"\n },\n {\n \"type\": \"industry\",\n \"value\": \"Higher Education\"\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://api.aws53.cloud/v1/data/suppression-rules")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"rules\": [\n {\n \"type\": \"domain\",\n \"value\": \"mycompany.com\"\n },\n {\n \"type\": \"email\",\n \"value\": \"ceo@partner.com\"\n },\n {\n \"type\": \"company_domain\",\n \"value\": \"https://www.competitor.com/pricing\"\n },\n {\n \"type\": \"industry\",\n \"value\": \"Higher Education\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aws53.cloud/v1/data/suppression-rules")
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 \"rules\": [\n {\n \"type\": \"domain\",\n \"value\": \"mycompany.com\"\n },\n {\n \"type\": \"email\",\n \"value\": \"ceo@partner.com\"\n },\n {\n \"type\": \"company_domain\",\n \"value\": \"https://www.competitor.com/pricing\"\n },\n {\n \"type\": \"industry\",\n \"value\": \"Higher Education\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"added": 123,
"removed": 123,
"duplicates": 123,
"rejectedCount": 123,
"rejected": [
{
"index": 123,
"type": "<string>",
"value": "<string>",
"reason": "<string>"
}
],
"total": 123
}
}Visitor suppression
Upload suppression rules (append)
Adds up to 25,000 rules in one call, on top of what is already stored; send more by posting again. There is no cap on how many rules an organization may keep. Values are normalized before storage (lowercased; domains lose scheme, www., path and port), so re-uploading the same list is a no-op. Rows that fail validation come back in rejected — every other row is still applied. Rules take effect from the next sync cycle onward; visitors already charged are not refunded. Authenticates via X-API-Key header.
POST
/
v1
/
data
/
suppression-rules
Upload suppression rules (append)
curl --request POST \
--url https://api.aws53.cloud/v1/data/suppression-rules \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"rules": [
{
"type": "domain",
"value": "mycompany.com"
},
{
"type": "email",
"value": "ceo@partner.com"
},
{
"type": "company_domain",
"value": "https://www.competitor.com/pricing"
},
{
"type": "industry",
"value": "Higher Education"
}
]
}
'import requests
url = "https://api.aws53.cloud/v1/data/suppression-rules"
payload = { "rules": [
{
"type": "domain",
"value": "mycompany.com"
},
{
"type": "email",
"value": "ceo@partner.com"
},
{
"type": "company_domain",
"value": "https://www.competitor.com/pricing"
},
{
"type": "industry",
"value": "Higher Education"
}
] }
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({
rules: [
{type: 'domain', value: 'mycompany.com'},
{type: 'email', value: 'ceo@partner.com'},
{type: 'company_domain', value: 'https://www.competitor.com/pricing'},
{type: 'industry', value: 'Higher Education'}
]
})
};
fetch('https://api.aws53.cloud/v1/data/suppression-rules', 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.aws53.cloud/v1/data/suppression-rules",
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([
'rules' => [
[
'type' => 'domain',
'value' => 'mycompany.com'
],
[
'type' => 'email',
'value' => 'ceo@partner.com'
],
[
'type' => 'company_domain',
'value' => 'https://www.competitor.com/pricing'
],
[
'type' => 'industry',
'value' => 'Higher Education'
]
]
]),
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://api.aws53.cloud/v1/data/suppression-rules"
payload := strings.NewReader("{\n \"rules\": [\n {\n \"type\": \"domain\",\n \"value\": \"mycompany.com\"\n },\n {\n \"type\": \"email\",\n \"value\": \"ceo@partner.com\"\n },\n {\n \"type\": \"company_domain\",\n \"value\": \"https://www.competitor.com/pricing\"\n },\n {\n \"type\": \"industry\",\n \"value\": \"Higher Education\"\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://api.aws53.cloud/v1/data/suppression-rules")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"rules\": [\n {\n \"type\": \"domain\",\n \"value\": \"mycompany.com\"\n },\n {\n \"type\": \"email\",\n \"value\": \"ceo@partner.com\"\n },\n {\n \"type\": \"company_domain\",\n \"value\": \"https://www.competitor.com/pricing\"\n },\n {\n \"type\": \"industry\",\n \"value\": \"Higher Education\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aws53.cloud/v1/data/suppression-rules")
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 \"rules\": [\n {\n \"type\": \"domain\",\n \"value\": \"mycompany.com\"\n },\n {\n \"type\": \"email\",\n \"value\": \"ceo@partner.com\"\n },\n {\n \"type\": \"company_domain\",\n \"value\": \"https://www.competitor.com/pricing\"\n },\n {\n \"type\": \"industry\",\n \"value\": \"Higher Education\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"added": 123,
"removed": 123,
"duplicates": 123,
"rejectedCount": 123,
"rejected": [
{
"index": 123,
"type": "<string>",
"value": "<string>",
"reason": "<string>"
}
],
"total": 123
}
}Was this page helpful?
⌘I