v1

latestOpenAPI 3.0.32026-07-26172157253.6 KB
Admin

Update SMTP configuration

Create or update SMTP email configuration (admin only). When enabled is true, the fields host, username, senderEmail, and senderName are required by the backend validation. When enabled is false, these fields may be empty. SMTP cannot be disabled on a self-hosted instance while email verification is required, unless a managed email provider is available.

put/api/auth/smtp-config

Request body

enabledboolean required

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

hoststring

Required when enabled is true

port25 | 465 | 587 | 2525 required
usernamestring

Required when enabled is true

passwordstring

SMTP password (optional on update if unchanged)

senderEmailstring email

Required when enabled is true

senderNamestring

Required when enabled is true

minIntervalSecondsinteger

Minimum interval between emails in seconds

Response

SMTP configuration updated

idstring uuid
enabledboolean
hoststring
portinteger
usernamestring
hasPasswordboolean

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

senderEmailstring email
senderNamestring
minIntervalSecondsinteger
createdAtstring date-time
updatedAtstring date-time