---
title: "Change the account's agency branding for white-label PDFs"
method: PATCH
path: "/account/report-branding"
tags: ["Account"]
---

# Change the account's agency branding for white-label PDFs

`PATCH /account/report-branding`

## Request

- Base URL: `https://adslighthouse.com/api/v1`
- URL: `https://adslighthouse.com/api/v1/account/report-branding`
- Auth: HTTP bearer

Sets the account's report branding, like Settings > Report branding. Send agency_name (required the first time, up to 80 characters), accent_color (#rrggbb), contact_line (up to 120) and footer_text (up to 160); an omitted field keeps its value and null clears contact_line or footer_text. Text is stored as one plain line. remove_logo true deletes the stored logo; uploading a logo is only possible in the app. Only the account owner or an admin may change it, and the plan must include white-label reports (Scale and above). Every save raises the version, so reports and evidence packs requested afterwards are new files; files already requested keep their branding. Requires the write scope.

## Request body

- object
  - `agency_name` string
  - `accent_color` string
  - `contact_line` string, nullable
  - `footer_text` string, nullable
  - `remove_logo` boolean

## Response `200`

Change the account's agency branding for white-label PDFs

- object
  - `included` boolean, required: Whether the account's plan includes white-label reports now.
  - `unlock_plan` string, required: The first plan that includes white-label reports.
  - `can_edit` boolean, required: Whether the person the credential acts for may change it: owner or admin.
  - `branding` object, nullable, required: Null until someone sets up the branding; reports then use ours only.
    - `agency_name` string, required
    - `accent_color` string, required: The accent color as #rrggbb, used for the cover band.
    - `accent_text_color` string, required: The color used for text on white: accent_color, or a darker shade of it when accent_color is below the 4.5:1 contrast ratio.
    - `contact_line` string, nullable, required
    - `footer_text` string, nullable, required
    - `logo` object, nullable, required: The stored logo's size in pixels, or null. Upload or replace it in the app.
      - `width` integer, required
      - `height` integer, required
    - `version` integer, required: Raised by every save. Reports and packs requested after a change are new files.
    - `updated_at` string, required
  - `request_id` string

## Other responses

- `400`: Invalid parameters, cursor or body.
- `401`: Missing, invalid, expired or revoked credential.
- `403`: The credential lacks the write scope, the plan does not include the API, or the allowance is used up.
- `404`: Unknown project, keyword or run in this account.
- `409`: The idempotency key was already used for a different request.
- `429`: Rate limit reached. Retry after the Retry-After seconds.
- `503`: The requested service or file is temporarily unavailable.

---

[API](https://skmtc.dev/adslighthouse/apis/ads-lighthouse-api.md) · [All operations](https://skmtc.dev/adslighthouse/apis/ads-lighthouse-api/llms.txt) · [OpenAPI document](https://skmtc.dev/adslighthouse/apis/ads-lighthouse-api/revisions/e1a4a40b11a9?raw)