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": "1y"
}'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.
Parâmetros de consulta
confirm
boolean
Required as true when lowering retention_tier, acknowledging that remembered messages older than the new horizon are deleted.
Corpo da requisição
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.
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. 3y and 10y are reserved future tiers.
contact_id
nullable string
The contact this mailbox is associated with. Null clears it.
metadata
object
Replaces the mailbox's key/value data. Up to 2 KB; keys starting with __bird are reserved.
Payload de resposta
id
string
obrigatório
Mailbox ID.
address
string
obrigatório
The mailbox's email address. Immutable once created.
display_name
nullable string
obrigatório
Display name used as the sender name on mail from this mailbox. Null when unset.
default_reply_to
nullable string
obrigatório
Default Reply-To address stamped on mail sent from this mailbox. Null when unset.
receive_policy
string
obrigatório
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.
state
string
obrigatório
Lifecycle state. Suspended mailboxes stop emitting events; inbound mail is retained as blocked.
channel
string
obrigatório
The channel this mailbox receives on. Always email.
owner
object
obrigatório
The principal that owns the mailbox. Always the workspace.
Mostrar atributos secundários
owner.type
string
obrigatório
Owner principal type.
owner.id
string
obrigatório
Owner principal ID.
contact_id
nullable string
obrigatório
The contact this mailbox is associated with. Null when unset.
inbound_address_id
string
obrigatório
The underlying inbound address that receives this mailbox's mail.
storage_bytes
integer
obrigatório
Logical size of the mailbox's retained memory, in bytes.
retention_tier
string
obrigatório
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
obrigatório
Number of retained messages across all threads.
thread_count
integer
obrigatório
Number of retained threads.
metadata
object
obrigatório
Your own key/value data attached to the mailbox. Up to 2 KB; keys starting with __bird are reserved.
created_at
string
obrigatório
When the mailbox was created.
updated_at
string
obrigatório
When the mailbox was last updated.