Add or update a custom domain for email sending

curl --request PUT \
  --url http://localhost:8080/email/domains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domainName": "<string>"
}
'

import requests

url = "http://localhost:8080/email/domains"

payload = { "domainName": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({domainName: '<string>'})
};

fetch('http://localhost:8080/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_PORT => "8080",
  CURLOPT_URL => "http://localhost:8080/email/domains",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'domainName' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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 := "http://localhost:8080/email/domains"

	payload := strings.NewReader("{\n  \"domainName\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.put("http://localhost:8080/email/domains")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"domainName\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8080/email/domains")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"domainName\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "domainRecords": null,
  "domainStatus": "<string>"
}

{
  "statusCode": 400,
  "message": "<string>",
  "error": "domain_registered_elsewhere"
}

{
  "statusCode": 400,
  "message": "<string>",
  "error": "domain_registered_elsewhere"
}

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

{
  "statusCode": 400,
  "message": "<string>",
  "error": "domain_registered_elsewhere"
}

PUT

domains

Add or update a custom domain for email sending

curl --request PUT \
  --url http://localhost:8080/email/domains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domainName": "<string>"
}
'

import requests

url = "http://localhost:8080/email/domains"

payload = { "domainName": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({domainName: '<string>'})
};

fetch('http://localhost:8080/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_PORT => "8080",
  CURLOPT_URL => "http://localhost:8080/email/domains",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'domainName' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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 := "http://localhost:8080/email/domains"

	payload := strings.NewReader("{\n  \"domainName\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.put("http://localhost:8080/email/domains")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"domainName\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8080/email/domains")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"domainName\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "domainRecords": null,
  "domainStatus": "<string>"
}

{
  "statusCode": 400,
  "message": "<string>",
  "error": "domain_registered_elsewhere"
}

{
  "statusCode": 400,
  "message": "<string>",
  "error": "domain_registered_elsewhere"
}

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

{
  "statusCode": 400,
  "message": "<string>",
  "error": "domain_registered_elsewhere"
}

Use the optional region field when adding a sending domain:

Value	Sending region
`eu-west-1`	EU (Ireland), the default for new domains
`us-east-1`	US (North Virginia)

{
  "domainName": "support.example.com",
  "region": "eu-west-1"
}

The region cannot be changed after adding the domain. Adding an existing domain returns its existing configuration; it does not change the region. See Sending Domains & DNS for setup and verification.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

domainName

string

required

region

enum<string>

Sending region: EU (Ireland) or US (North Virginia). Defaults to eu-west-1 for new domains. Cannot be changed after creation.

Available options:

eu-west-1,

us-east-1

Response

Default Response

domainRecords

unknown

required

domainStatus

string | null

required

Overview

Blocklist

Autopilot

Organization

Contacts

Companies

Sessions

Connect

AI Phone Agents

Classical IVR

AI Email

AI WhatsApp

AI Actions

Sequences

Outbound Blocklist

Media

AI Training

Help Center

Resource Usage

Customer Insights

Teams

CSAT

Redaction

Crawl

Tags

Custom Statuses

Inbox Views

Office Hours

Handoff Analytics

SLA Analytics

Secrets

Audit Logs

Workflows (Beta)

Salesforce MIAW

Webhooks

Add or update a custom domain for email sending

Authorizations

Body

Response