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
X-Brand-Id
string

The brand this request acts on. REQUIRED for organization-scoped credentials (otherwise 400 BRAND_ID_REQUIRED — there is no default brand); list ids with GET /v1/brands. Brand-scoped credentials may omit it, and sending a different brand returns 403 BRAND_SCOPE_MISMATCH. A brand outside your organization returns 404 BRAND_NOT_FOUND.

Required string length: 1 - 64

Body

application/json
test
enum<boolean>
required
Available options:
true
emailId
string
required
Minimum string length: 1
subject
string
required
Minimum string length: 1
to
string<email>
required
emailVersionId
string
Minimum string length: 1
previewText
string

Inbox preheader for this test send — overrides the design's JSX . Omit to deliver the design's own preview line.

Maximum string length: 200
replyTo
string<email>

Response

The TEST send (test: true) was delivered synchronously to the single recipient.

status
enum<string>
required
Available options:
sent
recipient
string<email>
required