Skip to main content
POST
Call page.set_platform_properties

Authorizations

Authorization
string
header
required

An API key minted at Settings › API & MCP. Send it as Authorization: Bearer <key>. A key carries its holder's own permissions, resolved on every call — revoking a membership closes the key's reach immediately. Keep it in an environment variable (GOOSY_API_KEY), never in a committed file.

Headers

x-request-id
string

Your own id for this request, echoed back and recorded on the audit trail. 1–128 characters from A–Z a–z 0–9 . _ : -, starting with a letter or digit; anything else is replaced by a generated id.

Maximum string length: 128

Body

application/json
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.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

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.

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.

Available options:
opt_in,
opt_out
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.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
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.

Minimum string length: 1

Response

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.

The tool ran and answered.

ok
boolean
required
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.

state
string
Allowed value: "confirmation_required"
confirmation_id
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
expires_in_seconds
integer
request_summary
string

What will happen, in one sentence, for a person to approve before confirming.

site_id
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
ad_pixels
boolean
Available options:
opt_in,
opt_out
live
enum<string>
Available options:
applied,
not_live,
failed