Skip to main content
POST
/
mailboxes
Create a mailbox
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.

Authorizations

Authorization
string
header
required

Sendmux API key. Obtain from the dashboard under API Keys. Format: smx_root_...

Headers

Idempotency-Key
string

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.

Maximum string length: 255
Example:

"mailboxes-create-20260424-001"

Body

application/json
email
string
required
Required string length: 5 - 254
display_name
string
Required string length: 1 - 255
quota_bytes
integer
Required range: x >= 1
send_scope
object

Response

Mailbox created. The response carries a Location header pointing at the canonical GET URL for the new mailbox.

ok
enum<boolean>
required
Available options:
true
data
object
required
meta
object
required