Sign in

v1

latestOpenAPI 3.1.02026-07-26363186558.0 KB
Verified Domains

Add a new verified domain

post/settings/domains

Headers

x-apikeystring required

Your API key

Content-Typestring required
Example:application/json

application/json

Request body

domainstring

A verified domain to create.

Response

OK

challengestring

The DNS TXT record challenge code that's used to verified domain ownership.

created_atstring date-time

The time the verified domain was created.

created_bystring

The user name that created the verified domain.

created_by_user_idstring

The user ID that created the verified domain.

domainstring

The domain name. Must not be a free email provider domain.

idstring

The ID of the verified domain.

primary_domainstring

The primary domain extracted from the domain name. e.g. the parent domain.

status'unverified' | 'verified' | 'pending' | 'error'

The status of the verified domain with respect to its proven ownership.

updated_atstring date-time

The time the verified domain was last updated.

updated_bystring

The user name that last updated the verified domain.

updated_by_user_idstring

The user ID that last updated the verified domain.

verification_checked_atstring date-time

The last time the DNS TXT record was checked for verification.

verification_messagestring

A explaination pretaining to the last time the TXT record was checked for the verification code.

verification_type'txt_record' | 'manual'

The type of verification used for the domain.

Example response

{
  "id": "c4fbb52bqsiatib6i4gg"
}