Update a mailbox
PATCH
/v1/email/mailboxes/{mailbox_id}
curl -X PATCH "https://us1.platform.bird.com/v1/email/mailboxes/{mailbox_id}" \
-H "Authorization: Bearer $TOKEN" \
--url-query "confirm=false" \
-H "Content-Type: application/json" \
-d '{
"display_name": "Acme Concierge",
"retention_tier": "30d"
}'Updates a mailbox. The address and domain are immutable. Lowering the retention tier deletes remembered messages older than the new horizon — pass confirm=true to acknowledge.
Parameter Kueri
confirm
boolean
Required as true when lowering retention_tier, acknowledging that remembered messages older than the new horizon are deleted.
Payload Permintaan
display_name
nullable string
Display name used as the sender name on mail from this mailbox. Null clears it.
default_reply_to
nullable string
Default Reply-To address stamped on mail sent from this mailbox. Null clears it.
receive_policy
string
Which inbound mail the mailbox accepts.
Possible values: open, replies_only, allowlist, drop
retention_tier
string
How long the mailbox remembers message metadata and extracted text. Lowering the tier deletes memory older than the new horizon and requires confirm=true when messages older than the new horizon would be deleted. Only 30d is available today; longer tiers (90d, 1y, and beyond) are coming soon.
Possible values: 30d
metadata
object
Replaces the mailbox's key/value data. Up to 2 KB; keys starting with __bird are reserved.
Payload Respons
id
string
wajib
Mailbox ID.
address
string
wajib
The mailbox's email address. Immutable once created.
display_name
nullable string
wajib
Display name used as the sender name on mail from this mailbox. Null when unset.
default_reply_to
nullable string
wajib
Default Reply-To address stamped on mail sent from this mailbox. Null when unset.
receive_policy
string
wajib
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 (replies to prior outbound are always admitted unless blocked); drop stores nothing.
Possible values: open, replies_only, allowlist, drop
state
string
wajib
Lifecycle state. Suspended mailboxes stop emitting events; inbound mail is retained as blocked.
Possible values: active, suspended
channel
string
wajib
The channel this mailbox receives on. Always email.
Possible values: email
owner
object
wajib
The principal that owns the mailbox. Always the workspace.
Tampilkan atribut turunan
owner.type
string
wajib
Owner principal type.
Possible values: workspace
owner.id
string
wajib
Owner principal ID.
inbound_address_id
string
wajib
The underlying inbound address that receives this mailbox's mail.
retention_tier
string
wajib
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
wajib
Number of retained messages across all threads.
thread_count
integer
wajib
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
wajib
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
wajib
When the mailbox was created.
updated_at
string
wajib
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.