Skip to main content
PUT
Update SMTP configuration

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
enabled
boolean
required

When true, host/username/senderEmail/senderName become required

port
enum<integer>
required
Available options:
25,
465,
587,
2525
host
string

Required when enabled is true

username
string

Required when enabled is true

password
string

SMTP password (optional on update if unchanged)

senderEmail
string<email>

Required when enabled is true

senderName
string

Required when enabled is true

minIntervalSeconds
integer
default:60

Minimum interval between emails in seconds

Required range: x >= 0

Response

SMTP configuration updated

id
string<uuid>
enabled
boolean
host
string
port
integer
username
string
hasPassword
boolean

Whether a password is set (actual password is never exposed)

senderEmail
string<email>
senderName
string
minIntervalSeconds
integer
Required range: x >= 0
createdAt
string<date-time>
updatedAt
string<date-time>