Mailboxes
Detailed mailbox health
Returns comprehensive mailbox health data including DNS records status (MX, SPF, DKIM, DMARC), warmup progress and metrics, deliverability stats, and error information.
curl -X GET "https://api.sendkit.ai/v1/mailboxes/example_string/health" \
-H "Content-Type: application/json" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://api.sendkit.ai/v1/mailboxes/example_string/health"
headers = {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://api.sendkit.ai/v1/mailboxes/example_string/health", {
method: "GET",
headers: {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://api.sendkit.ai/v1/mailboxes/example_string/health", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-Api-Key", "YOUR_API_KEY")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
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/mailboxes/example_string/health')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
puts response.body
{
"success": true,
"data": {
"email": "sarah@company.com",
"status": "active",
"sendingEnabled": true,
"dns": {
"mx": {
"status": "pass",
"records": [
{
"exchange": "mx1.company.com",
"priority": 10
}
]
},
"spf": {
"status": "pass",
"record": "v=spf1 include:_spf.google.com ~all"
},
"dkim": {
"status": "pass",
"selector": "google",
"record": "v=DKIM1; k=rsa; p=..."
},
"dmarc": {
"status": "pass",
"record": "v=DMARC1; p=none; rua=mailto:dmarc@company.com"
},
"healthScore": 100
},
"warmup": {
"enabled": true,
"status": "in_progress",
"currentDay": 15,
"currentVolume": 25,
"metrics": {}
},
"deliverability": {
"bounceRate": 0.02,
"totalSent": 500,
"totalReceived": 50,
"consecutiveFailures": 0
},
"dailySendLimit": 40,
"sentToday": 12,
"lastError": null
}
}
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Mailbox not found"
}
}
GET
/v1/mailboxes/{id}/healthGET
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_...)
path
idstring
RequiredResource ID
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_...)
header
Authorizationstring
RequiredBearer token. API key as Bearer token
Path Parameters
idstring
RequiredResource ID
Responses
successboolean
dataobject
Was this page helpful?
Last updated today
Built with Documentation.AI