curl --request POST \
--url https://api.senderkit.com/v1/inbound/domains \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"domain": "inbound.acme.com"
}
'import requests
url = "https://api.senderkit.com/v1/inbound/domains"
payload = { "domain": "inbound.acme.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: 'inbound.acme.com'})
};
fetch('https://api.senderkit.com/v1/inbound/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.senderkit.com/v1/inbound/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' => 'inbound.acme.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.senderkit.com/v1/inbound/domains"
payload := strings.NewReader("{\n \"domain\": \"inbound.acme.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.senderkit.com/v1/inbound/domains")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"domain\": \"inbound.acme.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.senderkit.com/v1/inbound/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\": \"inbound.acme.com\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "inbound.acme.com",
"kind": "shared",
"status": "pending",
"records": [
{
"type": "TXT",
"name": "<string>",
"value": "<string>",
"purpose": "<string>",
"check": "dkim",
"priority": 123
}
],
"verifiedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"issues": [
{}
],
"limit": 123
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"issues": [
{}
],
"limit": 123
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"issues": [
{}
],
"limit": 123
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"issues": [
{}
],
"limit": 123
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"issues": [
{}
],
"limit": 123
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"issues": [
{}
],
"limit": 123
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"issues": [
{}
],
"limit": 123
}
}Claim a custom inbound domain
Claims a domain or subdomain you own for receiving mail. Publish the
returned records, then poll GET /v1/inbound/domains/{id} until
status is verified.
Publishing our MX replaces wherever the domain’s mail currently goes.
If the domain already has a live mail host, this call 409s with
existing_mx and the current hosts; retry with
acknowledgeExistingMx: true once you’ve confirmed the redirect is
intended.
curl --request POST \
--url https://api.senderkit.com/v1/inbound/domains \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"domain": "inbound.acme.com"
}
'import requests
url = "https://api.senderkit.com/v1/inbound/domains"
payload = { "domain": "inbound.acme.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: 'inbound.acme.com'})
};
fetch('https://api.senderkit.com/v1/inbound/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.senderkit.com/v1/inbound/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' => 'inbound.acme.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.senderkit.com/v1/inbound/domains"
payload := strings.NewReader("{\n \"domain\": \"inbound.acme.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.senderkit.com/v1/inbound/domains")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"domain\": \"inbound.acme.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.senderkit.com/v1/inbound/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\": \"inbound.acme.com\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "inbound.acme.com",
"kind": "shared",
"status": "pending",
"records": [
{
"type": "TXT",
"name": "<string>",
"value": "<string>",
"purpose": "<string>",
"check": "dkim",
"priority": 123
}
],
"verifiedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"issues": [
{}
],
"limit": 123
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"issues": [
{}
],
"limit": 123
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"issues": [
{}
],
"limit": 123
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"issues": [
{}
],
"limit": 123
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"issues": [
{}
],
"limit": 123
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"issues": [
{}
],
"limit": 123
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"issues": [
{}
],
"limit": 123
}
}Authorizations
API key with an sk_live_ or sk_test_ prefix.
Body
Response
The claimed domain, with the DNS records to publish.
Inbound domain ID (the row's UUID — there is no separate public id).
"inbound.acme.com"
shared is the workspace's auto-provisioned
{slug}.in.senderkit.email domain, which needs no DNS of its own.
custom is a domain you claimed and must verify by publishing
records.
shared, custom pending, verified, failed DNS records to publish for this domain to verify. Always empty
for shared domains — the wildcard MX on the shared domain
already covers them.
Show child attributes
Show child attributes