Set the SMTP settings
Replaces the settings. An omitted password keeps the stored one. The password is stored encrypted. Authentication needs TLS: STARTTLS (requireTls) or port 465.
/api/v1/alert-smtptse_sessionAPI key · cookierequiredapplication/jsonauthPasswordstringOmit to keep the stored password; empty string clears it
authUsernamestringOmit for no authentication
fromstringrequiredSender address
hellostringName sent in EHLO. Omit for the default
requireTlsbooleanRequire STARTTLS. Omit for true. Port 465 always uses TLS
smarthoststringrequiredhost:port of the SMTP server. Port 465 uses implicit TLS
OK
authUsernamestringrequiredEmpty means no authentication
configuredbooleanrequiredfromstringrequiredSender address
hellostringrequiredName sent in EHLO; empty uses the default
passwordSetbooleanrequiredWhether a password is stored. No endpoint returns the password
passwordUnreadablebooleanrequiredThe stored password cannot be decrypted; email is not sent until it is entered again
requireTlsbooleanrequiredWhether STARTTLS is required
smarthoststringrequiredhost:port of the SMTP server
Error
codestringStable code of the refusal, when the route has codes
detailsstring[]Additional detail, e.g. per-field validation failures
errorstringrequiredHuman-readable error message