Check Mailbox Status
POST /provider-domains/{domain_id}/check-mailbox-status
Re-check one mailbox’s provisioning with the provider, and record the answer.
Not a pure read: a mailbox the provider now reports as ready is flipped to active here, which is what makes it usable for sending.
Authorizations
Parameters
Path Parameters
Sending domain id (provider_domains.id) - from GET /provider-domains
Sending domain id (provider_domains.id) - from GET /provider-domains
Header Parameters
Request Body required
Names one mailbox on the domain in the path.
Shared by the info / TOTP / delete / status routes, all of which read
request["mailbox_id"] off an untyped dict in the app.
object
Mailbox id (mailboxes.id) on this domain
Responses
200
Successful Response
object
An open envelope for one provider/deliverability result.
Open on purpose. These payloads are provider state and advisory reads whose
contents grow with the product, and a dropped field reads as “nothing to
report” rather than “we did not tell you”. Every value passes through
scrub_vendor_names on the way in.
object
object
Whether there are more pages
Items per page
Current page number (1-indexed)
Total number of items
422
Validation Error