email-inbound-routes

Get an inbound route

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.

get/v1/email/inbound-routes/{route_id}

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/email/inbound-routes/{route_id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

Inbound route object.

idstring required
domainstring required

The domain the route applies to.

match_type'address' | 'catch_all' required

How the route matches recipients. address matches one local part. catch_all matches every recipient on the domain that nothing else matched.

match_valuestring nullable required

The local part an address route matches. null for catch_all routes.

action'deliver_to_mailbox' | 'drop' 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.

target_mailbox_idstring required
priorityinteger 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.

enabledboolean required

Whether the route is evaluated. Disabled routes are kept but skipped.

created_atstring date-time required

When the route was created.

updated_atstring date-time required

When the route was last updated.

Example response

{
  "id": "ein_01krdgeqcxet5s7t44vh8rt9mg",
  "domain": "mail.acme.com",
  "match_value": "refunds",
  "target_mailbox_id": "mbx_01krdgeqcxet5s7t44vh8rt9mg"
}

Changes

No recorded changes to this operation across all 3 revisions of this API.