email-inbox-insights

Get the choices available for a new seed test

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.

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

Query parameters

sending_domainstring required
Example:mail.acme.com

The sending domain a test would be registered for: one of the workspace's verified sending domains, exactly as it appears there. A domain that is not verified in this workspace answers not-found.

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

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

resourcestring required

Which resource this response is, echoed for self-description.

domainstring required

The sending domain these choices apply to.

Example response

{
  "resource": "seed-test-configuration",
  "domain": "mail.acme.com",
  "list_types": [
    {
      "value": "private",
      "available": true
    }
  ],
  "regions": [
    {
      "value": "North America - US"
    }
  ],
  "engagement_profiles": [
    {
      "value": "all",
      "available": true
    }
  ]
}

Changes

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