Get an inbound route
GET
/v1/email/inbound-routes/{route_id}
curl -X GET "https://us1.platform.bird.com/v1/email/inbound-routes/{route_id}" \
-H "Authorization: Bearer $TOKEN"Response200
{
"id": "ein_01krdgeqcxet5s7t44vh8rt9mg",
"domain": "mail.acme.com",
"match_type": "address",
"match_value": "refunds",
"action": "deliver_to_mailbox",
"target_mailbox_id": "mbx_01krdgeqcxet5s7t44vh8rt9mg"
}
Returns a single inbound route:
- Its match rule.
- Its action.
- Its target mailbox.
- Its priority.
- Its enabled state.
Use List inbound routes to see every route in evaluation order.
Parameters
route_id
string
Inbound route identifier. Starts with ein_.
Response Payload
id
string
required
Inbound route ID.
domain
string
required
The domain the route applies to.
match_type
string
required
How the route matches recipients. address matches one local part. catch_all matches every recipient on the domain that nothing else matched.
Possible values: address, catch_all
match_value
nullable string
required
The local part an address route matches. null for catch_all routes.
action
string
required
What happens to matching mail. deliver_to_mailbox delivers it to target_mailbox_id. drop discards it silently, with nothing stored and no webhook fired.
Possible values: deliver_to_mailbox, drop
target_mailbox_id
nullable string
required
The mailbox that receives matching mail. null for drop routes.
priority
integer
required
The order routes are tried in, lowest number first. Your own routes take a priority from 11 to 1000, and default to 100. A mailbox's own address always matches at priority 10.
enabled
boolean
required
Whether the route is evaluated. Disabled routes are kept but skipped.
created_at
string
required
When the route was created.
updated_at
string
required
When the route was last updated.