Update white-label report branding
curl --request PATCH \
--url https://api.snowseo.com/v3/settings/brand/white-label \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"teamId": "<string>",
"enabled": true,
"logoUrl": "<string>",
"name": "<string>",
"website": "<string>",
"showLogo": true,
"showName": true,
"showWebsite": true,
"accentColor": "<string>"
}
'import requests
url = "https://api.snowseo.com/v3/settings/brand/white-label"
payload = {
"teamId": "<string>",
"enabled": True,
"logoUrl": "<string>",
"name": "<string>",
"website": "<string>",
"showLogo": True,
"showName": True,
"showWebsite": True,
"accentColor": "<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,
logoUrl: '<string>',
name: '<string>',
website: '<string>',
showLogo: true,
showName: true,
showWebsite: true,
accentColor: '<string>'
})
};
fetch('https://api.snowseo.com/v3/settings/brand/white-label', 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/white-label",
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,
'logoUrl' => '<string>',
'name' => '<string>',
'website' => '<string>',
'showLogo' => true,
'showName' => true,
'showWebsite' => true,
'accentColor' => '<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/white-label"
payload := strings.NewReader("{\n \"teamId\": \"<string>\",\n \"enabled\": true,\n \"logoUrl\": \"<string>\",\n \"name\": \"<string>\",\n \"website\": \"<string>\",\n \"showLogo\": true,\n \"showName\": true,\n \"showWebsite\": true,\n \"accentColor\": \"<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/white-label")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"teamId\": \"<string>\",\n \"enabled\": true,\n \"logoUrl\": \"<string>\",\n \"name\": \"<string>\",\n \"website\": \"<string>\",\n \"showLogo\": true,\n \"showName\": true,\n \"showWebsite\": true,\n \"accentColor\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.snowseo.com/v3/settings/brand/white-label")
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 \"logoUrl\": \"<string>\",\n \"name\": \"<string>\",\n \"website\": \"<string>\",\n \"showLogo\": true,\n \"showName\": true,\n \"showWebsite\": true,\n \"accentColor\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodySettings
White Label
Set the white-label branding applied to client reports and audit PDFs.
PATCH
/
v3
/
settings
/
brand
/
white-label
Update white-label report branding
curl --request PATCH \
--url https://api.snowseo.com/v3/settings/brand/white-label \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"teamId": "<string>",
"enabled": true,
"logoUrl": "<string>",
"name": "<string>",
"website": "<string>",
"showLogo": true,
"showName": true,
"showWebsite": true,
"accentColor": "<string>"
}
'import requests
url = "https://api.snowseo.com/v3/settings/brand/white-label"
payload = {
"teamId": "<string>",
"enabled": True,
"logoUrl": "<string>",
"name": "<string>",
"website": "<string>",
"showLogo": True,
"showName": True,
"showWebsite": True,
"accentColor": "<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,
logoUrl: '<string>',
name: '<string>',
website: '<string>',
showLogo: true,
showName: true,
showWebsite: true,
accentColor: '<string>'
})
};
fetch('https://api.snowseo.com/v3/settings/brand/white-label', 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/white-label",
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,
'logoUrl' => '<string>',
'name' => '<string>',
'website' => '<string>',
'showLogo' => true,
'showName' => true,
'showWebsite' => true,
'accentColor' => '<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/white-label"
payload := strings.NewReader("{\n \"teamId\": \"<string>\",\n \"enabled\": true,\n \"logoUrl\": \"<string>\",\n \"name\": \"<string>\",\n \"website\": \"<string>\",\n \"showLogo\": true,\n \"showName\": true,\n \"showWebsite\": true,\n \"accentColor\": \"<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/white-label")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"teamId\": \"<string>\",\n \"enabled\": true,\n \"logoUrl\": \"<string>\",\n \"name\": \"<string>\",\n \"website\": \"<string>\",\n \"showLogo\": true,\n \"showName\": true,\n \"showWebsite\": true,\n \"accentColor\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.snowseo.com/v3/settings/brand/white-label")
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 \"logoUrl\": \"<string>\",\n \"name\": \"<string>\",\n \"website\": \"<string>\",\n \"showLogo\": true,\n \"showName\": true,\n \"showWebsite\": true,\n \"accentColor\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyConfigure the white-label branding — logo, name, website, and accent color — that replaces SnowSEO’s on client-facing reports. Only the fields you send are changed; the rest keep their stored values. Returns
{ "success": true, "data": { ... } }, where data is the full, merged white-label object.
Requires managed (admin/owner) access to the brand. White-label branding also requires the Scale plan (or AppSumo tier 3+); otherwise the request returns
403.Fields
| Field | Description |
|---|---|
teamId | Brand (team) to update. |
enabled | Master switch. When true, reports use your branding instead of SnowSEO’s. |
logoUrl | Logo URL, or null to clear. Trimmed; empty string becomes null. |
name | Company/brand name shown on reports, or null. |
website | Website URL shown on reports, or null. |
showLogo | Show the logo on branded surfaces. |
showName | Show the name on branded surfaces. |
showWebsite | Show the website on branded surfaces. |
accentColor | Brand accent as a 6-digit hex (e.g. #7C3AED), or null to fall back to the team’s brand color. |
accentColor must match #RRGGBB (6 hex digits) or the request is rejected with 400. Booleans must be real booleans and the string fields must be a string or null.Defaults for a brand that has never been configured:
enabled: false, showLogo, showName, and showWebsite all true, and no logo/name/website/accent set.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
200
Default Response
Was this page helpful?
⌘I

