Create a mailbox
POST
/v1/email/mailboxes
const mailbox = await bird.email.mailboxes.create({ display_name: "Support" });
console.log(mailbox.address); // "abc123@inbox.ai"mailbox = client.email.mailboxes.create(display_name="Acme Support")
print(mailbox.id)mailbox, err := client.Email.Mailboxes.Create(context.Background(), bird.EmailMailboxesCreateParams{
DisplayName: "Support",
})
if err != nil {
log.Fatal(err)
}
fmt.Println(mailbox.Id, *mailbox.Address)$mailbox = $bird->email->mailboxes->create(
(new MailboxCreate())
->setDisplayName('Acme Support'),
);
echo $mailbox->getId(), ' ', $mailbox->getAddress();bird email mailboxes create \
--display-name 'Acme Concierge' \
--local-part concierge \
--receive-policy open \
--retention-tier 30dcurl -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",
"receive_policy": "open",
"retention_tier": "30d"
}'Resposta201
{
"id": "mbx_01krdgeqcxet5s7t44vh8rt9mg",
"address": "concierge@inbox.ai",
"display_name": "Acme Concierge",
"receive_policy": "open",
"state": "active",
"channel": "email",
"owner": {
"type": "workspace",
"id": "ws_01krdgeqcxet5s7t44vh8rt9mg"
},
"inbound_address_id": "ina_01krdgeqcxet5s7t44vh8rt9mg",
"retention_tier": "30d"
}
Creates a mailbox. The address is local_part@domain. The domain defaults to inbox.ai, Bird's shared mailbox domain, where creating the mailbox claims the address for your organization. It is first come, first served, and reserved to your organization even after the mailbox is deleted. You may instead name one of your own domains that is enabled for receiving email. An omitted local part is generated. On a custom domain, addresses of deleted mailboxes are quarantined for 30 days and remain reserved for your workspace.
Corpo da requisição
local_part
string
The local part of the mailbox address (the part before @). Letters, digits, dots, underscores, and hyphens. Stored lowercase. On the shared inbox.ai domain, separators must sit between letters or digits. Leading, trailing, and repeated separators are not allowed. Reserved names such as postmaster and abuse are unavailable. Choosing your own local part uses one of your plan's custom-handle allowance slots; generated addresses remain available. Omit this field to generate a random local part.
domain
string
The domain the address lives under. Defaults to inbox.ai, our shared mailbox domain. Creating a mailbox claims the shared address for your organization on a first-come, first-served basis. The address remains reserved to your organization after the mailbox is deleted. You can instead use one of your own domains enabled for receiving email.
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. Landing in an existing thread by itself does not count.
- allowlist: Accepts only senders matching an allow rule.
- drop: Stores nothing.
Possible values: open, replies_only, allowlist, drop
retention_tier
string
How long message metadata, extracted text, and attachments are kept. Original bodies and inbound raw MIME are limited to 30 days on every tier. Longer tiers require a plan that includes them.
Possible values: 30d, 90d, 1y
metadata
object
Your own key/value data to attach to the mailbox. 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. Landing in an existing thread by itself does not count.
- allowlist: Accepts only senders matching an allow rule. Replies to prior outbound mail are always admitted unless blocked.
- drop: Stores nothing.
Possible values: open, replies_only, allowlist, drop
state
string
obrigatório
Lifecycle state. active means the mailbox can send, receive, and expose conversations. suspended pauses sending, conversation reads, and events; inbound mail is retained with the blocked label until you resume it.
Possible values: active, suspended
channel
string
obrigatório
The channel this mailbox receives on. Always email.
Possible values: 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.
Possible values: workspace
owner.id
string
obrigatório
Owner principal ID.
inbound_address_id
string
obrigatório
The underlying inbound address that receives this mailbox's mail.
retention_tier
string
obrigatório
How long message metadata, extracted text, and attachments are kept. Original bodies and inbound raw MIME are limited to 30 days on every tier.
Possible values: 30d, 90d, 1y
message_count
integer
obrigatório
Number of retained messages across all threads.
thread_count
integer
obrigatório
Number of retained threads.
size_bytes
integer
obrigatório
Stored bytes across the mailbox's retained messages: subject, preview, extracted text, and attachment bytes. Message bodies and raw MIME expire after 30 days and do not count. Maintained with each message written or deleted, so the value is current; messages stored before the counter existed are not counted.
unread_thread_count
nullable integer
Number of threads with unread messages in this mailbox, excluding trash. null on create/update responses.
metadata
object
obrigatório
Your own key/value data attached to the mailbox. Up to 2 KB. Keys starting with __bird are reserved.
local_part_generated
boolean
obrigatório
Whether we 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
obrigatório
When the mailbox was created.
updated_at
string
obrigatório
When the mailbox was last updated.
deleted_at
nullable string
When the mailbox was deleted, or null if active. Deletion stops receiving; restore is available for 30 days unless permanent erasure has started.
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