Set up email on a domain

Pre-configure email DNS on a domain (optional). This is called automatically by create_mailbox when needed. Pass force=true to override existing email provider (Google Workspace, Fastmail, Proton).

post/api/domains/{domain}/email/setup

Request

Base URL: https://domani.run
URL: https://domani.run/api/domains/{domain}/email/setup
Auth: HTTP bearer

Path parameters

domainstring required

Domain name

Request body

forceboolean

Override existing email provider (Google Workspace, Fastmail, Proton). Default: false

Response

Email set up successfully

domainstring

status'configured' | 'already_configured'

verified_atstring nullable

receiving_verifiedboolean

True when the domain's MX points at the platform's receiver, so mail for its addresses is accepted.

sending_configuredboolean

sending_verifiedboolean

hintstring

Example response

{
  "records": [
    {
      "name": "@",
      "value": "76.76.21.21",
      "ttl": 3600
    }
  ]
}

Changes

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