> ## Documentation Index
> Fetch the complete documentation index at: https://snowseo.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# White Label

> Set the white-label branding applied to client reports and audit PDFs.

Configure 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.

<Note>
  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`.
</Note>

### 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. |

<Warning>
  `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`.
</Warning>

<Tip>
  Defaults for a brand that has never been configured: `enabled: false`, `showLogo`, `showName`, and `showWebsite` all `true`, and no logo/name/website/accent set.
</Tip>


## OpenAPI

````yaml PATCH /v3/settings/brand/white-label
openapi: 3.0.0
info:
  title: SnowSEO API
  description: API documentation for SnowSEO
  version: 1.0.0
servers:
  - url: https://api.snowseo.com
    description: Production server
security: []
tags:
  - name: Keywords
    description: Keyword research and suggestion end-points
  - name: Onboarding
    description: Brand onboarding and strategy end-points
  - name: Brands
    description: Brand management end-points
  - name: Organizations
    description: Organization and member end-points
  - name: Integrations
    description: Google Search Console and other integrations
  - name: Utilities
    description: Common utility end-points like screenshots and uploads
externalDocs:
  url: https://snowseo.com/docs
  description: Find more info here
paths:
  /v3/settings/brand/white-label:
    patch:
      tags:
        - Settings
      summary: Update white-label report branding
      description: >-
        Update the org's white-label branding for client reports (logo, name,
        website, accent color, visibility toggles). All fields optional.
        Requires white-label access (Scale plan / AppSumo tier 3+).
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              properties:
                teamId:
                  type: string
                enabled:
                  type: boolean
                logoUrl:
                  type: string
                  nullable: true
                name:
                  type: string
                  nullable: true
                website:
                  type: string
                  nullable: true
                showLogo:
                  type: boolean
                showName:
                  type: boolean
                showWebsite:
                  type: boolean
                accentColor:
                  type: string
                  nullable: true
      responses:
        '200':
          description: Default Response

````