Get custom SMTP settings
Settings
Custom SMTP
Read, update, and test the custom SMTP mailbox used to deliver client reports.
GET
Get custom SMTP settings
Manage the custom SMTP mailbox that SnowSEO uses to send client reports and audit emails, so they arrive from your own domain instead of SnowSEO’s.
The
Requires managed (admin/owner) access to the brand. Custom SMTP also requires the Scale plan (or AppSumo tier 3+); otherwise every route returns
403.GET response is masked — the stored password is never returned. Instead a hasPassword boolean tells you whether a password is on file.
GET response fields
The response is{ "success": true, "data": { ... } }, where data contains:
Update SMTP
PATCH /v3/settings/brand/smtp
Update the SMTP credentials. Only the fields you send change; the rest keep their stored values. Returns { "success": true, "data": { ... } } with the same masked data shape as GET.
Test SMTP
POST /v3/settings/brand/smtp/test
Verify the saved SMTP configuration by opening a connection, and optionally send a test message.
On success the response is
{ "success": true }. On failure it returns { "success": false, "error": "…" } with a friendly hint — for example, an SSL/TLS mismatch suggests using port 465 for SSL or port 587 (STARTTLS) for TLS, and an auth error points at the username/password.
