curl --request POST \
--url https://api.senderkit.com/v1/inbound/addresses \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"localPart": "support",
"description": "Customer support intake"
}
'import requests
url = "https://api.senderkit.com/v1/inbound/addresses"
payload = {
"localPart": "support",
"description": "Customer support intake"
}
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({localPart: 'support', description: 'Customer support intake'})
};
fetch('https://api.senderkit.com/v1/inbound/addresses', 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/addresses",
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([
'localPart' => 'support',
'description' => 'Customer support intake'
]),
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/addresses"
payload := strings.NewReader("{\n \"localPart\": \"support\",\n \"description\": \"Customer support intake\"\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/addresses")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"localPart\": \"support\",\n \"description\": \"Customer support intake\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.senderkit.com/v1/inbound/addresses")
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 \"localPart\": \"support\",\n \"description\": \"Customer support intake\"\n}"
response = http.request(request)
puts response.read_body{
"id": "inb_0a1b2c3d4e5f6g7h",
"address": "support@acme.in.senderkit.email",
"description": "<string>",
"forwardTo": "<string>",
"active": true,
"livemode": true,
"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
}
}Create an inbound address
Provisions a new address on the workspace’s shared receiving domain.
The domain itself is created lazily on first call. Omit localPart to
get an unguessable generated one (rcv-xxxxxxxxxx); a caller-supplied
localPart must be unique on the domain.
curl --request POST \
--url https://api.senderkit.com/v1/inbound/addresses \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"localPart": "support",
"description": "Customer support intake"
}
'import requests
url = "https://api.senderkit.com/v1/inbound/addresses"
payload = {
"localPart": "support",
"description": "Customer support intake"
}
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({localPart: 'support', description: 'Customer support intake'})
};
fetch('https://api.senderkit.com/v1/inbound/addresses', 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/addresses",
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([
'localPart' => 'support',
'description' => 'Customer support intake'
]),
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/addresses"
payload := strings.NewReader("{\n \"localPart\": \"support\",\n \"description\": \"Customer support intake\"\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/addresses")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"localPart\": \"support\",\n \"description\": \"Customer support intake\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.senderkit.com/v1/inbound/addresses")
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 \"localPart\": \"support\",\n \"description\": \"Customer support intake\"\n}"
response = http.request(request)
puts response.read_body{
"id": "inb_0a1b2c3d4e5f6g7h",
"address": "support@acme.in.senderkit.email",
"description": "<string>",
"forwardTo": "<string>",
"active": true,
"livemode": true,
"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
}
}Body
1-64 chars of a-z 0-9 . _ -, starting and ending
alphanumeric. Lowercased. Omit to auto-generate.
Pass "*" instead to create a catch-all: it receives
every message sent to the domain that doesn't match one
of your other addresses on it (an exact address always
wins over the catch-all), including mail to reserved
local parts like postmaster that can't be minted as
their own address. "*" is a sentinel, not a normal
local part — it bypasses both the character-format rule
above and the reserved-name check.
1 - 64Response
The created address.