Domains

Add an email sender domain

Changed on

Registers a custom domain for the board’s outgoing email (job alerts, magic links, receipts, Inbox replies) and returns the DNS records to publish. The setup loop is: create the domain, publish every required record in dnsRecords at the DNS provider (DNS-only, not proxied), then call POST /email-domains/{id}/verify until status is verified. Cavuno also re-checks pending domains in the background and emails the board owners when the domain verifies. Until then board email keeps sending from the Cavuno address. Requires an active primary custom domain (see POST /domains) and a plan that includes branding removal.

post/email-domains

Request

  • Base URL: https://api.cavuno.com/v1
  • URL: https://api.cavuno.com/v1/email-domains
  • Auth: HTTP bearer

Request body

domainstring required

Hostname to send from. It must be the board’s active primary custom domain or one of its subdomains; a subdomain such as notifications.acme.com is recommended so the main domain’s email reputation stays separate. Normalized to lowercase.

senderNamestring

Display name recipients see in the From header, for example Acme Jobs. Defaults to the board name.

senderLocalPartstring

Mailbox before the @, for example info or hello. Defaults to info. Normalized to lowercase.

Response

Successful response.

idstring required
object'email_domain' required
domainstring required

The sending hostname.

status'pending' | 'verified' | 'failed' required

pending until the required DNS records verify, verified once board email sends from this domain, failed when the last check found a problem (see statusReason; publish or fix the records and verify again).

senderNamestring required
senderLocalPartstring required
senderAddressstring required

The From address once the domain is verified.

statusReason'setup_required' | 'dns_verification_failed' nullable required

Why the last check failed, when it did. setup_required: the domain must be set up with the email provider again; call verify, which re-stages it and returns fresh DNS records. dns_verification_failed: the published records do not match yet; check each record’s status, fix them and verify again.

verifiedAtstring nullable required
lastCheckedAtstring nullable required
createdAtstring required

Changes

  • c34152c38176Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status