Create Email Domain
curl --request POST \
--url https://api.getoutbox.ai/email/domains/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"domain": "<string>",
"company": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dns_records": "<unknown>",
"verification_details": "<unknown>",
"is_default": true,
"is_deleted": true,
"verified_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"connection": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.getoutbox.ai/email/domains/"
payload = {
"domain": "<string>",
"company": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dns_records": "<unknown>",
"verification_details": "<unknown>",
"is_default": True,
"is_deleted": True,
"verified_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"connection": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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: '<string>',
company: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
dns_records: '<unknown>',
verification_details: '<unknown>',
is_default: true,
is_deleted: true,
verified_at: '2023-11-07T05:31:56Z',
created_at: '2023-11-07T05:31:56Z',
connection: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.getoutbox.ai/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://api.getoutbox.ai/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([
'domain' => '<string>',
'company' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'dns_records' => '<unknown>',
'verification_details' => '<unknown>',
'is_default' => true,
'is_deleted' => true,
'verified_at' => '2023-11-07T05:31:56Z',
'created_at' => '2023-11-07T05:31:56Z',
'connection' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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.getoutbox.ai/email/domains/"
payload := strings.NewReader("{\n \"domain\": \"<string>\",\n \"company\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dns_records\": \"<unknown>\",\n \"verification_details\": \"<unknown>\",\n \"is_default\": true,\n \"is_deleted\": true,\n \"verified_at\": \"2023-11-07T05:31:56Z\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"connection\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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.getoutbox.ai/email/domains/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"domain\": \"<string>\",\n \"company\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dns_records\": \"<unknown>\",\n \"verification_details\": \"<unknown>\",\n \"is_default\": true,\n \"is_deleted\": true,\n \"verified_at\": \"2023-11-07T05:31:56Z\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"connection\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoutbox.ai/email/domains/")
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\": \"<string>\",\n \"company\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dns_records\": \"<unknown>\",\n \"verification_details\": \"<unknown>\",\n \"is_default\": true,\n \"is_deleted\": true,\n \"verified_at\": \"2023-11-07T05:31:56Z\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"connection\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"company": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dns_records": "<unknown>",
"verification_details": "<unknown>",
"is_default": true,
"is_deleted": true,
"verified_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"connection": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}Email Providers, Domains & Senders
Add Email Domain
Register a new sending domain for the authenticated company. If connection is supplied it must reference an active SES EmailProviderConnection.
POST
/
email
/
domains
/
Create Email Domain
curl --request POST \
--url https://api.getoutbox.ai/email/domains/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"domain": "<string>",
"company": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dns_records": "<unknown>",
"verification_details": "<unknown>",
"is_default": true,
"is_deleted": true,
"verified_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"connection": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.getoutbox.ai/email/domains/"
payload = {
"domain": "<string>",
"company": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dns_records": "<unknown>",
"verification_details": "<unknown>",
"is_default": True,
"is_deleted": True,
"verified_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"connection": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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: '<string>',
company: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
dns_records: '<unknown>',
verification_details: '<unknown>',
is_default: true,
is_deleted: true,
verified_at: '2023-11-07T05:31:56Z',
created_at: '2023-11-07T05:31:56Z',
connection: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.getoutbox.ai/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://api.getoutbox.ai/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([
'domain' => '<string>',
'company' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'dns_records' => '<unknown>',
'verification_details' => '<unknown>',
'is_default' => true,
'is_deleted' => true,
'verified_at' => '2023-11-07T05:31:56Z',
'created_at' => '2023-11-07T05:31:56Z',
'connection' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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.getoutbox.ai/email/domains/"
payload := strings.NewReader("{\n \"domain\": \"<string>\",\n \"company\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dns_records\": \"<unknown>\",\n \"verification_details\": \"<unknown>\",\n \"is_default\": true,\n \"is_deleted\": true,\n \"verified_at\": \"2023-11-07T05:31:56Z\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"connection\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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.getoutbox.ai/email/domains/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"domain\": \"<string>\",\n \"company\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dns_records\": \"<unknown>\",\n \"verification_details\": \"<unknown>\",\n \"is_default\": true,\n \"is_deleted\": true,\n \"verified_at\": \"2023-11-07T05:31:56Z\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"connection\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoutbox.ai/email/domains/")
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\": \"<string>\",\n \"company\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dns_records\": \"<unknown>\",\n \"verification_details\": \"<unknown>\",\n \"is_default\": true,\n \"is_deleted\": true,\n \"verified_at\": \"2023-11-07T05:31:56Z\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"connection\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"company": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dns_records": "<unknown>",
"verification_details": "<unknown>",
"is_default": true,
"is_deleted": true,
"verified_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"connection": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Required string length:
1 - 255pending- Pendingverified- Verifiedfailed- Failed
Available options:
pending, verified, failed Response
Maximum string length:
255pending- Pendingverified- Verifiedfailed- Failed
Available options:
pending, verified, failed ⌘I

