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": "webmaster@example.com"
}
'
import requests

url = "https://api.dev.name.com/core/v1/domains/{domainName}/email/forwarding"

payload = {
    "emailBox": "admin",
    "emailTo": "webmaster@example.com"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({emailBox: 'admin', emailTo: 'webmaster@example.com'})
};

fetch('https://api.dev.name.com/core/v1/domains/{domainName}/email/forwarding', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dev.name.com/core/v1/domains/{domainName}/email/forwarding",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'emailBox' => 'admin',
    'emailTo' => 'webmaster@example.com'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dev.name.com/core/v1/domains/{domainName}/email/forwarding"

	payload := strings.NewReader("{\n  \"emailBox\": \"admin\",\n  \"emailTo\": \"webmaster@example.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.dev.name.com/core/v1/domains/{domainName}/email/forwarding")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"emailBox\": \"admin\",\n  \"emailTo\": \"webmaster@example.com\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.dev.name.com/core/v1/domains/{domainName}/email/forwarding")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"emailBox\": \"admin\",\n  \"emailTo\": \"webmaster@example.com\"\n}"

response = http.request(request)
puts response.read_body
{
  "domainName": "example.com",
  "emailBox": "admin",
  "emailTo": "webmaster@example.com"
}
{
  "message": "Bad Request",
  "details": "'domainName' cannot be null"
}
{
  "message": "Unauthorized"
}
{
  "message": "Permission denied",
  "details": "Failed authentication"
}
{
  "message": "Not Found",
  "details": "The requested domain does not exist."
}
{
  "message": "Method Not Allowed"
}
{
  "message": "The 'Content-Type' header must be 'application/json' for this request."
}
{
  "message": "Rate Limit Exceeded"
}
{
  "message": "Internal Server Error",
  "details": "Something went wrong."
}
{
  "message": "The server received an invalid response from the upstream server."
}
{
  "message": "The upstream server is taking too long to respond."
}

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 "admin@example.com", 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:

"webmaster@example.com"

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:

"webmaster@example.com"