Email

Add a sending domain.

Registers a domain and returns the DNS records required to verify it. Requires the email:send scope.

post/v1/email/domains

Request

  • Base URL: https://api.scalix.world
  • URL: https://api.scalix.world/v1/email/domains
  • Auth: HTTP bearer

Request body

domainstring required

Domain to add.

Example request

{
  "domain": "mail.example.com"
}

Response

Domain added

idstring required

Domain id.

domainstring required

The domain itself.

statusstring required

Verification state of the DNS records.

dns_recordsobject nullable

DNS records that must exist for the domain to verify.

delivery_enabledboolean nullable

Whether this org may actually send through the domain. Verification alone is not sufficient: bring-your-own delivery is a separate switch.

Example response

{
  "domain": "mail.example.com",
  "status": "pending"
}

Changes

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