Register an email sender
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/email/senders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"domain": "mail.acme.com",
"default_from_email": "hello@mail.acme.com",
"default_from_name": "Acme Support",
"default_reply_to": "support@mail.acme.com",
"isDefault": true
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/email/senders"
payload = {
"domain": "mail.acme.com",
"default_from_email": "hello@mail.acme.com",
"default_from_name": "Acme Support",
"default_reply_to": "support@mail.acme.com",
"isDefault": True
}
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.acme.com',
default_from_email: 'hello@mail.acme.com',
default_from_name: 'Acme Support',
default_reply_to: 'support@mail.acme.com',
isDefault: true
})
};
fetch('https://api.orbit.devotel.io/api/v1/email/senders', 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.orbit.devotel.io/api/v1/email/senders",
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.acme.com',
'default_from_email' => 'hello@mail.acme.com',
'default_from_name' => 'Acme Support',
'default_reply_to' => 'support@mail.acme.com',
'isDefault' => true
]),
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.orbit.devotel.io/api/v1/email/senders"
payload := strings.NewReader("{\n \"domain\": \"mail.acme.com\",\n \"default_from_email\": \"hello@mail.acme.com\",\n \"default_from_name\": \"Acme Support\",\n \"default_reply_to\": \"support@mail.acme.com\",\n \"isDefault\": true\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.orbit.devotel.io/api/v1/email/senders")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"domain\": \"mail.acme.com\",\n \"default_from_email\": \"hello@mail.acme.com\",\n \"default_from_name\": \"Acme Support\",\n \"default_reply_to\": \"support@mail.acme.com\",\n \"isDefault\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/email/senders")
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.acme.com\",\n \"default_from_email\": \"hello@mail.acme.com\",\n \"default_from_name\": \"Acme Support\",\n \"default_reply_to\": \"support@mail.acme.com\",\n \"isDefault\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"domain": "<string>",
"default_from_email": "<string>",
"default_from_name": "<string>",
"default_reply_to": "<string>",
"isDefault": true,
"createdAt": "2023-11-07T05:31:56Z",
"streamId": "<string>",
"dnsVerified": true,
"resendDomainId": "<string>",
"dnsRecords": [
{}
]
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Email
Register an email sender
Register a new email sending identity for a domain and optionally set its default from-name, from-address, reply-to, and sending stream. The domain is registered with the email provider so real SPF/DKIM records are issued — publish and verify them before the sender can send. Set isDefault: true to make it the org default. Requires an owner / admin role.
POST
/
api
/
v1
/
email
/
senders
Register an email sender
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/email/senders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"domain": "mail.acme.com",
"default_from_email": "hello@mail.acme.com",
"default_from_name": "Acme Support",
"default_reply_to": "support@mail.acme.com",
"isDefault": true
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/email/senders"
payload = {
"domain": "mail.acme.com",
"default_from_email": "hello@mail.acme.com",
"default_from_name": "Acme Support",
"default_reply_to": "support@mail.acme.com",
"isDefault": True
}
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.acme.com',
default_from_email: 'hello@mail.acme.com',
default_from_name: 'Acme Support',
default_reply_to: 'support@mail.acme.com',
isDefault: true
})
};
fetch('https://api.orbit.devotel.io/api/v1/email/senders', 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.orbit.devotel.io/api/v1/email/senders",
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.acme.com',
'default_from_email' => 'hello@mail.acme.com',
'default_from_name' => 'Acme Support',
'default_reply_to' => 'support@mail.acme.com',
'isDefault' => true
]),
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.orbit.devotel.io/api/v1/email/senders"
payload := strings.NewReader("{\n \"domain\": \"mail.acme.com\",\n \"default_from_email\": \"hello@mail.acme.com\",\n \"default_from_name\": \"Acme Support\",\n \"default_reply_to\": \"support@mail.acme.com\",\n \"isDefault\": true\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.orbit.devotel.io/api/v1/email/senders")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"domain\": \"mail.acme.com\",\n \"default_from_email\": \"hello@mail.acme.com\",\n \"default_from_name\": \"Acme Support\",\n \"default_reply_to\": \"support@mail.acme.com\",\n \"isDefault\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/email/senders")
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.acme.com\",\n \"default_from_email\": \"hello@mail.acme.com\",\n \"default_from_name\": \"Acme Support\",\n \"default_reply_to\": \"support@mail.acme.com\",\n \"isDefault\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"domain": "<string>",
"default_from_email": "<string>",
"default_from_name": "<string>",
"default_reply_to": "<string>",
"isDefault": true,
"createdAt": "2023-11-07T05:31:56Z",
"streamId": "<string>",
"dnsVerified": true,
"resendDomainId": "<string>",
"dnsRecords": [
{}
]
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Body
application/json
Sending domain to register (lowercased), e.g. mail.acme.com.
Default From address — must be on domain; omit or null to send as noreply@<domain>.
Display name shown to recipients.
Reply-To routing address.
Make this the org's default sender (demotes the previous default).
Assign the sender to a sending stream (estream_…), or null to leave it unassigned.
⌘I