Skip to main content
POST
Add a domain

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
name
string
required
Required string length: 1 - 253
region
enum<string>
Available options:
us-east-1
customReturnPath
string
Required string length: 1 - 64

Response

Added — publish the returned DNS records, then verify.

domainId
string
required
Required string length: 1 - 64
domainUrl
string<uri>
required
name
string
required
Required string length: 1 - 253
region
string
required
status
enum<string>
required
Available options:
not_started,
pending,
verified,
failed,
temporary_failure,
partially_verified,
partially_failed
sendingEnabled
boolean
required
sendable
boolean
required
records
object[]
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
openTracking
boolean
clickTracking
boolean
verifiedAt
string<date-time>