Skip to main content
PATCH

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
currentUsername
string
required

Current SMTP username to update

Example:

"existing-user"

​
newUsername
string

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

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

"new-user-name"

​
password
string

New password

Required string length: 8 - 72
Example:

"newSecurePassword123"

​
allowAnyDomain
boolean

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

Example:

false

​
allowAllDomains
boolean

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

Example:

false

​
approvedDomains
string[]

List of approved domains for sending

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

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. Pass null or empty string to clear it.

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. Replaces the existing set; trimmed and de-duplicated (case-insensitive) server-side. Pass [] to clear all tags.

Maximum array length: 20
Maximum string length: 32
Pattern: ^[\w- ]+$
Example:
​
status
enum<string>

Status of the SMTP user

Available options:
inactive,
active,
suspended,
quota-locked,
quota-unlocked

Response

SMTP user updated successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Smarthost updated successfully"