---
title: "Call page.set_platform_properties"
method: POST
path: "/api/v1/tools/page.set_platform_properties"
tags: ["page"]
---

# Call page.set_platform_properties

`POST /api/v1/tools/page.set_platform_properties`

## Request

- Base URL: `https://app.goosybear.ai`
- URL: `https://app.goosybear.ai/api/v1/tools/page.set_platform_properties`
- Auth: HTTP bearer

Turn a site's cookie consent banner, or all of its ad pixels together (one named pixel is `page.set_tracking`), on or off, or choose how the banner asks — it is the member's call either way — 'add a cookie banner to my site', 'turn our ad pixels on for this site', 'take the consent banner off'. The platform adds the banner and the pixels to the site itself, so they need no code change and no file edit, and the three settings work the same on every site. How the banner asks is consent_mode: opt_in, the default, loads nothing until a visitor accepts; opt_out starts analytics and the pixels when a visitor arrives and the banner offers an opt-out. opt_out is a supported choice: when the member asks for it, set it rather than refuse, and when they ask to switch between asking first and offering an opt-out, set consent_mode, not consent_banner. Call it on the site the member names. Pixels need the banner on; turning the banner off turns them off too. It changes settings and reads none: to say whether the banner is on now, do not call it; tell the member it shows in the site's settings, Tracking tab. Calling it raises the approval card, which is the member's confirmation. If live comes back applied, say the live site has the change within a minute; not_live, say it is saved and carried by the next publish; failed, say it is saved but the live site still has the old setting and to try again — never say it is live. Not for turning one connected pixel off on a single page — that is `page.set_tracking`. Over the API it answers in two calls: without confirmation_id it proposes — says what would happen, returns a confirmation_id and changes, spends and sends nothing; the same arguments again with that confirmation_id, on a member's own API key, do it.

Every result names the workspace it ran in. Say which workspace the answer is about. When the account has more than one workspace and none is selected, this tool refuses with `workspace_ambiguous` and lists the choices — offer them, never pick one.

## Headers

- `x-request-id` string

## Request body

- object
  - `site_id` string, uuid: The site to act on, as a site UUID from `page.list`. On a site's own page, leave it out where this schema makes it optional: the call acts on the site open there, unless the member names another site. On any other screen (Analytics, the desk, Connections) no site is open, so pass it: call `page.list` with `name` set to the site the member named and pass the site_id it returns. When they named no site, call `page.list` without a name: pass the one site's id when the brand has one, and ask which site they mean when it has several. Never pass an id you composed, or one that names a board, thread or other object.
  - `consent_banner` boolean: True shows the platform's cookie consent banner on the site; false removes it, and the ad pixels with it. Omit to leave it as it is.
  - `ad_pixels` boolean: True loads the workspace's connected ad pixels after a visitor accepts the banner; false stops them. Needs the banner on. Omit to leave it as it is.
  - `consent_mode` 'opt_in' | 'opt_out': How the banner asks. opt_in: nothing loads until a visitor accepts. opt_out: analytics and the ad pixels load when a visitor arrives, and the banner lets them opt out; a browser sending Global Privacy Control is still opted out. Omit to leave it as it is.
  - `confirmation_id` string, uuid: Omit to propose: the first call says what would happen, returns a confirmation_id and changes nothing. To go ahead, send the same arguments again with that confirmation_id, on a member's own API key; a service account's key can propose but never confirm.
  - `workspace` string: Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.

## Response `200`

The call was admitted and dispatched. `ok` says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.

- union
  - object: The tool ran and answered.
    - `ok` true, required
    - `state` 'confirmation_required'
    - `confirmation_id` string, uuid
    - `expires_in_seconds` integer
    - `request_summary` string: What will happen, in one sentence, for a person to approve before confirming.
    - `site_id` string, uuid
    - `consent_banner` boolean
    - `ad_pixels` boolean
    - `consent_mode` 'opt_in' | 'opt_out'
    - `live` 'applied' | 'not_live' | 'failed'
    - `workspace` string, required: The slug of the workspace this call ran in.
    - `working_in` object, required: Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result.
      - `label` string, required: The chip words — e.g. "working in: Acme Main".
      - `note` string, required: Why this workspace — e.g. "your default", "this call only".
      - `workspace` string, required: The resolved workspace's slug.
      - `source` 'call-override' | 'key-pin' | 'stored-default' | 'sole-reachable', required: Which rung of the R7 precedence resolved the workspace.
  - ToolRefusal: A call that was admitted and dispatched, and did not succeed.
    - `ok` false, required
    - `code` string, required: The typed reason — e.g. `workspace_ambiguous`, `invalid_arguments`, or the tool's own failure code.
    - `message` string, required: A sentence a person can act on.
    - `workspaces` string[]: On a workspace refusal: the slugs this key may pass as `workspace`.
    - `issues` object[]: On `invalid_arguments`: which fields failed, and why.
      - `path` string, required
      - `message` string, required
    - `path` string: On an authoring refusal: where in your call's input it points, e.g. `steps.<key>.params.<field>`.
    - `fix` string: On an authoring refusal: the change to your call that would pass.
    - `instruction` string: On an authoring refusal: what to do next with it.

## Other responses

- `400`: The request could not be used: the body is present but not a JSON object (`tenant_api.malformed_body`); it is a top-level array carrying more messages than this endpoint accepts (`tenant_mcp.batch_too_large`); or the `Idempotency-Key` header is malformed (`tenant_api.idempotency_key_invalid`), disagrees with the body's `idempotency_key` (`tenant_api.idempotency_key_conflict`), or was sent to an action that cannot replay a retry (`tenant_api.idempotency_unsupported`). Nothing ran.
- `401`: No bearer credential, or one that did not resolve. Deliberately ONE undifferentiated answer for absent / unknown / revoked / expired, so the endpoint is never an oracle over the key space.
- `403`: The credential is good but the surface is not open to it — the platform or account API switch is off, or the holder lacks the `api.access` capability. The `code` says which.
- `404`: No such tool. The body names no tool and is identical for every unrecognised name.
- `429`: Over this key's per-minute cap. Carries `Retry-After` and `error.retry_after_seconds`.

## Changes

- **2026-10-20** `bd8f793b36b5`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/goosybear/apis/goosy-bear-api/changes/api/v1/tools/page.set_platform_properties/post.md)

---

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