Docs
Deliverability

Get setup score

Get the setup health score for an account

A checklist of SPF, DKIM, DMARC, MX, sender name, and warmup-started, plus the whole-percent share of them that pass. DKIM is skipped for a personal-domain mailbox (scored out of 5 instead of 6). DMARC is informational - it reads warning when absent and does not count toward the score. Served from the cached DNS health row; POST .../setup-score/refresh to re-resolve first.

GET
/v2/workspaces/{workspaceId}/accounts/{id}/setup-score

Path Parameters

workspaceIdnumber
idnumber

Response Body

curl -X GET "https://lynx-api.trulyinbox.com/v2/workspaces/0/accounts/0/setup-score"
{
  "data": {
    "accountId": 456,
    "emailAddress": "john@acme.com",
    "score": 82,
    "band": "green",
    "items": [
      {
        "key": "spf",
        "label": "SPF record",
        "score": 29,
        "maxScore": 29,
        "indeterminate": true
      }
    ],
    "dnsCheckedAt": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "details": {},
    "retry_after": 34
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "details": {},
    "retry_after": 34
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

Run a DNS health checkGET

Re-check DNS and return the domain-security records Re-resolves SPF/DKIM/DMARC/MX, stores the actual record values, and returns them with the per-zone DNSBL breakdown and the red/yellow/green field bands. `null` body means the domain has no stored evidence yet - pending, not clean.

Refresh setup scorePOST

Re-resolve DNS and return the refreshed setup score Synchronously re-runs the SPF/DKIM/DMARC/MX lookups, persists the records, and returns the recomputed score. A record whose lookup failed at the resolver is left untouched rather than recorded as failing, so a resolver blip does not depress the score; a record that has never resolved at all reads `unknown`.