Send one ordinary email from the mailbox to our test inbox. Within a few minutes the mailbox's deliverabilityTest reports whether it landed in the inbox or in spam (or did not arrive within 10 minutes), SPF, DKIM and DMARC as the receiving server saw them, and Spamhaus answers for the sending server and the domain. Read the mailbox to follow it (status goes from running to done or failed). One test runs at a time per mailbox, and a mailbox can run 10 a day.
Authorization
bearerAuth An API key created under Settings → API & Webhooks.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/email-accounts/string/deliverability-test"{ "data": { "id": "string", "label": "string", "email": "string", "fromName": "string", "provider": "google", "authType": "password", "connectedVia": "app", "hostedLinkId": "string", "status": "pending", "error": "string", "limits": {}, "usage": {}, "paused": true, "pausedReason": "user", "pausedAt": "2019-08-24T14:15:22Z", "trackOpens": true, "trackClicks": true, "dnsHealth": { "domain": "string", "managed": true, "spf": { "status": "ok", "reason": "string" }, "dkim": { "status": "ok", "reason": "string", "selector": "string" }, "dmarc": { "status": "ok", "reason": "string", "policy": "none" }, "checkedAt": "2019-08-24T14:15:22Z" }, "deliverabilityTest": { "status": "running", "startedAt": "2019-08-24T14:15:22Z", "finishedAt": "2019-08-24T14:15:22Z", "landing": "inbox", "spf": "string", "dkim": { "result": "string", "selector": "string" }, "dmarc": "string", "blocklists": { "ip": "clean", "domain": "clean" }, "failure": "send" }, "counters": {}, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "managed": { "provider": "string", "domain": "string", "status": "string", "renewsAt": "2019-08-24T14:15:22Z", "cancelAt": "2019-08-24T14:15:22Z", "isAdmin": true }, "warmup": { "provider": "string", "status": "pending", "statusLabel": "string", "strategy": { "preset": "conservative", "startingVolume": 1, "dailyIncrease": 1, "targetVolume": 1, "replyInbox": [ 0, 0 ], "replyPromotions": [ 0, 0 ], "replySpam": 0 }, "strategyApplied": true, "day": 0, "currentVolume": 0, "targetVolume": 0, "health": "excellent", "healthLabel": "string", "healthScore": 0, "inboxRate": 0, "startedAt": "2019-08-24T14:15:22Z", "holdUntil": "2019-08-24T14:15:22Z", "holdReason": "warming", "holdOverride": true, "syncedAt": "2019-08-24T14:15:22Z", "error": "string" }, "restoredFrom": "string" }}Resume a paused mailbox POST
Resume a paused mailbox so campaigns can email from it again. A no-op on a mailbox that is not paused; returns the mailbox either way. Emits an `account.resumed` webhook with `channel: email`.
API info GET
Returns API metadata and the workspace the key belongs to, including its effective plan, seat usage per channel and whether it is an organization or a workspace inside one. Handy for verifying a key works.