---
title: "Get the choices available for a new seed test"
method: GET
path: "/v1/email/inbox-insights/seed-tests/configuration"
tags: ["email-inbox-insights"]
---

# Get the choices available for a new seed test

`GET /v1/email/inbox-insights/seed-tests/configuration`

## Request

- Base URL: `https://us1.platform.bird.com`
- URL: `https://us1.platform.bird.com/v1/email/inbox-insights/seed-tests/configuration`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `bird_session`

Returns what a new seed test can be configured with for a sending domain:
the seed pools the account can use, the regions seeds can be placed in, and
the engagement behaviours the seeds can simulate.

A seed pool flagged unavailable is one the account has not been provisioned
for, and no self-serve route enables one, so leave it out of the choices you
offer rather than showing it unpickable. This is reference data
that changes only when provisioning does, so it suits being fetched when a
configuration form opens rather than on every page view.

## Query parameters

- `sending_domain` string, required

## Headers

- `X-Workspace-Id` string
- `X-Organization-Id` string

## Response `200`

The choices available for a new seed test on this domain.

- EmailInboxInsightsSeedTestConfiguration: The choices available when registering a seed test for a domain: which seed pools the account can use, which regions seeds can be placed in, and which engagement behaviours the seeds can simulate. This is reference data rather than a measurement, so it carries no period and no measurement detail. It changes only when an account's provisioning does.
  - `resource` string, required: Which resource this response is, echoed for self-description.
  - `domain` string, required: The sending domain these choices apply to.
  - `list_types` EmailInboxInsightsSeedListTypeOption[], required: The seed pools, each flagged with whether the account can use it.
    - `value` string, required: Which pool of seed addresses a test uses. Which pools an account can use depends on what has been provisioned for it, so read the usable set from the seed-test options rather than assuming these are the only values.
    - `available` boolean, required: Whether this pool is provisioned for the account. An unavailable pool is one the account has not been set up for rather than one its plan forbids, and there is no self-serve way to enable one, so leave it out of the choices you offer rather than showing it unpickable.
  - `regions` EmailInboxInsightsSeedRegionOption[], required: The regions seeds can be placed in. Objects rather than bare strings, to match the two lists beside it: the measurement reports no availability for a region today, and an object can carry one later without a second array.
    - `value` string, required: The value to send when registering a test against this region. Free text rather than an enumeration: the set belongs to the measurement and is wider than the continents it looks like, so send one of these back verbatim rather than composing your own.
  - `engagement_profiles` EmailInboxInsightsSeedEngagementProfileOption[], required: The engagement behaviours the seeds can simulate, each flagged with whether the account can use it.
    - `value` string, required: Which engagement behaviour the seed addresses simulate. `all` mixes engaged and dormant seeds, which is what makes an engagement split measurable; single-cohort profiles exist too, and the usable set comes from the seed-test options rather than from this list.
    - `available` boolean, required: Whether this behaviour is provisioned for the account. As with the seed pools, an unavailable behaviour is one the account has not been set up for rather than one its plan forbids, so leave it out of the choices you offer rather than showing it unpickable.

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Insufficient permissions
- `404`: Resource not found
- `412`: Precondition failed
- `422`: The request has invalid field values, violates a business rule, or carries a query parameter the endpoint does not declare. Field validation errors use `type: validation_error` and include the affected fields in `details`. Business-rule errors identify the failed rule in `type`.
- `429`: Rate limit exceeded
- `500`: Internal server error
- `503`: The service is temporarily unavailable. If `Retry-After` is present, wait for that delay before retrying; otherwise, retry with exponential backoff. Reuse the same idempotency key and request when retrying a mutation.

---

[API](https://skmtc.dev/messagebird/apis/bird-api.md) · [All operations](https://skmtc.dev/messagebird/apis/bird-api/llms.txt) · [OpenAPI document](https://skmtc.dev/messagebird/apis/bird-api/revisions/3e2a50466454?raw)