Skip to main content
POST
/
tenant
/
email-domain
Register a new email sending domain for the tenant
curl --request POST \
  --url https://api.royalti.io/tenant/email-domain \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "mail.yourlabel.com"
}
'
import requests

url = "https://api.royalti.io/tenant/email-domain"

payload = { "domain": "mail.yourlabel.com" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({domain: 'mail.yourlabel.com'})
};

fetch('https://api.royalti.io/tenant/email-domain', 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.royalti.io/tenant/email-domain",
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([
'domain' => 'mail.yourlabel.com'
]),
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 := "https://api.royalti.io/tenant/email-domain"

payload := strings.NewReader("{\n \"domain\": \"mail.yourlabel.com\"\n}")

req, _ := http.NewRequest("POST", 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.post("https://api.royalti.io/tenant/email-domain")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"domain\": \"mail.yourlabel.com\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/tenant/email-domain")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"domain\": \"mail.yourlabel.com\"\n}"

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "message": "Email domain created. Please add the DNS records to verify.",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "domain": "<string>",
    "status": "pending",
    "dnsRecords": {
      "dkim": {
        "host": "<string>",
        "value": "<string>",
        "priority": 123
      },
      "spf": {
        "host": "<string>",
        "value": "<string>",
        "priority": 123
      },
      "spfMx": {
        "host": "<string>",
        "value": "<string>",
        "priority": 123
      }
    },
    "instructions": "<string>"
  }
}
{
"status": "error",
"message": "<string>",
"code": "<string>",
"details": {}
}
{
"status": "error",
"message": "<string>",
"code": "<string>",
"details": {}
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

POST /tenant/email-domain Description: Registers the domain with the email sending provider and returns the DNS records (DKIM, SPF, and an MX record for the return-path) that must be added before the domain can be verified. A tenant may only have one email domain configured at a time; a domain can only be registered to one tenant. Authorization:
  • Required role: owner only
Method: POST

Code Examples

const response = await fetch('https://api.royalti.io/tenant/email-domain', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "ref": "#/components/schemas/CreateEmailDomainRequest"
  })
});

const data = await response.json();
console.log(data);
import requests

response = requests.post(
  'https://api.royalti.io/tenant/email-domain',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={"ref":"#/components/schemas/CreateEmailDomainRequest"}
)

data = response.json()
print(data)
curl -X POST https://api.royalti.io/tenant/email-domain \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ref":"#/components/schemas/CreateEmailDomainRequest"}'

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Body

application/json
domain
string
required
Example:

"mail.yourlabel.com"

Response

Email domain created

status
string
Example:

"success"

message
string
Example:

"Email domain created. Please add the DNS records to verify."

data
object