curl --request POST \
--url https://app.sendmux.ai/api/v1/mailboxes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "<string>"
}
'{
"ok": true,
"data": {
"mailbox": {
"id": "mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx",
"email": "agent@acme.com",
"display_name": "<string>",
"quota_bytes": 123,
"send_scope": {
"type": "all",
"provider_public_ids": [
"<string>"
],
"group_public_ids": [
"<string>"
]
},
"status": "active",
"created_at": "<string>"
},
"api_key": {
"public_id": "smx_clxxxxxxxxxxxxxxxxxxxxxxxxx",
"key": "<string>",
"key_prefix": "<string>",
"key_suffix": "<string>"
},
"imap_smtp_credentials": {
"server": "<string>",
"imap_port": 123,
"smtp_port": 123,
"username": "<string>",
"password": "<string>"
},
"warning": "<string>"
},
"meta": {
"request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
}
}Provisions a new mailbox plus an initial bearer token and matching IMAP/SMTP app password. The domain portion of the email must already be verified via POST /domains. Creation provisions resources on our mail platform and, for @myagent.mx addresses, on Amazon SES — any failure rolls the partial state back automatically.
Supply an Idempotency-Key header (any unique string, max 255 chars) to safely retry on network errors. Replays with the same key return the original response; replays with a different body return 409 idempotency_conflict.
curl --request POST \
--url https://app.sendmux.ai/api/v1/mailboxes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "<string>"
}
'{
"ok": true,
"data": {
"mailbox": {
"id": "mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx",
"email": "agent@acme.com",
"display_name": "<string>",
"quota_bytes": 123,
"send_scope": {
"type": "all",
"provider_public_ids": [
"<string>"
],
"group_public_ids": [
"<string>"
]
},
"status": "active",
"created_at": "<string>"
},
"api_key": {
"public_id": "smx_clxxxxxxxxxxxxxxxxxxxxxxxxx",
"key": "<string>",
"key_prefix": "<string>",
"key_suffix": "<string>"
},
"imap_smtp_credentials": {
"server": "<string>",
"imap_port": 123,
"smtp_port": 123,
"username": "<string>",
"password": "<string>"
},
"warning": "<string>"
},
"meta": {
"request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
}
}Documentation Index
Fetch the complete documentation index at: https://docs.sendmux.ai/llms.txt
Use this file to discover all available pages before exploring further.
Sendmux API key. Obtain from the dashboard under API Keys. Format: smx_root_...
Client-chosen unique key to safely retry the request. Cached for 24h per (team, endpoint, key). Different body with same key returns 409 idempotency_conflict.
255"mailboxes-create-20260424-001"
5 - 2541 - 255x >= 1Mailbox created. The response carries a Location header pointing at the canonical GET URL for the new mailbox.
true Hide child attributes
Hide child attributes
Public ID
"mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx"
Mailbox email address (lowercase)
"agent@acme.com"
Optional display name shown in outbound From headers
Storage quota in bytes
Hide child attributes
Outbound routing strategy. all lets the mailbox use any team-configured provider; providers restricts to the listed provider IDs; group routes via a delivery group.
all, providers, group Provider public IDs (only when type=providers)
Delivery group public IDs (only when type=group)
active | suspended | deleted
"active"
ISO 8601 creation timestamp
Initial bearer token for the mailbox. null if credential generation failed — call POST /mailboxes/{id}/keys to retry.
Hide child attributes
Optional warning string when the mailbox was created without initial credentials
Was this page helpful?