v1

latestOpenAPI 3.1.02026-07-2671111437.2 KB
Email Forwardings

Create Email Forwarding

Creates a new email forwarding rule for a domain, such as redirecting info@example.com to an external inbox. If this is the first email forwarding rule created for the domain, the API may also update your MX records automatically to enable mail routing. The alias must not conflict with existing email services or MX records. To modify a forwarding rule later, use UpdateEmailForwarding.

post/core/v1/domains/{domainName}/email/forwarding

Path parameters

domainNamestring required
Example:example.com

DomainName is the domain part of the email address to forward.

Request body

emailBoxstring required

EmailBox is the user portion of the email address to forward. If your email is "admin@example.com", it would just be "admin"

emailTostring email required

EmailTo is the entire email address to forward email to.

Example request

{
  "emailBox": "admin",
  "emailTo": "webmaster@example.com"
}

Response

An email forwarding record has been successfully created.

domainNamestring required

DomainName is the domain part of the email address to forward.

emailBoxstring required

EmailBox is the user portion of the email address to forward.

emailTostring email required

EmailTo is the entire email address to forward email to.

Example response

{
  "domainName": "example.com",
  "emailBox": "admin",
  "emailTo": "webmaster@example.com"
}