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"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.
响应载荷
id
string
必填
Inbound route ID.
domain
string
必填
The domain the route applies to.
match_type
string
必填
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
必填
The local part an address route matches. Null for catch_all routes.
action
string
必填
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
必填
The mailbox that receives matching mail. Null for drop routes.
priority
integer
必填
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
必填
Whether the route is evaluated. Disabled routes are kept but skipped.
created_at
string
必填
When the route was created.
updated_at
string
必填
When the route was last updated.