Mail Forwarding

Returns the current provisioning status and paid renewal date for the domain.

Configures mail forwarding and starts DNS verification. The request returns while verification is pending. The domain must use hosted DNS. Existing aliases are imported when the domain already exists at the forwarding provider.

This endpoint could result in a charge to the authenticated team's payment method or an invoice being created. Re-enabling before the current renews_at date does not create another charge.

This endpoint may remove conflicting DNS records so mail forwarding can work.

Repairs missing provider or DNS configuration and restarts verification after a failed attempt.

Removes the forwarding zone, all aliases, and mail DNS records that can be safely identified as managed (modified or ambiguous DNS records remain unchanged). Any unused time in the current paid period remains available until renews_at, so you can re-enable mail forwarding before that date without another charge. While disabled, mail forwarding will not renew or create another charge when the paid period ends.

Disabling mail forwarding does not refund any unused time in the current paid period.

Returns the aliases currently configured for the domain. Aliases can be managed while mail forwarding is pending, active, or failed.

Adds an alias to a pending, active, or failed mail-forwarding zone. The domain must use hosted DNS.

This endpoint may remove conflicting DNS records so mail forwarding can keep working.

Returns one alias configured for the domain. Aliases can be managed while mail forwarding is pending, active, or failed.

Replaces the alias and target of one mail forward while mail forwarding is pending, active, or failed. The domain must use hosted DNS.

This endpoint may remove conflicting DNS records so mail forwarding can keep working.

Removes one alias from a pending, active, or failed mail-forwarding zone.