# White label branding for shared reports

> Put your own brand name, logo and accent color on shared dashboards and email reports, and remove Privatus Analytics branding from embeds and status pages.

White label puts your own name, logo and accent color on the reports you
send to clients, and can remove the Privatus Analytics name from them. You set it
once per workspace and it applies to every site in that workspace.

## Who can use it

White label is part of the **Business** and **Enterprise** plans. A
workspace covered by an approved agency
[discount](/docs/billing/plans#discounts) also gets it on Pro.

The settings are in **Workspace settings → White label**. Changing them
needs the `workspace.manage` permission, which the Owner and Admin
[roles](/docs/teams/roles) have.

## Settings

| Setting | What it does | Rules |
|---|---|---|
| **Brand name** | Shown in place of Privatus Analytics | Up to 60 characters |
| **Logo URL** | An image shown next to the brand name | An `https://` link to a PNG, SVG or JPEG, with no spaces, up to 500 characters |
| **Accent color** | The color of the brand name | `#` and six hex digits, such as `#06755b` |
| **Hide Privatus Analytics branding** | Removes the Privatus Analytics name and logo | On or off |

Every setting is optional. Clear a field and save to remove it.

The brand is applied as soon as the workspace has a brand name, a logo or
**Hide Privatus Analytics branding** turned on. An accent color on its own changes
nothing, because it only colors the brand name.

> **Note:** The logo is not uploaded. Shared dashboards and emails load
> it from your URL each time, so keep the file online at that address. It
> is shown about 32 pixels tall on shared dashboards and 28 pixels tall
> in emails.

## Where your brand appears

| Place | Brand name, logo and color | Hide Privatus Analytics branding |
|---|---|---|
| [Shared dashboards](/docs/reports/sharing), including the password prompt | Your logo and brand name at the top of the page, and your brand name in the browser tab title | Removes the Privatus Analytics link at the bottom of the page |
| [Embeds](/docs/reports/sharing#embeds) | Your brand name in the title of the embedded frame. The embed shows no logo | Removes the Privatus Analytics link under the chart |
| [Email reports](/docs/reports/email-reports) | Your logo and brand name at the top of the email in place of the Privatus Analytics logo, and your brand name in the footer line | Removes the Privatus Analytics logo from the top of the email, even with no brand name or logo |
| [Status pages](/docs/features/status-pages) | Not used. Each status page has its own logo and color | Removes the "Powered by Privatus Analytics" link |

> **Tip:** The footer line of a report email says who sent the report. It
> names Privatus Analytics until you set a brand name, even when **Hide
> Privatus Analytics branding** is on.

## What it does not change

- **Addresses.** Shared dashboards and embeds stay on `privatusanalytics.com`, and
  report emails come from the Privatus Analytics sending address. Custom dashboard
  domains and custom email sender domains are not available. A status
  page can have its own
  [custom domain](/docs/features/status-pages#create-one).
- **Chart colors.** The accent color only colors your brand name. Charts
  and buttons keep the standard colors.
- **PDF attachments.** The PDF attached to an email report keeps the
  Privatus Analytics name at the top.
- **Other emails.** Report invitations, alert notifications and export
  emails keep Privatus Analytics branding. Status page emails use the status page's
  own name and color.
- **Wallboards and badges.** The TV wallboard and the visitor counter
  badge are unchanged.
- **The app.** Members who sign in see the normal Privatus Analytics dashboard.

## Plans and downgrades

On a plan without white label, the page shows the form switched off with
a link to the plans. Saving through the API returns a validation error
that names the Business plan.

If a workspace moves to a plan without white label, the settings are kept
but stop applying: shared dashboards, embeds, email reports and status
pages show Privatus Analytics branding again. When the workspace is back on a plan
with white label, the saved brand applies again with nothing to re-enter.

## API

White label is a REST resource at
`/workspaces/<workspace id>/white_label` (`GET` to read, `PATCH` to
change) and the MCP tools `white_label_get` and `white_label_update`. An
update changes only the fields you send (`brand_name`, `brand_logo_url`,
`brand_color`, `hide_branding`), and a blank value removes a field. The
response adds `available` (the plan includes white label) and `active`
(the brand is being applied now). The [API reference](/docs/api) lists
every input.