Update cookie consent settings

Updates the consent banner configuration.

Required permissions

cookie_consent.update

PUT/cookie-consent/settings

Base URLhttps://api.lynkow.com/v1

Request bodyrequired

textsobject
UI text content
- savestring
- acceptAllstring
- analyticsstring
- customizestring
- marketingstring
- necessarystring
- rejectAllstring
- descriptionstring
- preferencesstring
- analyticsDescstring
- marketingDescstring
- necessaryDescstring
- privacyPolicystring
- preferencesDescstring
themeenum
One of: light, dark, auto
One of: lightdarkauto
layoutenum
One of: banner, modal, floating
One of: bannermodalfloating
enabledboolean
Boolean
fontSizenumber
Between 11 and 17
maxWidthnumber
Between 280 and 1200
positionenum
One of: bottom, top, center, bottom-left, bottom-right
One of: bottomtopcenterbottom-leftbottom-right
categoriesarray<object>
Array of objects
- idstringrequired
- namestringrequired
- enabledbooleanrequired
- requiredbooleanrequired
- descriptionstringrequired
consentModeenum
One of: opt-in, opt-out, notice-only
One of: opt-inopt-outnotice-only
orientationenum
One of: auto, column
One of: autocolumn
themeStylesobject
Custom theme style overrides
- darkobject
  - bgColorstring
  - textColorstring
  - primaryColorstring
- lightobject
  - bgColorstring
  - textColorstring
  - primaryColorstring
borderRadiusnumber
Between 0 and 50
primaryColorstring
Primary brand color (hex)
cookiePolicyUrlunion
Cookie policy page URL
privacyPolicyUrlunion
Privacy policy page URL
showOnFirstVisitboolean
Boolean
thirdPartyScriptsarray<object>
Array of objects
- idstringrequired
- namestringrequired
- scriptstringrequired
- enabledbooleanrequired
- categoryenumrequired
  One of: necessaryanalyticsmarketingpreferences
showCustomizeButtonboolean
Boolean

curl --request PUT \
  --url 'https://api.lynkow.com/v1/cookie-consent/settings' \
  --header 'Authorization: Bearer $API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "data": {
    "enabled": true,
    "position": "bottom",
    "categories": [
      {
        "key": "necessary",
        "label": "Necessary",
        "required": true
      },
      {
        "key": "analytics",
        "label": "Analytics",
        "required": false
      }
    ]
  }
}

Feedback

Request bodyrequired

Was this page helpful?