Skip to main content
POST
/
core
/
v1
/
domains
/
{domainName}
/
email
/
forwarding
Create Email Forwarding
curl --request POST \
  --url https://api.dev.name.com/core/v1/domains/{domainName}/email/forwarding \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "emailBox": "admin",
  "emailTo": "[email protected]"
}
'
{
  "domainName": "example.com",
  "emailBox": "admin",
  "emailTo": "[email protected]"
}

Authorizations

​
Authorization
string
header
required

Authenticate via HTTP Basic with your account username and API token. Examples use an explicit 'Authorization: Basic <base64(username:token)>' header; 'curl -u username:token' is equivalent. For sandbox, append "-test" to your username and use your sandbox token on api.dev.name.com.

Path Parameters

​
domainName
string
required

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

Example:

"example.com"

Body

application/json

EmailForwarding contains all the information for an email forwarding entry.

​
emailBox
string
required

EmailBox is the user portion of the email address to forward. If your email is "[email protected]", it would just be "admin"

Minimum string length: 1
Example:

"admin"

​
emailTo
string<email>
required

EmailTo is the entire email address to forward email to.

Minimum string length: 1
Example:

"[email protected]"

Response

An email forwarding record has been successfully created.

EmailForwarding contains all the information for an email forwarding entry.

​
domainName
string
required

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

Minimum string length: 1
Example:

"example.com"

​
emailBox
string
required

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

Minimum string length: 1
Example:

"admin"

​
emailTo
string<email>
required

EmailTo is the entire email address to forward email to.

Example:

"[email protected]"