Email Domains

Setup DNS records for an email domain using a configured DNS provider

post/email-domains/{id}/setup-dns

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/email-domains/{id}/setup-dns
  • Auth: HTTP bearer

Path parameters

idinteger required

Email Domain ID

Request body

dns_provider_idinteger required

The ID of the DNS provider to use for creating records

Response

DNS records setup result

messagestring required

Human-readable summary message

records_createdinteger required

Number of records that were successfully created

successboolean required

Overall success status

total_recordsinteger required

Total number of records attempted

Changes

No recorded changes to this operation across all 54 revisions of this API.