Skip to content

Set Landing Page Consent Default

PUT
/landing-page-consent/default

Set the workspace-wide consent gate default. ADMIN ONLY.

A compliance control for every page that does not override it. Takes effect on each page’s NEXT publish - already-published HTML is not rewritten; GET /landing-page-consent/pages shows which pages are stale.

Spends nothing.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

The cookie-consent gate on a published landing page.

object
accent

Hex colour.

string
default: #111827 <= 7 characters
accept_label
string
default: Accept <= 40 characters
banner

False when your own consent manager drives the gate.

boolean
default: true
message
string
default: We use cookies and similar technologies to measure traffic and improve this site. You can accept or reject them. <= 600 characters
mode
string
default: off
Allowed values: off explicit region
policy_label
string
default: Privacy policy <= 60 characters
policy_url
Any of:
string
<= 500 characters
regions

Only used when mode is region.

Array<string>
>= 1 items
reject_label
string
default: Reject <= 40 characters
reopener
boolean
default: true
reopener_label
string
default: Cookie settings <= 40 characters
title
string
default: We use cookies <= 120 characters
version

Bump to re-prompt every visitor.

integer
default: 1 >= 1 <= 1000000

Responses

200

Successful Response

object
data
required

One Studio object, open-shaped. See the module docstring.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string