Skip to main content
POST
Create mailbox

Authorizations

x-api-key
string
header
required

API key (sk-proj-…) from Settings → API Keys. Required for sold API calls outside the Mermail console.

Body

application/json
email
string<email>
required

Mailbox address on an allowed Mermail or custom domain

name
string
required

Display name (also seeds settings.fromName)

Example:

"Acme Support"

workspaceId
string
required

Required for POST /api/v1/mailboxes

Example:

"ws_01abc"

settings
object

Optional mailbox settings merged over defaults

Response

Mailbox created

id
string

Hosted alias primary key (also accepted as mailboxId)

public_id
string<uuid>

Stable public route id; preferred mailboxId for agents and clients

workspace_id
string
email
string<email>
name
string
email_domain_id
string | null
inbound_provider
string
outbound_provider
string
provider_metadata
object
bucket_id
string | null
settings
object
welcome_onboarding_status
string
inbox_unread_by_category
object

Present on list endpoints only