logo
MailboxesDetailed mailbox health
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"
{
  "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
  }
}
GET
/v1/mailboxes/{id}/health
GET
API Key (header: X-Api-Key)
X-Api-Keystring
Required

Platform API key (sk_user_...) or Workspace API key (sk_...)

Platform API key (sk_user_...) or Workspace API key (sk_...)
Bearer Token
Bearer Tokenstring
Required

API key as Bearer token

API key as Bearer token
Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-Api-Keystring
Required

API Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)

header
Authorizationstring
Required

Bearer token. API key as Bearer token

Path Parameters

idstring
Required

Resource ID

Responses

successboolean
dataobject