Create a mailbox

POST

/v1/email/mailboxes

curl -X POST "https://us1.platform.bird.com/v1/email/mailboxes" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "local_part": "concierge",
    "display_name": "Acme Concierge",
    "retention_tier": "30d"
  }'

Creates a mailbox. The address is local_part@domain. The domain defaults to inbox.ai, Bird's shared mailbox domain, where creating the mailbox claims the address for your organization — first come, first served, and reserved to your organization even after the mailbox is deleted. You may instead name one of your own domains that is enabled for receiving email. An omitted local part is generated. On a custom domain, addresses of deleted mailboxes are quarantined: the same workspace can rebind one 30 days after deletion, other workspaces never can.

请求载荷

local_part

string

The local part of the mailbox address (the part before @). Letters, digits, dots, underscores, and hyphens; stored lowercase. On the shared inbox.ai domain, separators must sit between letters or digits (no leading, trailing, or repeated separators), reserved names such as postmaster or abuse are unavailable, and choosing your own local part uses one of your plan's custom-handle allowance slots (generated addresses are always available). Omit to have Bird generate a random local part.

domain

string

The domain the address lives under. Defaults to inbox.ai, Bird's shared mailbox domain, where creating the mailbox claims the address for your organization: first come, first served, and permanently reserved to your organization even after the mailbox is deleted. May instead name one of your own domains that is enabled for receiving email.

display_name

string

Display name used as the sender name on mail from this mailbox.

default_reply_to

string

Default Reply-To address stamped on mail sent from this mailbox.

receive_policy

string

Which inbound mail the mailbox accepts. open accepts everything not blocked by a rule; replies_only accepts only replies to messages this mailbox has sent (a reply must match a message the mailbox sent, not merely land in an existing thread); allowlist accepts only senders matching an allow rule; drop stores nothing.

Possible values: open, replies_only, allowlist, drop

retention_tier

string

How long the mailbox remembers message metadata and extracted text. Original rendered source is always available for 30 days regardless of tier. Only 30d is available today; longer tiers (90d, 1y, and beyond) are coming soon.

Possible values: 30d

metadata

object

Your own key/value data to attach to the mailbox. Up to 2 KB; keys starting with __bird are reserved.

响应载荷

string

必填

Mailbox ID.

address

string

必填

The mailbox's email address. Immutable once created.

display_name

nullable string

必填

Display name used as the sender name on mail from this mailbox. Null when unset.

default_reply_to

nullable string

必填

Default Reply-To address stamped on mail sent from this mailbox. Null when unset.

receive_policy

string

必填

Possible values: open, replies_only, allowlist, drop

state

string

必填

Lifecycle state. Suspended mailboxes stop emitting events; inbound mail is retained as blocked.

Possible values: active, suspended

channel

string

必填

The channel this mailbox receives on. Always email.

Possible values: email

owner

object

必填

The principal that owns the mailbox. Always the workspace.

显示子属性

owner.type

string

必填

Owner principal type.

Possible values: workspace

owner.id

string

必填

Owner principal ID.

inbound_address_id

string

必填

The underlying inbound address that receives this mailbox's mail.

retention_tier

string

必填

How long the mailbox remembers message metadata and extracted text. Original rendered source (HTML, raw message, attachments) is always available for 30 days regardless of tier. 3y and 10y are reserved future tiers.

Possible values: 30d, 90d, 1y

message_count

integer

必填

Number of retained messages across all threads.

thread_count

integer

必填

Number of retained threads.

unread_thread_count

nullable integer

Number of threads with unread messages in this mailbox, excluding trash. Null on create/update responses.

metadata

object

必填

Your own key/value data attached to the mailbox. Up to 2 KB; keys starting with __bird are reserved.

local_part_generated

boolean

Whether Bird generated the local part of the address. false means a custom handle was chosen at creation; on the shared inbox.ai domain a custom handle counts against your plan's custom-handle allowance.

created_at

string

必填

When the mailbox was created.

updated_at

string

必填

When the mailbox was last updated.

deleted_at

nullable string

When the mailbox was deleted, or null if it is active. A deleted mailbox stops receiving mail immediately but can be restored for 30 days, after which it and its remembered messages are permanently removed.

curl -X POST "https://us1.platform.bird.com/v1/email/mailboxes" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "local_part": "concierge",
    "display_name": "Acme Concierge",
    "retention_tier": "30d"
  }'