Update an address
curl --request PATCH \
--url https://inboundr.net/api/v1/addresses/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"endpointId": {},
"active": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({endpointId: {}, active: true})
};
fetch('https://inboundr.net/api/v1/addresses/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://inboundr.net/api/v1/addresses/{id}"
payload = {
"endpointId": {},
"active": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://inboundr.net/api/v1/addresses/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'endpointId' => [
],
'active' => 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;
}{
"id": "addr_123",
"domainId": "dom_123",
"localPart": "support",
"endpointId": null,
"active": true,
"createdAt": "2026-07-20T10:00:00.000Z",
"domain": "yourdomain.com",
"address": "support@yourdomain.com"
}
Email Addresses
Update an address
Change an address’s endpoint route or active state.
PATCH
/
api
/
v1
/
addresses
/
{id}
Update an address
curl --request PATCH \
--url https://inboundr.net/api/v1/addresses/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"endpointId": {},
"active": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({endpointId: {}, active: true})
};
fetch('https://inboundr.net/api/v1/addresses/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://inboundr.net/api/v1/addresses/{id}"
payload = {
"endpointId": {},
"active": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://inboundr.net/api/v1/addresses/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'endpointId' => [
],
'active' => 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;
}{
"id": "addr_123",
"domainId": "dom_123",
"localPart": "support",
"endpointId": null,
"active": true,
"createdAt": "2026-07-20T10:00:00.000Z",
"domain": "yourdomain.com",
"address": "support@yourdomain.com"
}
Repoints an address to a different endpoint (or makes it
store-only), and/or toggles whether it’s active. Provide at least one field.
string
required
The address id (
addr_…).string | null
A webhook endpoint (
ep_…) to deliver to, or null to make the address
store-only. Must be an endpoint you own.boolean
Whether the address accepts mail.
{
"id": "addr_123",
"domainId": "dom_123",
"localPart": "support",
"endpointId": null,
"active": true,
"createdAt": "2026-07-20T10:00:00.000Z",
"domain": "yourdomain.com",
"address": "support@yourdomain.com"
}
Returns
400 if endpointId is unknown, or 404 if the address isn’t yours.⌘I