Skip to main content
POST
Add email domain

Authorizations

x-api-key
string
header
required

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

Path Parameters

workspaceId
string
required

Workspace id

Body

application/json
domain
string
required

Custom subdomain used for agent mailboxes

Example:

"mail.acme.com"

Response

Domain created (DNS verification pending)

id
string
workspace_id
string
domain
string
provider
string
Example:

"resend"

status
string

Provider/local status such as pending, verified, deleting, deleted

provider_domain_id
string | null
region
string | null
dns_records
object[] | null
last_error
string | null
verified_at
string<date-time> | null
created_at
string<date-time>
updated_at
string<date-time>