Where addresses live
Every address has a local part and a domain. The local part may contain letters, numbers, and hyphens only — nothing else passes validation. The domain must be one of:- The default
agents.anyreach.aidomain, available to every organization. - Any custom domain your organization has added and verified.
400. Add and verify the domain first under Connecting a domain.
Addresses are globally unique. If the address is already in use — by your organization or any other — the create call returns
409.Routing to an agent
An address routes to exactly one agent version. You can specify the target two ways:
If you pass
agent_id without inbound_agent_version_id, the latest published version of that agent is resolved and stored. If the agent has no resolvable published version, the call returns 400.
Only published versions answer mail. Configure the agent itself — prompts, tools, reply behavior — under Configuring an email agent.
Fields
The
outbound_from_address is the reply-from: when the agent answers, mail is sent from this address. Leave it blank to reply from the inbound address itself.
Create an address
1
Choose the address
Pick a local part (letters, numbers, and hyphens only) and a domain — either
agents.anyreach.ai or a verified custom domain.2
Pick the agent
Set
agent_id to route to the agent’s latest published version, or inbound_agent_version_id to pin a specific published version.3
Set the reply-from and toggle
Optionally set
outbound_from_address for replies, and leave enabled on so the agent answers immediately.Org API keys (
ak_) carry their organization implicitly and omit the X-Anyreach-Org header. User PATs (pat_) require it.Update or unassign an agent
Send aPATCH to change the routed version, the reply-from, or the enabled toggle. Only the fields you include are changed; omitted fields are left untouched.
To unassign the agent entirely, send inbound_agent_version_id explicitly set to null. The address stays, but no agent answers it.
API reference
Reading addresses requires the
email_addresses:read or email_addresses:manage scope. Creating, updating, and deleting require email_addresses:manage.
Constraints
Related
Connecting a domain
Add and verify a custom domain so you can use it for inbound addresses.
Configuring an email agent
Set up the agent that answers mail delivered to an address.

