Update custom SMTP settings
curl --request PATCH \
--url https://api.snowseo.com/v3/settings/brand/smtp \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"teamId": "<string>",
"enabled": true,
"host": "<string>",
"port": 123,
"user": "<string>",
"password": "<string>",
"fromName": "<string>",
"fromEmail": "<string>",
"replyTo": "<string>"
}
'import requests
url = "https://api.snowseo.com/v3/settings/brand/smtp"
payload = {
"teamId": "<string>",
"enabled": True,
"host": "<string>",
"port": 123,
"user": "<string>",
"password": "<string>",
"fromName": "<string>",
"fromEmail": "<string>",
"replyTo": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
teamId: '<string>',
enabled: true,
host: '<string>',
port: 123,
user: '<string>',
password: '<string>',
fromName: '<string>',
fromEmail: '<string>',
replyTo: '<string>'
})
};
fetch('https://api.snowseo.com/v3/settings/brand/smtp', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.snowseo.com/v3/settings/brand/smtp",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'teamId' => '<string>',
'enabled' => true,
'host' => '<string>',
'port' => 123,
'user' => '<string>',
'password' => '<string>',
'fromName' => '<string>',
'fromEmail' => '<string>',
'replyTo' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.snowseo.com/v3/settings/brand/smtp"
payload := strings.NewReader("{\n \"teamId\": \"<string>\",\n \"enabled\": true,\n \"host\": \"<string>\",\n \"port\": 123,\n \"user\": \"<string>\",\n \"password\": \"<string>\",\n \"fromName\": \"<string>\",\n \"fromEmail\": \"<string>\",\n \"replyTo\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.snowseo.com/v3/settings/brand/smtp")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"teamId\": \"<string>\",\n \"enabled\": true,\n \"host\": \"<string>\",\n \"port\": 123,\n \"user\": \"<string>\",\n \"password\": \"<string>\",\n \"fromName\": \"<string>\",\n \"fromEmail\": \"<string>\",\n \"replyTo\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.snowseo.com/v3/settings/brand/smtp")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"teamId\": \"<string>\",\n \"enabled\": true,\n \"host\": \"<string>\",\n \"port\": 123,\n \"user\": \"<string>\",\n \"password\": \"<string>\",\n \"fromName\": \"<string>\",\n \"fromEmail\": \"<string>\",\n \"replyTo\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"enabled": true,
"host": "<string>",
"port": 123,
"encryption": "<string>",
"user": "<string>",
"fromName": "<string>",
"fromEmail": "<string>",
"replyTo": "<string>",
"hasPassword": true
}
}Settings
Update SMTP
Update the custom SMTP credentials.
PATCH
/
v3
/
settings
/
brand
/
smtp
Update custom SMTP settings
curl --request PATCH \
--url https://api.snowseo.com/v3/settings/brand/smtp \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"teamId": "<string>",
"enabled": true,
"host": "<string>",
"port": 123,
"user": "<string>",
"password": "<string>",
"fromName": "<string>",
"fromEmail": "<string>",
"replyTo": "<string>"
}
'import requests
url = "https://api.snowseo.com/v3/settings/brand/smtp"
payload = {
"teamId": "<string>",
"enabled": True,
"host": "<string>",
"port": 123,
"user": "<string>",
"password": "<string>",
"fromName": "<string>",
"fromEmail": "<string>",
"replyTo": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
teamId: '<string>',
enabled: true,
host: '<string>',
port: 123,
user: '<string>',
password: '<string>',
fromName: '<string>',
fromEmail: '<string>',
replyTo: '<string>'
})
};
fetch('https://api.snowseo.com/v3/settings/brand/smtp', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.snowseo.com/v3/settings/brand/smtp",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'teamId' => '<string>',
'enabled' => true,
'host' => '<string>',
'port' => 123,
'user' => '<string>',
'password' => '<string>',
'fromName' => '<string>',
'fromEmail' => '<string>',
'replyTo' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.snowseo.com/v3/settings/brand/smtp"
payload := strings.NewReader("{\n \"teamId\": \"<string>\",\n \"enabled\": true,\n \"host\": \"<string>\",\n \"port\": 123,\n \"user\": \"<string>\",\n \"password\": \"<string>\",\n \"fromName\": \"<string>\",\n \"fromEmail\": \"<string>\",\n \"replyTo\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.snowseo.com/v3/settings/brand/smtp")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"teamId\": \"<string>\",\n \"enabled\": true,\n \"host\": \"<string>\",\n \"port\": 123,\n \"user\": \"<string>\",\n \"password\": \"<string>\",\n \"fromName\": \"<string>\",\n \"fromEmail\": \"<string>\",\n \"replyTo\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.snowseo.com/v3/settings/brand/smtp")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"teamId\": \"<string>\",\n \"enabled\": true,\n \"host\": \"<string>\",\n \"port\": 123,\n \"user\": \"<string>\",\n \"password\": \"<string>\",\n \"fromName\": \"<string>\",\n \"fromEmail\": \"<string>\",\n \"replyTo\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"enabled": true,
"host": "<string>",
"port": 123,
"encryption": "<string>",
"user": "<string>",
"fromName": "<string>",
"fromEmail": "<string>",
"replyTo": "<string>",
"hasPassword": true
}
}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.
| Field | Description |
|---|---|
teamId | Brand (team) to update. |
enabled | Turn custom SMTP on/off. |
host | SMTP host, or null. |
port | Integer between 1 and 65535, or null. |
encryption | ssl, tls, or none. |
user | SMTP username, or null. |
password | Plaintext password to store (encrypted at rest). Omit, send null, or send "" to keep the existing password. |
fromName | Display name, or null. |
fromEmail | From address (must be a valid email), or null. |
replyTo | Reply-to address (must be a valid email), or null. |
Sending
password as null or an empty string does not clear the stored password - it keeps the existing one. Invalid fromEmail/replyTo values, an out-of-range port, or an unknown encryption are rejected with 400.Authorizations
bearerAuthapiKey
Your SnowSEO API key (sk_...).
Body
application/json
Was this page helpful?

