Domains

Add a domain

Registers a sending domain and returns the DNS records to install. On Amazon SES that is four records — a DKIM TXT at <selector>._domainkey.<domain>, an MX and an SPF TXT on the bounce.<domain> MAIL FROM subdomain, and a DMARC TXT. Idempotent: re-adding a domain returns the records already in play rather than issuing a new DKIM key, which would stop a live domain from signing.

post/v1/domains

Request

  • Base URL: https://api.volanea.com
  • URL: https://api.volanea.com/v1/domains
  • Auth: HTTP bearer

Request body

domainstring required

e.g. mail.example.com.

Response

The domain was already added; its existing DNS records are returned unchanged.

domainIdstring required
projectIdstring
domainstring required
status'pending' | 'verified' | 'failed' required
dkimStatus'pending' | 'verified' | 'failed' | 'not_applicable'
spfStatus'pending' | 'verified' | 'failed'
dmarcStatus'pending' | 'verified' | 'failed'
trackingStatus'pending' | 'verified' | 'failed'
mailFromStatus'pending' | 'verified' | 'failed' | 'not_applicable'

Custom MAIL FROM subdomain (bounce.<domain>) — carries the bounce path and lets DMARC align SPF.

mailFromDomainstring nullable
selectorstring nullable

DKIM selector published at <selector>._domainkey.<domain>.

verifiedForSendingboolean

Whether the provider will currently accept mail from this domain.

dkimTokensstring[]

Legacy SES Easy DKIM CNAME tokens. Empty for domains onboarded with BYODKIM, which publish a single TXT record instead.

verificationTokenstring nullable
lastCheckedAtstring date-time nullable
createdAtstring date-time required

Changes

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