Rivier/ Reference/ contacts

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

  • ownerModestring
    One of: M0, M1, M2. Default: M1.
  • childAudienceboolean
    Default: false.
  • categorieslist of string
    Default: [].
  • cookieslist of object
    Default: [].
    • namestringrequired
      At most 100 characters.
    • categorystringrequired
      One of: necessary, preferences, analytics, marketing, notifications.
    • purposestringrequired
      At most 200 characters.
    • durationstringrequired
      At most 60 characters.
    • providerstring
      At most 100 characters.
  • defaultLanguagestring
    Default: en. Pattern: ^[a-z]{2}(-[A-Za-z]{2})?$.
  • copyobject
  • designobject
    Default: {}.
    • themestring
      One of: auto, light, dark. Default: auto.
    • positionstring
      One of: bar, card. Default: bar.
    • accentstring
      Pattern: ^#[0-9a-f]{6}$.
    • radiusinteger
      At least 0. At most 32.
  • googleConsentModeboolean
    Default: false.
  • expiryDaysinteger
    Default: 180. At least 30. At most 395.
  • allowedOriginslist of string
  • policyUrlstring (uri)
    At most 300 characters.

Responses

  • 200application/json
    Success

    object

  • 400application/json
    The request was malformed
    • errorstringrequired
    • messagestring
  • 401application/json
    No valid credential
    • errorstringrequired
    • messagestring
  • 403application/json
    The credential lacks the scope, origin or address
    • errorstringrequired
    • messagestring
  • 429application/json
    Over the key's rate limit; see Retry-After
    • errorstringrequired
    • messagestring

This page as Markdown