Skip to main content
POST

Authorizations

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Headers

Idempotency-Key
string

Optional idempotency key for safe retries. Reusing the same key with the same request body returns the original response for 24 hours.

Required string length: 1 - 100

Path Parameters

emailId
string
required

Design id returned by POST /v1/emails and listed by GET /v1/emails.

Required string length: 1 - 64
Example:

"eml_2SmZOWV3ZQ7W5x6g3m4p"

Body

application/json
domainId
string
required

Verified sending domain id to test FROM (the seed send goes out on this domain, so the result reflects its real reputation).

Required string length: 1 - 64
subject
string

Subject line for the seed send; defaults to the email title. A VARIANT dimension — run several tests on one design varying only the subject to compare placement.

Required string length: 1 - 200
previewText
string

Preview/preheader text for the seed send — overrides the design's JSX for this test. A VARIANT dimension, like subject: run several tests varying only the preheader to compare placement.

Maximum string length: 200
emailVersionId
string

Pin a specific design version to test (from list_email_designs with include: ["versions"]); omit for the latest. A VARIANT dimension — test two versions of one design against each other.

Minimum string length: 1
providers
string[]

Restrict seed mailbox providers (e.g. ["gmail.com","outlook.com","yahoo.com"]); omit for a broad default spread.

Required array length: 1 - 30 elements
Required string length: 1 - 80

Response

The test was created and the seed send is in flight. Poll the GET endpoint for results.

testId
string
required
emailId
string
required
status
enum<string>
required
Available options:
pending,
sending,
collecting,
completed,
partial,
failed
domainId
string
required
seedCount
integer
required
Required range: x >= 0
results
object | null
required
createdAt
string
required
updatedAt
string
required
subject
string
previewText
string
emailVersionId
string
diagnosis
object[]
errorMessage
string