Sign in

v1

latestOpenAPI 3.1.02026-07-2670105729.6 KB
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

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
status'not_started' | 'pending' | 'verified' | 'failed' | 'temporary_failure' | 'partially_verified' | 'partially_failed' required
sendingEnabledboolean required
sendableboolean required
openTrackingboolean
clickTrackingboolean
createdAtstring date-time required
updatedAtstring date-time required
verifiedAtstring date-time