Update an inbound route
PATCH
/v1/email/inbound-routes/{route_id}
curl -X PATCH "https://us1.platform.bird.com/v1/email/inbound-routes/{route_id}" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"priority": 50
}'Updates an inbound route. The domain is immutable. Disabled routes are kept but skipped during evaluation.
Request Payload
match_type
string
How the route matches recipients.
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 requires target_mailbox_id.
target_mailbox_id
nullable string
The mailbox that receives matching mail. Null for drop routes.
priority
integer
Evaluation order — lowest number wins. Explicit routes accept 11–1000; the mailbox's own address always matches at priority 10.
enabled
boolean
Whether the route is evaluated.
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.
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.
target_mailbox_id
nullable string
required
The mailbox that receives matching mail. Null for drop routes.
priority
integer
required
Evaluation order — lowest number wins. Explicit routes accept 11–1000 (default 100); the 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.