Create blacklist test
Creates a new blacklist test to check mailbox IPs/domains against known blacklists. Max 1000 mailboxes per test. Subject to monthly FUP limits based on subscription.
curl -X POST "https://api.sendkit.ai/v1/blacklist-tests" \
-H "Content-Type: application/json" \
-H "X-Api-Key: YOUR_API_KEY" \
-d '{
"name": "Weekly Blacklist Scan",
"mailboxIds": [
"664a1b2c3d4e5f6a7b8c9d03",
"664a1b2c3d4e5f6a7b8c9d04"
]
}'
import requests
import json
url = "https://api.sendkit.ai/v1/blacklist-tests"
headers = {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY"
}
data = {
"name": "Weekly Blacklist Scan",
"mailboxIds": [
"664a1b2c3d4e5f6a7b8c9d03",
"664a1b2c3d4e5f6a7b8c9d04"
]
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.sendkit.ai/v1/blacklist-tests", {
method: "POST",
headers: {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY"
},
body: JSON.stringify({
"name": "Weekly Blacklist Scan",
"mailboxIds": [
"664a1b2c3d4e5f6a7b8c9d03",
"664a1b2c3d4e5f6a7b8c9d04"
]
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"name": "Weekly Blacklist Scan",
"mailboxIds": [
"664a1b2c3d4e5f6a7b8c9d03",
"664a1b2c3d4e5f6a7b8c9d04"
]
}`)
req, err := http.NewRequest("POST", "https://api.sendkit.ai/v1/blacklist-tests", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-Api-Key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.sendkit.ai/v1/blacklist-tests')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['X-Api-Key'] = 'YOUR_API_KEY'
request.body = '{
"name": "Weekly Blacklist Scan",
"mailboxIds": [
"664a1b2c3d4e5f6a7b8c9d03",
"664a1b2c3d4e5f6a7b8c9d04"
]
}'
response = http.request(request)
puts response.body
{
"success": true,
"data": {
"id": "664a1b2c3d4e5f6a7b8c9d52",
"testCode": "BLT-1717200000000-A1B2C3D",
"status": "pending",
"testName": "Weekly Blacklist Scan",
"mailboxCount": 15
}
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Forbidden",
"message": "You don't have permission to access this resource",
"code": 403
}
POST
/v1/blacklist-tests
POST
API Key (header: X-Api-Key)
X-Api-Keystring
RequiredPlatform API key (sk_user_...) or Workspace API key (sk_...)
Platform API key (sk_user_...) or Workspace API key (sk_...)
Content-Typestring
RequiredThe media type of the request body
Options: application/json
namestring
Test name (optional, defaults to "Blacklist Check date")
mailboxIdsarray
RequiredMailbox IDs to check
Request Preview
Response
Response will appear here after sending the request
Authentication
header
X-Api-Keystring
RequiredAPI Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)
Body
application/json
namestring
Test name (optional, defaults to "Blacklist Check date")
mailboxIdsarray
RequiredMailbox IDs to check
Responses
successboolean
dataobject
idstring
Test ID
testCodestring
Unique test code (e.g. BLT-1717200000000-A1B2C3D)
statusstring
Allowed values:
pendingtestNamestring
mailboxCountinteger
Number of mailboxes included in the test
successboolean
Allowed values:
falseerrorobject
codestring
messagestring
detailsobject[]
successboolean
errorobject
codestring
messagestring
Was this page helpful?
Last updated 4 days ago
Built with Documentation.AI