The email deliverability API.

curl -X POST https://api.unspam.email/ext/v2/spam-check \
  -H "Authorization: Bearer $UNSPAM_TOKEN"

# returns the test id and the address to send to
{
  "id": "2Bl8rzTFN6VV",
  "inbox_address": "test-xyz@check.unspam.email"
}

# send your email to that address, then read the result
curl https://api.unspam.email/ext/v2/spam-check/2Bl8rzTFN6VV \
  -H "Authorization: Bearer $UNSPAM_TOKEN"

# response (200)
{
  "status": "completed",
  "score": 84,
  "results": [
    { "id": "spf", ... },
    { "id": "dkim", ... }
  ]
}

curl -X POST https://api.unspam.email/ext/v2/inbox-placement \
  -H "Authorization: Bearer $UNSPAM_TOKEN"

# returns the test id and the seed mailboxes to send to
{
  "id": "7Hq2xLpV0aKd",
  "mailboxes": [
    { "id": 12, "name": "Gmail", "address": ... },
    { "id": 31, "name": "Outlook", "address": ... }
  ]
}

# send to each address with the test id in the subject or body, then read the result
curl https://api.unspam.email/ext/v2/inbox-placement/7Hq2xLpV0aKd \
  -H "Authorization: Bearer $UNSPAM_TOKEN"

curl -X POST https://api.unspam.email/ext/v2/client-previews \
  -H "Authorization: Bearer $UNSPAM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email_source": "raw-data",
    "subject": "Your order shipped",
    "body": "<html>...</html>",
    "devices": ["iphone_15_pro_dm"]
  }'

# poll the id until status is completed
{
  "id": "3f9a2c8e-1d4b-4c7a-9f2e-7b1e5da0c62f",
  "status": "pending",
  "previews": [
    { "device_key": "iphone_15_pro_dm", "status": "pending", ... }
  ]
}

curl -X POST https://api.unspam.email/ext/v2/email-verification/instant-checks \
  -H "Authorization: Bearer $UNSPAM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "email": "jane@acme.com" }'

# poll the id until the check has finished
{
  "email": "jane@acme.com",
  "status": "completed",
  "result": {
    "status": "deliverable",
    "reason": "accepted",
    "action": "keep"
  }
}

curl -X POST https://api.unspam.email/ext/v2/dmarc/domains \
  -H "Authorization: Bearer $UNSPAM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "domain": "yourdomain.com" }'

# publish this TXT record, then call verify
{
  "domain": { "status": "pending_dns", ... },
  "dns_instructions": {
    "host": "_dmarc.yourdomain.com",
    "type": "TXT",
    "value": "v=DMARC1; p=none; rua=mailto:reports+a1b2c3d4@dmarc.unspam.email"
  }
}

curl -X POST https://api.unspam.email/ext/v2/scheduled-tests \
  -H "Authorization: Bearer $UNSPAM_TOKEN"

# send your email to inbox_address, then set the schedule
{
  "id": "9c41e7a2-52bd-4f0e-a6c3-1d8e0b7f3a64",
  "status": "draft",
  "inbox_address": "test-xyz@check.unspam.email"
}

# once it is running, read each run's results
curl https://api.unspam.email/ext/v2/scheduled-tests/9c41e7a2-52bd-4f0e-a6c3-1d8e0b7f3a64/runs \
  -H "Authorization: Bearer $UNSPAM_TOKEN"