Email addresses
Update Email Address
Update an address. Only the fields you send are changed, and an explicit null clears one — inbound_agent_version_id: null unassigns the agent.
Switching handler clears the other handler’s routing, so a demo address cannot keep a stale agent assignment (or the reverse).
PATCH
/
core
/
email-addresses
/
{address_id}
Update Email Address
curl --request PATCH \
--url https://api.anyreach.ai/core/email-addresses/{address_id} \
--header 'Content-Type: application/json' \
--data '
{
"inbound_agent_version_id": "<string>",
"outbound_from_address": "<string>",
"enabled": true,
"handler_config": {
"include_phone_number": false,
"instructions": "<string>",
"from_display_name": "<string>",
"signature": "<string>",
"reply_to_all": true,
"ignore_senders": [
"<string>"
]
}
}
'import requests
url = "https://api.anyreach.ai/core/email-addresses/{address_id}"
payload = {
"inbound_agent_version_id": "<string>",
"outbound_from_address": "<string>",
"enabled": True,
"handler_config": {
"include_phone_number": False,
"instructions": "<string>",
"from_display_name": "<string>",
"signature": "<string>",
"reply_to_all": True,
"ignore_senders": ["<string>"]
}
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
inbound_agent_version_id: '<string>',
outbound_from_address: '<string>',
enabled: true,
handler_config: {
include_phone_number: false,
instructions: '<string>',
from_display_name: '<string>',
signature: '<string>',
reply_to_all: true,
ignore_senders: ['<string>']
}
})
};
fetch('https://api.anyreach.ai/core/email-addresses/{address_id}', 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.anyreach.ai/core/email-addresses/{address_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([
'inbound_agent_version_id' => '<string>',
'outbound_from_address' => '<string>',
'enabled' => true,
'handler_config' => [
'include_phone_number' => false,
'instructions' => '<string>',
'from_display_name' => '<string>',
'signature' => '<string>',
'reply_to_all' => true,
'ignore_senders' => [
'<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"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.anyreach.ai/core/email-addresses/{address_id}"
payload := strings.NewReader("{\n \"inbound_agent_version_id\": \"<string>\",\n \"outbound_from_address\": \"<string>\",\n \"enabled\": true,\n \"handler_config\": {\n \"include_phone_number\": false,\n \"instructions\": \"<string>\",\n \"from_display_name\": \"<string>\",\n \"signature\": \"<string>\",\n \"reply_to_all\": true,\n \"ignore_senders\": [\n \"<string>\"\n ]\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://api.anyreach.ai/core/email-addresses/{address_id}")
.header("Content-Type", "application/json")
.body("{\n \"inbound_agent_version_id\": \"<string>\",\n \"outbound_from_address\": \"<string>\",\n \"enabled\": true,\n \"handler_config\": {\n \"include_phone_number\": false,\n \"instructions\": \"<string>\",\n \"from_display_name\": \"<string>\",\n \"signature\": \"<string>\",\n \"reply_to_all\": true,\n \"ignore_senders\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.anyreach.ai/core/email-addresses/{address_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"inbound_agent_version_id\": \"<string>\",\n \"outbound_from_address\": \"<string>\",\n \"enabled\": true,\n \"handler_config\": {\n \"include_phone_number\": false,\n \"instructions\": \"<string>\",\n \"from_display_name\": \"<string>\",\n \"signature\": \"<string>\",\n \"reply_to_all\": true,\n \"ignore_senders\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Headers
Organization ID for user PATs (pat_ prefix tokens)
Path Parameters
Body
application/json
Patch an inbound email routing address.
Available options:
agent, demo email_addresses.handler_config for a handler = 'demo' address.
Stored as jsonb, so every field needs a default — an address created before a field existed must still resolve.
Show child attributes
Show child attributes
Response
Successful Response
The response is of type Response Update Email Address Core Email Addresses Address Id Patch · object.
⌘I
Update Email Address
curl --request PATCH \
--url https://api.anyreach.ai/core/email-addresses/{address_id} \
--header 'Content-Type: application/json' \
--data '
{
"inbound_agent_version_id": "<string>",
"outbound_from_address": "<string>",
"enabled": true,
"handler_config": {
"include_phone_number": false,
"instructions": "<string>",
"from_display_name": "<string>",
"signature": "<string>",
"reply_to_all": true,
"ignore_senders": [
"<string>"
]
}
}
'import requests
url = "https://api.anyreach.ai/core/email-addresses/{address_id}"
payload = {
"inbound_agent_version_id": "<string>",
"outbound_from_address": "<string>",
"enabled": True,
"handler_config": {
"include_phone_number": False,
"instructions": "<string>",
"from_display_name": "<string>",
"signature": "<string>",
"reply_to_all": True,
"ignore_senders": ["<string>"]
}
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
inbound_agent_version_id: '<string>',
outbound_from_address: '<string>',
enabled: true,
handler_config: {
include_phone_number: false,
instructions: '<string>',
from_display_name: '<string>',
signature: '<string>',
reply_to_all: true,
ignore_senders: ['<string>']
}
})
};
fetch('https://api.anyreach.ai/core/email-addresses/{address_id}', 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.anyreach.ai/core/email-addresses/{address_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([
'inbound_agent_version_id' => '<string>',
'outbound_from_address' => '<string>',
'enabled' => true,
'handler_config' => [
'include_phone_number' => false,
'instructions' => '<string>',
'from_display_name' => '<string>',
'signature' => '<string>',
'reply_to_all' => true,
'ignore_senders' => [
'<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"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.anyreach.ai/core/email-addresses/{address_id}"
payload := strings.NewReader("{\n \"inbound_agent_version_id\": \"<string>\",\n \"outbound_from_address\": \"<string>\",\n \"enabled\": true,\n \"handler_config\": {\n \"include_phone_number\": false,\n \"instructions\": \"<string>\",\n \"from_display_name\": \"<string>\",\n \"signature\": \"<string>\",\n \"reply_to_all\": true,\n \"ignore_senders\": [\n \"<string>\"\n ]\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://api.anyreach.ai/core/email-addresses/{address_id}")
.header("Content-Type", "application/json")
.body("{\n \"inbound_agent_version_id\": \"<string>\",\n \"outbound_from_address\": \"<string>\",\n \"enabled\": true,\n \"handler_config\": {\n \"include_phone_number\": false,\n \"instructions\": \"<string>\",\n \"from_display_name\": \"<string>\",\n \"signature\": \"<string>\",\n \"reply_to_all\": true,\n \"ignore_senders\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.anyreach.ai/core/email-addresses/{address_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"inbound_agent_version_id\": \"<string>\",\n \"outbound_from_address\": \"<string>\",\n \"enabled\": true,\n \"handler_config\": {\n \"include_phone_number\": false,\n \"instructions\": \"<string>\",\n \"from_display_name\": \"<string>\",\n \"signature\": \"<string>\",\n \"reply_to_all\": true,\n \"ignore_senders\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}
