Restore a deleted mailbox
POST
/v1/email/mailboxes/{mailbox_id}/restore
curl -X POST "https://us1.platform.bird.com/v1/email/mailboxes/{mailbox_id}/restore" \
-H "Authorization: Bearer $TOKEN"Restores a mailbox deleted less than 30 days ago. The address is bound back to the mailbox and starts receiving again, and the remembered messages and conversations are available as before the delete. Once the 30-day window has passed the mailbox and its messages are permanently deleted and can no longer be restored (404). Restoring a mailbox that is not deleted returns a conflict, as does an address that is no longer available.
Response Payload
id
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
आवश्यक
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
आवश्यक
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.