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": "1y"
  }'

Creates a mailbox. The address is local_part@domain — the domain defaults to your workspace's agent domain, and an omitted local part is generated. 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. Omit to have Bird generate a random local part.

domain

string

The domain the address lives under. Defaults to your workspace's agent domain. May also name one of your inbound-enabled custom domains.

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.

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. 3y and 10y are reserved future tiers.

contact_id

string

A contact to associate the mailbox with.

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

必填

state

string

必填

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

channel

string

必填

The channel this mailbox receives on. Always email.

owner

object

必填

The principal that owns the mailbox. Always the workspace.

显示子属性

owner.type

string

必填

Owner principal type.

owner.id

string

必填

Owner principal ID.

contact_id

nullable string

必填

The contact this mailbox is associated with. Null when unset.

inbound_address_id

string

必填

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

storage_bytes

integer

必填

Logical size of the mailbox's retained memory, in bytes.

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.

message_count

integer

必填

Number of retained messages across all threads.

thread_count

integer

必填

Number of retained threads.

metadata

object

必填

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

created_at

string

必填

When the mailbox was created.

updated_at

string

必填

When the mailbox was last updated.

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": "1y"
  }'