Get the tenant's complete email sending settings
curl --request GET \
--url https://api.royalti.io/tenant/email-settings \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.royalti.io/tenant/email-settings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.royalti.io/tenant/email-settings', 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-settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.royalti.io/tenant/email-settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.royalti.io/tenant/email-settings")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.royalti.io/tenant/email-settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"domain": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"senderEmail": "<string>",
"senderName": "<string>",
"dnsRecords": {
"dkim": {
"host": "<string>",
"value": "<string>",
"priority": 123
},
"spf": {
"host": "<string>",
"value": "<string>",
"priority": 123
}
},
"dkimVerified": true,
"spfVerified": true,
"verifiedAt": "2023-11-07T05:31:56Z",
"lastCheckedAt": "2023-11-07T05:31:56Z"
},
"branding": {
"fromName": "<string>",
"replyTo": "<string>",
"logoUrl": "<string>",
"primaryColor": "#006666",
"companyName": "<string>",
"companyAddress": "<string>",
"websiteUrl": "<string>",
"footerText": "<string>",
"unsubscribeUrl": "<string>"
},
"effectiveSender": {
"email": "noreply@royalti.io",
"name": "Royalti",
"isCustomDomain": true
},
"fieldRequirements": {
"alwaysAvailable": [
"replyTo",
"companyName",
"companyAddress",
"footerText"
],
"requiresVerifiedDomain": [
"fromName",
"logoUrl",
"primaryColor",
"websiteUrl",
"unsubscribeUrl"
],
"hasVerifiedDomain": true
}
}
}{
"status": "error",
"message": "<string>",
"code": "<string>",
"details": {}
}White Label
Get the tenant's complete email sending settings
GET /tenant/email-settings
GET
/
tenant
/
email-settings
Get the tenant's complete email sending settings
curl --request GET \
--url https://api.royalti.io/tenant/email-settings \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.royalti.io/tenant/email-settings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.royalti.io/tenant/email-settings', 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-settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.royalti.io/tenant/email-settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.royalti.io/tenant/email-settings")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.royalti.io/tenant/email-settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"domain": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"senderEmail": "<string>",
"senderName": "<string>",
"dnsRecords": {
"dkim": {
"host": "<string>",
"value": "<string>",
"priority": 123
},
"spf": {
"host": "<string>",
"value": "<string>",
"priority": 123
}
},
"dkimVerified": true,
"spfVerified": true,
"verifiedAt": "2023-11-07T05:31:56Z",
"lastCheckedAt": "2023-11-07T05:31:56Z"
},
"branding": {
"fromName": "<string>",
"replyTo": "<string>",
"logoUrl": "<string>",
"primaryColor": "#006666",
"companyName": "<string>",
"companyAddress": "<string>",
"websiteUrl": "<string>",
"footerText": "<string>",
"unsubscribeUrl": "<string>"
},
"effectiveSender": {
"email": "noreply@royalti.io",
"name": "Royalti",
"isCustomDomain": true
},
"fieldRequirements": {
"alwaysAvailable": [
"replyTo",
"companyName",
"companyAddress",
"footerText"
],
"requiresVerifiedDomain": [
"fromName",
"logoUrl",
"primaryColor",
"websiteUrl",
"unsubscribeUrl"
],
"hasVerifiedDomain": true
}
}
}{
"status": "error",
"message": "<string>",
"code": "<string>",
"details": {}
}This endpoint requires authentication. Include your Bearer token in the Authorization header.
Description
GET /tenant/email-settings Description: Combined view of the tenant’s email domain status and branding fields, plus the effective sender address/name that outbound email will currently use and which branding fields are unlocked based on domain verification. Authorization:- Required role:
useror higher
Code Examples
const response = await fetch('https://api.royalti.io/tenant/email-settings', {
method: 'GET',
headers: {
'Authorization': `Bearer ${token}`,
},
});
const data = await response.json();
console.log(data);
import requests
response = requests.get(
'https://api.royalti.io/tenant/email-settings',
headers={
'Authorization': f'Bearer {token}'
},
)
data = response.json()
print(data)
curl -X GET https://api.royalti.io/tenant/email-settings \
-H "Authorization: Bearer YOUR_TOKEN" \
Trigger a verification check for the tenant's email domain
Previous
Update the tenant's email sender configuration and/or branding
Next
⌘I