Return a mailbox's overall health score: a whole number from 0 to 100, where higher is healthier.
The score combines four inputs. Each is scored out of 100, then weighted:
| Input | Weight |
|---|---|
| Spam rate: the share of the mailbox's warm-up emails and replies from the last 14 days that landed in spam (the same rate as the Spam Rate card in the dashboard) | 50% |
| DNS records: SPF, DMARC and MX | 30% |
| Domain age | 15% |
| Warm-up duration: active warm-up days, with paused periods excluded | 5% |
Get Health Score returns the DNS checks, domain age and warm-up duration for the same mailbox. It reports DNS as a letter grade and a valid or invalid result for each record, not as the 0–100 DNS value used here. When the domain's creation date isn't known (domain_age is null there), the score uses the mailbox's own age for the domain-age input instead. The same fallback applies if the warm-up duration is missing.
Before a score is available
While there isn't enough data to score the mailbox, health_score is null and health_score_status is Warming up. That happens when:
- the mailbox was added less than 48 hours ago, or
- it has no warm-up sends or replies in the last 14 days, so there is no spam rate to calculate (this applies to older mailboxes too).
Otherwise health_score_status is Ready and health_score holds the score.
Although the method is PATCH, this call only reads the score. Send it with no request body.
Unauthorized – Invalid or missing API token
Campaign not found or not accessible