Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required
region
string
required

Response

200 - application/json

Create a new domain

id
number
required

The ID of the domain

Example:

1

name
string
required

The name of the domain

Example:

"example.com"

teamId
number
required

The ID of the team

Example:

1

status
enum<string>
required
Available options:
NOT_STARTED,
PENDING,
SUCCESS,
FAILED,
TEMPORARY_FAILURE
publicKey
string
required
createdAt
string
required
updatedAt
string
required
dnsRecords
object[]
required
region
string
default:us-east-1
clickTracking
boolean
default:false
openTracking
boolean
default:false
dkimStatus
string | null
spfDetails
string | null
dmarcAdded
boolean
default:false
isVerifying
boolean
default:false
errorMessage
string | null
subdomain
string | null
verificationError
string | null
lastCheckedTime
string | null