---
title: "Create Placement Test"
method: POST
path: "/placement/tests"
tags: ["Mailboxes"]
---

# Create Placement Test

`POST /placement/tests`

## Request

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

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

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- CreateTestRequest: 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.
  - `mailbox_ids` integer[], required: 1-20 mailboxes. The app's own ceiling; each one costs credits.
  - `test_name` string, required
  - `frequency` string: `once`, `weekly`, `biweekly` or `monthly`. Anything but `once` keeps charging on that cadence until paused.
  - `receiver_types` string[], 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_subject` string, nullable
  - `custom_body` string, nullable
  - `sending_interval` integer: Minutes between sends, spreading the test out.

## Response `201`

Successful Response

- ApiResponseDeliverabilityPayload
  - `data` DeliverabilityPayload, 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".
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)