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. Omitted fields are unchanged; the domain is immutable. Cross-field rules are validated against the merged result, so an update that leaves the route inconsistent (such as deliver_to_mailbox without a target mailbox) returns 422. Disabled routes are kept but skipped during evaluation.
Anfrage-Nutzlast
match_type
string
How the route matches recipients.
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 (required); 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
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.
Antwort-Payload
id
string
erforderlich
Inbound route ID.
domain
string
erforderlich
The domain the route applies to.
match_type
string
erforderlich
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
erforderlich
The local part an address route matches. Null for catch_all routes.
action
string
erforderlich
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
erforderlich
The mailbox that receives matching mail. Null for drop routes.
priority
integer
erforderlich
Evaluation order — lowest number wins. Explicit routes accept 11–1000 (default 100); the mailbox's own address always matches at priority 10.
enabled
boolean
erforderlich
Whether the route is evaluated. Disabled routes are kept but skipped.
created_at
string
erforderlich
When the route was created.
updated_at
string
erforderlich
When the route was last updated.