---
title: "Set a site's Search Console brand terms"
method: PATCH
path: "/v1/sites/{site}/search/brand"
tags: ["gsc"]
---

# Set a site's Search Console brand terms

`PATCH /v1/sites/{site}/search/brand`

## Request

- Base URL: `https://frontshelf.io/api`
- URL: `https://frontshelf.io/api/v1/sites/{site}/search/brand`
- Auth: HTTP bearer

Set a site's brand terms, the words that make a Search Console query branded (`filter.brand`: branded or non_branded on gsc_series_get, gsc_table_get and the export). Replaces the whole list; an empty list clears the brand. Set only what your human asked for. A change is a new version of the brand, so every gsc_table_get cursor read under the old terms expires. Paid (brand): on a site that is not paid for, BILLING_REQUIRED.

## Path parameters

- `site` string, required: Site ID (site_…), origin (https://example.com), or bare domain, resolved server-side; the response carries the canonical ID.

## Request body

- object
  - `terms` string[], required: The brand terms, at most 100: a query containing any of them is branded. Trimmed and de-duplicated; an empty list clears the brand.
  - `dry_run` boolean: true: check the call and say what it would do, without doing it.
  - `confirm` boolean: true: go ahead with a change that asks for confirmation.

## Response `200`

Set a site's Search Console brand terms

- object
  - `summary` string, required: The answer in one or two sentences, with the numbers it rests on.
  - `warnings` string[], required: What limits this answer (a cap, a read that was cut short). Empty when nothing does.
  - `next_actions` object[], required: What to call next, best first. Follow them.
    - `capability` string, required: What to call next: a capability.
    - `arguments` object, required: Its arguments, complete; pass them as they are.
    - `instruction` string, required: What to do, written to you.
  - `site_id` string, required: The site's canonical id.
  - `terms` string[], required: The terms as you sent them.

## Other responses

- `400`: VALIDATION_FAILED
- `401`: UNAUTHENTICATED
- `402`: BILLING_REQUIRED
- `403`: ORGANIZATION_FROZEN, SCOPE_DENIED
- `404`: SITE_NOT_FOUND
- `409`: AMBIGUOUS_SITE, AGENT_STOPPED
- `503`: PLATFORM_READ_ONLY, DEPENDENCY_UNAVAILABLE

---

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