curl --request POST \
--url https://app.sendmux.ai/api/v1/mailboxes/{public_id}/keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"app_name": "<string>"
}
'{
"ok": true,
"data": {
"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>"
}
},
"meta": {
"request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
}
}Mints an additional bearer token plus IMAP/SMTP app password for an existing mailbox. The plaintext key and password are shown exactly once — store them immediately.
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/{public_id}/keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"app_name": "<string>"
}
'{
"ok": true,
"data": {
"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>"
}
},
"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"mailbox-keys-create-20260424-001"
Mailbox public ID
1 - 255Mailbox API key created. The response carries a Location header pointing at the canonical URL for the new key.
true Hide child attributes
Initial bearer token for the mailbox. null if credential generation failed — call POST /mailboxes/{id}/keys to retry.
Hide child attributes
Was this page helpful?