Domains

Add a domain

Registers a sending domain with the provider. Returns 201 with the bare row in status: "pending" plus the DNS records to publish. Once the records are live, call POST /v1/domains/{domainId}/verify until sendable: true.

post/v1/domains

Request

Base URL
https://brew.new/api
Auth
- HTTP bearer
- or API key in header X-API-Key
TypeScript
https://skmtc.dev/brew/apis/brew-public-api-v1/docs/v1/domains/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

Idempotency-Keystring

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

Request body

namestring required

region'us-east-1'

customReturnPathstring

Response

Added — publish the returned DNS records, then verify.

domainIdstring required

domainUrlstring uri required

namestring required

regionstring required

sendingEnabledboolean required

sendableboolean required

openTrackingboolean

clickTrackingboolean

createdAtstring date-time required

updatedAtstring date-time required

verifiedAtstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.