Mailboxes

Create Placement Test

Run an inbox-placement test. THIS CHARGES 20 CREDITS PER MAILBOX.

Charged when the test is CREATED, not when it finishes, so a cancelled or failed test has still cost. Estimate first.

A frequency other than once creates a recurring schedule that charges again on every run - see GET /placement/scheduled and /pause.

post/placement/tests

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/placement/tests
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

mailbox_idsinteger[] required

1-20 mailboxes. The app's own ceiling; each one costs credits.

test_namestring required
frequencystring

once, weekly, biweekly or monthly. Anything but once keeps charging on that cadence until paused.

receiver_typesstring[] nullable

Which seed inboxes to test against, e.g. personal_gmail. Omit for the app's default panel - a narrower list tests less and costs the same.

custom_subjectstring nullable
custom_bodystring nullable
sending_intervalinteger

Minutes between sends, spreading the test out.

Response

Successful Response

dataDeliverabilityPayload required

An open envelope for a test, a schedule or a warmup report.

Open because placement results carry one panel per seed provider and the provider set changes; a closed model would drop a panel, and a missing panel on a deliverability report reads as "we did not test there" when the truth may be "you did not land there".

Changes

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