Mailboxes

Run Mailbox 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.

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

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/mailboxes/{mailbox_id}/health/placement-test
  • Auth: HTTP bearer

Path parameters

mailbox_idinteger required

Mailbox id (mailboxes.id)

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataMailboxDomainPayload 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.

Changes

No recorded changes to this operation across all 2 revisions of this API.