Domains

Update the email sender

Changed on

Changes the From name or mailbox for a verified sender domain. Requires the settings.manage permission, as in the dashboard.

patch/email-domains/{id}

Request

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

Path parameters

idstring required

The email domain ID.

Request body

senderNamestring

Display name recipients see in the From header.

senderLocalPartstring

Mailbox before the @. 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