Skip to content

Run Mailbox Placement Test

POST
/mailboxes/{mailbox_id}/health/placement-test

Run an inbox-placement test for ONE mailbox. THIS CHARGES CREDITS.

Same charging path as POST /placement/tests: credits are held and charged when the test is CREATED, not when it completes. Call POST /placement/tests/estimate first if you want the figure - that one is free.

One test per mailbox per 72 hours; a call inside the window is a 429 carrying cooldown_until. The test itself completes asynchronously - read it back with GET /placement/tests/{test_id}.

Org admins and owners only, enforced by the handler itself.

Authorizations

Parameters

Path Parameters

mailbox_id
required

Mailbox id (mailboxes.id)

integer
>= 1

Mailbox id (mailboxes.id)

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

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
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string