Skip to main content
POST
/
api
/
v1
/
email-domains
Create an email domain
curl --request POST \
  --url https://prod.featherhq.com/api/v1/email-domains \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "subdomain": "<string>",
  "domain": "<string>",
  "sendFromDomain": "<string>"
}
'
import requests

url = "https://prod.featherhq.com/api/v1/email-domains"

payload = {
    "subdomain": "<string>",
    "domain": "<string>",
    "sendFromDomain": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({subdomain: '<string>', domain: '<string>', sendFromDomain: '<string>'})
};

fetch('https://prod.featherhq.com/api/v1/email-domains', 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://prod.featherhq.com/api/v1/email-domains",
  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([
    'subdomain' => '<string>',
    'domain' => '<string>',
    'sendFromDomain' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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://prod.featherhq.com/api/v1/email-domains"

	payload := strings.NewReader("{\n  \"subdomain\": \"<string>\",\n  \"domain\": \"<string>\",\n  \"sendFromDomain\": \"<string>\"\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	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://prod.featherhq.com/api/v1/email-domains")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"subdomain\": \"<string>\",\n  \"domain\": \"<string>\",\n  \"sendFromDomain\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://prod.featherhq.com/api/v1/email-domains")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"subdomain\": \"<string>\",\n  \"domain\": \"<string>\",\n  \"sendFromDomain\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "emailDomain": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organizationId": "<string>",
    "subdomain": "<string>",
    "domain": "<string>",
    "fullDomain": "<string>",
    "providerDomainId": "<string>",
    "gmailConnectionId": "<string>",
    "sendGridIntegrationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "inboundWebhookUrl": "<string>",
    "mxRecord": "<string>",
    "mxPriority": 123,
    "spfHostname": "<string>",
    "spfValue": "<string>",
    "dkimSelector": "<string>",
    "dkimHostname": "<string>",
    "dkimValue": "<string>",
    "cnameValue": "<string>",
    "cnamePriority": 123,
    "mxVerified": true,
    "spfVerified": true,
    "dkimVerified": true,
    "cnameVerified": true,
    "sendFromDomain": "<string>",
    "sendFromDomainId": "<string>",
    "sendFromVerified": true,
    "sendFromMxRecord": "<string>",
    "sendFromMxPriority": 123,
    "sendFromSpfHostname": "<string>",
    "sendFromSpfValue": "<string>",
    "sendFromDkimSelector": "<string>",
    "sendFromDkimHostname": "<string>",
    "sendFromDkimValue": "<string>",
    "sendFromCnameValue": "<string>",
    "sendFromCnamePriority": 123,
    "sendFromMxVerified": true,
    "sendFromSpfVerified": true,
    "sendFromDkimVerified": true,
    "sendFromCnameVerified": true,
    "verifiedAt": "<string>",
    "lastCheckedAt": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "sendGridSendFromEmail": "<string>"
  }
}
{
  "status": 400,
  "message": "Bad request",
  "code": "BAD_REQUEST",
  "success": false
}
{
  "status": 500,
  "message": "Internal server error",
  "code": "INTERNAL_SERVER_ERROR",
  "success": false
}

Authorizations

X-API-Key
string
header
required

Body

application/json
subdomain
string
required
Required string length: 1 - 63
Pattern: ^[a-zA-Z0-9]([a-zA-Z0-9-]*[a-zA-Z0-9])?$
domain
string
required
Minimum string length: 1
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-.]+\.[a-zA-Z]{2,}$
sendFromDomain
string
Minimum string length: 1
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-.]+\.[a-zA-Z]{2,}$

Response

Email domain created successfully

emailDomain
object
required