Skip to main content
POST
Create a mailbox API key

Authorizations

Authorization
string
header
required

Sendmux API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.

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:

"mailbox-keys-create-20260424-001"

Path Parameters

public_id
string
required

Mailbox public ID

Body

application/json
app_name
string
required

Human-friendly label for the new API key.

Required string length: 1 - 255

Response

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

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