Create an inbound route
POST
/v1/email/inbound-routes
curl -X POST "https://us1.platform.bird.com/v1/email/inbound-routes" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"domain": "acme-support.eu.mailbox.bird.com",
"match_type": "address",
"match_value": "refunds",
"action": "deliver_to_mailbox",
"target_mailbox_id": "mbx_01krdgeqcxet5s7t44vh8rt9mg"
}'Creates an inbound route on one of your domains. Routes are evaluated in priority order, lowest number first; the routes you create take priorities 11–1000. A mailbox's own address is always matched ahead of every route you create, so an exact-address match takes precedence over your routes. address routes match one local part; a catch_all route matches anything no more specific route matched.
Corpo da requisição
domain
string
obrigatório
The domain the route applies to — your agent domain or one of your inbound-enabled custom domains.
match_type
string
obrigatório
How the route matches recipients. address matches one local part and requires match_value; catch_all matches every recipient on the domain that nothing else matched.
match_value
string
The local part an address route matches. Required for address routes; stored lowercase.
action
string
obrigatório
What happens to matching mail. deliver_to_mailbox requires target_mailbox_id.
target_mailbox_id
string
The mailbox that receives matching mail. Required for deliver_to_mailbox routes.
priority
integer
Evaluation order — lowest number wins. Explicit routes accept 11–1000; the mailbox's own address always matches at priority 10, so a route can never pre-empt exact-address delivery.
enabled
boolean
Whether the route is evaluated.
Payload de resposta
id
string
obrigatório
Inbound route ID.
domain
string
obrigatório
The domain the route applies to.
match_type
string
obrigatório
How the route matches recipients. address matches one local part; catch_all matches every recipient on the domain that nothing else matched.
match_value
nullable string
obrigatório
The local part an address route matches. Null for catch_all routes.
action
string
obrigatório
What happens to matching mail.
target_mailbox_id
nullable string
obrigatório
The mailbox that receives matching mail. Null for drop routes.
priority
integer
obrigatório
Evaluation order — lowest number wins. Explicit routes accept 11–1000 (default 100); the mailbox's own address always matches at priority 10.
enabled
boolean
obrigatório
Whether the route is evaluated. Disabled routes are kept but skipped.
created_at
string
obrigatório
When the route was created.
updated_at
string
obrigatório
When the route was last updated.