Set up or change the cookie and consent widget
put/crm/consent-widget
Set up or change the cookie and consent widget. Visitors are asked again after a change. A person's setting.
Before you call
- Credential
Authorization: Bearer $KEY- Scope
contacts:admin- Sdk
contacts.consentWidget.save- Cli
contacts consent widget save
Request bodyapplication/json, required
- ownerModestringOne of: M0, M1, M2. Default: M1.
- childAudiencebooleanDefault: false.
- categorieslist of stringDefault: [].
- cookieslist of objectDefault: [].
- namestringrequiredAt most 100 characters.
- categorystringrequiredOne of: necessary, preferences, analytics, marketing, notifications.
- purposestringrequiredAt most 200 characters.
- durationstringrequiredAt most 60 characters.
- providerstringAt most 100 characters.
- namestringrequired
- defaultLanguagestringDefault: en. Pattern: ^[a-z]{2}(-[A-Za-z]{2})?$.
- copyobject
- designobjectDefault: {}.
- themestringOne of: auto, light, dark. Default: auto.
- positionstringOne of: bar, card. Default: bar.
- accentstringPattern: ^#[0-9a-f]{6}$.
- radiusintegerAt least 0. At most 32.
- themestring
- googleConsentModebooleanDefault: false.
- expiryDaysintegerDefault: 180. At least 30. At most 395.
- allowedOriginslist of string
- policyUrlstring (uri)At most 300 characters.
Responses
- 200application/jsonSuccess
object - 400application/jsonThe request was malformed
- errorstringrequired
- messagestring
- 401application/jsonNo valid credential
- errorstringrequired
- messagestring
- 403application/jsonThe credential lacks the scope, origin or address
- errorstringrequired
- messagestring
- 429application/jsonOver the key's rate limit; see Retry-After
- errorstringrequired
- messagestring