updateCookieBannerSettings( )

Updates the cookie banner settings.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Cookie Consent Banner
Learn more about app permissions.
Method Declaration
Copy
function updateCookieBannerSettings(
  options: UpdateCookieBannerSettingsOptions,
): Promise<UpdateCookieBannerSettingsResponse>;
Method Parameters
optionsUpdateCookieBannerSettingsOptions

Field options.

Returns
Return Type:Promise<UpdateCookieBannerSettingsResponse>
JavaScript
import { cookieBannerSettings } from "@wix/consent-policy";

async function updateCookieBannerSettings(options) {
  const response =
    await cookieBannerSettings.updateCookieBannerSettings(options);
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?