Skip to main content
POST
Add a domain

Authorizations

Authorization
string
header
required

An API key from the dashboard. sk_live_… sends; sk_test_… validates and returns ids without sending.

Body

application/json
name
string
required
Example:

"yourshop.co.za"

mailFromSubdomain
string
default:mail

Subdomain for the custom return path.

Response

Already added

id
string
required
Example:

"dom_01j9x7k2r4m8q3v5n6b7c8d9e0"

name
string
required
Example:

"yourshop.co.za"

status
enum<string>
required
Available options:
pending,
verified,
failed
mailFromDomain
string
required
Example:

"mail.yourshop.co.za"

records
object[]
required
verifiedAt
string<date-time> | null
required
lastCheckedAt
string<date-time> | null
required
createdAt
string<date-time>
required
advice
object[]

Deliverability findings from the last check (DMARC, apex SPF, alignment).