Skip to content

Create Placement Test

POST
/placement/tests

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.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Run an inbox-placement test. THIS SPENDS CREDITS.

20 credits per mailbox, charged when the test is created, not when it finishes. frequency other than once creates a RECURRING schedule that keeps charging - use GET /placement/scheduled to see what is running and /pause to stop it.

object
custom_body
Any of:
string
custom_subject
Any of:
string
frequency

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

string
default: once
mailbox_ids
required

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

Array<integer>
>= 1 items <= 20 items
receiver_types
Any of:
Array<string>
sending_interval

Minutes between sends, spreading the test out.

integer
default: 1
test_name
required
string

Responses

201

Successful Response

object
data
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”.

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