bird email mailboxes update
Usage
Code example
bird email mailboxes update <mailbox-id> [flags]Description
Update a mailbox
Only the fields you pass change; the address and domain can't be changed.
To clear a nullable field (display-name, default-reply-to), pass an explicit null
in the request body: no flag sends a null, and --body-file takes a path or "-"
for stdin, never inline JSON.
Build the request from flags, a JSON MailboxUpdate body via --body-file ("-" reads
stdin), or both — a flag overrides the matching body field. Run --example to
print a ready-to-edit body, or --dry-run to print the resolved request without
sending it.
Examples
Code example
# print the body shape (no credentials needed)
bird email mailboxes update --example
# the body it prints:Code example
{
"display_name": "Acme Concierge",
"retention_tier": "30d"
}Code example
# clear the display name (a null only reaches the wire on stdin)
echo '{"display_name": null}' | bird email mailboxes update <mailbox-id> --body-file -Options
Address
| Name | Description |
|---|---|
| --display-name | Sender display name on outgoing mail |
| --default-reply-to | Default Reply-To address stamped on outgoing mail |
Behavior
| Name | Description |
|---|---|
| --receive-policy | Which inbound mail to accept: open, replies_only, allowlist, or drop |
| --retention-tier | How long to keep message metadata, extracted text, and attachments: 30d, 90d, or 1y (longer tiers need a plan that includes them; message bodies stay 30 days regardless) |
| --confirm | Required when lowering retention-tier would delete older messages |
Metadata
| Name | Description |
|---|---|
| --metadata | Arbitrary JSON metadata object; replaces the existing metadata |
Request
| Name | Description |
|---|---|
| --body-file | Read the JSON request body from this file; "-" reads stdin |
| --example | Print a complete example request body, then exit |
| --dry-run | Print the resolved request without sending it, then exit |
| --idempotency-key | Deduplication key; a retry with the same key won't act twice |
Options
| Name | Description |
|---|---|
| --response-schema | Print the fields this command returns, then exit |
Related
| Name | Description |
|---|---|
| bird email mailboxes compose | Send a new message from a mailbox |
| bird email mailboxes create | Create a mailbox |
| bird email mailboxes delete | Delete a mailbox |
| bird email mailboxes get | Get a mailbox |
| bird email mailboxes labels | List a mailbox's labels |
| bird email mailboxes list | List mailboxes |
| bird email mailboxes restore | Restore a deleted mailbox |
| bird email mailboxes resume | Resume a suspended mailbox |
| bird email mailboxes stats | Get mailbox email statistics |
Related resources
Continue with the documentation, guides and examples for this topic. Resources are in English.
Watch the guideSetting up your coding agentUnderstand the conceptWhat is an MCP server, and how does an agent use one to send messages?Explore the capabilityCoding agentsFollow the learning pathBuild with AI agents
Get an implementation brief