Skip to main content
POST
Create new SMTP user

Authorizations

Authorization
string
header
required

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

Body

application/json
username
string
required

SMTP username (will be sanitized to lowercase alphanumeric with hyphens)

Required string length: 1 - 64
Pattern: ^[a-z0-9-]+$
Example:

"smtp-user1"

password
string

Optional password (will be generated if not provided)

Required string length: 8 - 72
Example:

"mySecurePassword123"

allowAnyDomain
boolean
default:false

Whether to allow sending from any domain (requires paid subscription). Cannot be enabled together with allowAllDomains.

allowAllDomains
boolean
default:false

Whether to allow sending from all verified domains. Cannot be enabled together with allowAnyDomain.

approvedDomains
string[]

List of approved domains for sending

Maximum array length: 50
Pattern: ^(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?.)+[a-zA-Z]{2,}$
Example:
quota
number
default:0

Email sending quota

Required range: x >= 0
Example:

1000

ipRestrictions
string[]

List of allowed IP addresses

Maximum array length: 50
Pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$
Example:
ip_auth
string | null

IP-based SMTP authentication address (requires paid subscription). A single IPv4 (no CIDR) bound to this account; must be globally unique across all accounts. Username and password are still required. Omit or set null/empty to leave unset.

Pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$
Example:

"1.1.1.1"

tags
string[]

Free-form tags used to organise/filter SMTP users. Trimmed and de-duplicated (case-insensitive) server-side.

Maximum array length: 20
Maximum string length: 32
Pattern: ^[\w- ]+$
Example:

Response

SMTP user created successfully. If no password was provided in the request, a generated password will be included in the response.

success
boolean
required
Example:

true

message
string
required
Example:

"SMTP user created successfully"

password
string

Only present if no password was provided in the request

Example:

"generated-secure-password"