Skip to main content
POST

Authorizations

​
Authorization
string
header
required

API key for account management endpoints. Use your api_ prefixed token.

Body

application/json
​
domain
string
required

Primary domain name to add (e.g., example.com, not mail.example.com)

Pattern: ^(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?.)+[a-zA-Z]{2,}$
Example:

"example.com"

​
delivery_type
enum<string>
required

How emails should be delivered for this domain. For "forward", inbound mail is forwarded to per-recipient destinations defined via POST /inbound/domains/{uuid}/forward-rules.

Available options:
smtp,
webhook,
forward
​
smtp_servers
(string | object)[]

Only for delivery_type=smtp (required). Rejected with 400 if sent with webhook or forward.

Server URL

Example:

"mail.example.com:25"

​
webhook_url
string<uri>

Only for delivery_type=webhook (required). Webhook URL to receive emails. Rejected with 400 if sent with smtp or forward.

Example:

"https://example.com/webhook/inbound"

​
webhook_method
enum<string>
default:POST

Only for delivery_type=webhook. HTTP method for webhook. Rejected with 400 if sent with smtp or forward.

Available options:
POST,
PUT
​
webhook_headers
object

Only for delivery_type=webhook. Custom headers to send with webhook requests. Rejected with 400 if sent with smtp or forward.

​
webhook_timeout
integer
default:30000

Only for delivery_type=webhook. Webhook timeout in milliseconds. Rejected with 400 if sent with smtp or forward.

​
webhook_retry_count
integer
default:3

Only for delivery_type=webhook. Number of retry attempts for failed webhook calls. Rejected with 400 if sent with smtp or forward.

​
webhook_auth_header
string

Only for delivery_type=webhook. Authorization header value for webhook. Rejected with 400 if sent with smtp or forward.

Response

Domain added successfully

​
success
boolean
Example:

true

​
result
object