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 body
required

  • texts
    object

    UI text content

    • save
      string
    • acceptAll
      string
    • analytics
      string
    • customize
      string
    • marketing
      string
    • necessary
      string
    • rejectAll
      string
    • description
      string
    • preferences
      string
    • analyticsDesc
      string
    • marketingDesc
      string
    • necessaryDesc
      string
    • privacyPolicy
      string
    • preferencesDesc
      string
  • theme
    enum

    One of: light, dark, auto

    One of: lightdarkauto

  • layout
    enum

    One of: banner, modal, floating

    One of: bannermodalfloating

  • enabled
    boolean

    Boolean

  • fontSize
    number

    Between 11 and 17

  • maxWidth
    number

    Between 280 and 1200

  • position
    enum

    One of: bottom, top, center, bottom-left, bottom-right

    One of: bottomtopcenterbottom-leftbottom-right

  • categories
    array<object>

    Array of objects

    • id
      string
      required
    • name
      string
      required
    • enabled
      boolean
      required
    • required
      boolean
      required
    • description
      string
      required
  • consentMode
    enum

    One of: opt-in, opt-out, notice-only

    One of: opt-inopt-outnotice-only

  • orientation
    enum

    One of: auto, column

    One of: autocolumn

  • themeStyles
    object

    Custom theme style overrides

    • dark
      object
      • bgColor
        string
      • textColor
        string
      • primaryColor
        string
    • light
      object
      • bgColor
        string
      • textColor
        string
      • primaryColor
        string
  • borderRadius
    number

    Between 0 and 50

  • primaryColor
    string

    Primary brand color (hex)

  • cookiePolicyUrl
    union

    Cookie policy page URL

  • privacyPolicyUrl
    union

    Privacy policy page URL

  • showOnFirstVisit
    boolean

    Boolean

  • thirdPartyScripts
    array<object>

    Array of objects

    • id
      string
      required
    • name
      string
      required
    • script
      string
      required
    • enabled
      boolean
      required
    • category
      enum
      required

      One of: necessaryanalyticsmarketingpreferences

  • showCustomizeButton
    boolean

    Boolean

Feedback

Was this page helpful?