Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

import { cmp } from '@wix/consent-policy';

async function getCmpConfig() {
  const response = await cmp.getCmpConfig();
};

getCmpConfig: Wix-hosted

import { createClient } from '@wix/sdk';
import { cmp } from '@wix/consent-policy';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { cmp },
  // Include the auth strategy and host as relevant
});


async function getCmpConfig() {
  const response = await myWixClient.cmp.getCmpConfig();
};

Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).

getCmpConfig: Self-hosted

getCmpConfig

Manage CMP Configurations

Read CMP Configurations

CmpConfig

cmpConfig

import { cmp } from '@wix/consent-policy';

async function updateCmpConfig(cmpConfig) {
  const response = await cmp.updateCmpConfig(cmpConfig);
};

updateCmpConfig: Wix-hosted

import { createClient } from '@wix/sdk';
import { cmp } from '@wix/consent-policy';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { cmp },
  // Include the auth strategy and host as relevant
});


async function updateCmpConfig(cmpConfig) {
  const response = await myWixClient.cmp.updateCmpConfig(cmpConfig);
};

updateCmpConfig: Self-hosted

updateCmpConfig

# About The CMP Config API

CMP (Consent Management Platform) configuration allows site owners to manage privacy settings, specifically the visibility of social components (for example, Google Maps, Facebook Like buttons) on a site until site visitors provide their consent.

Learn more about [Important Information About Editor Elements, Third-Party Apps, Custom Code, and the Cookie Banner](https://support.wix.com/en/article/important-information-about-editor-elements-third-party-apps-custom-code-and-the-cookie-banner).

The CMP Config API enables you to manage privacy settings in compliance with data protection regulations. It includes a toggle that controls the visibility of social components (e.g., Google Maps, Facebook Like buttons) until visitors provide consent.

When enabled, these elements remain blocked, displaying a placeholder instead. This ensures that no cookies or third-party scripts are loaded without user approval.

## Before you begin

- A site must be published before creating a CMP config for it. CMP configs can't be created for draft sites.


## Use cases

- [Manage visitor privacy settings in compliance with data protection regulations](https://dev.wix.com/docs/sdk/backend-modules/consent-policy/cmp/sample-flows)


## Terminology

- **CMP**: Consent management platform. A solution that helps you collect and manage personal information and consents in line with data protection laws and regulations.
- **CMP config**: Settings and parameters defined within a consent management platform.
- **Social element**: A feature or component integrated into a website or application that facilitates interaction and engagement among users or between users and content.


@package_metadata:@wix/consent-policy

To use the Cmp API, install the `@wix/consent-policy` package.

### Install the package
To install the package, follow the instructions below based on your development environment.

#### Wix sites and Blocks apps
When developing with:
 - Editor or Wix IDE: Use the [package manager](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-in-the-editor).
 - Local IDE: Use the [Wix CLI](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-with-the-wix-cli). Run the following command:
  ```console
npm install @wix/consent-policy
```

or

```console
yarn add @wix/consent-policy
```


#### Wix apps and Headless
When developing CLI or self-hosted Wix apps, as well as headless apps or sites, run the following command:
  ```console
npm install @wix/consent-policy
```

or

```console
yarn add @wix/consent-policy
```

#### Import the package

To import the package in your code:

```js
import { cmp } from '@wix/consent-policy'
```
  

# Sample Flows

This article shares some possible use cases you could support, as well as an example flow that could support each use case.

## Manage a site's privacy settings in compliance with data protection regulations

1. Block social elements until consent is given by calling [Update CMP Config](https://dev.wix.com/docs/sdk/backend-modules/consent-policy/cmp/update-cmp-config) and specify `"socialElementsBlocked" = true`.
1. Ensure that the site has a cookie banner. A site using Wix's cookie banner will be accessible by calling [Update Cookie Banner Settings](https://dev.wix.com/docs/sdk/backend-modules/consent-policy/cookie-banner-settings/update-cookie-banner-settings).


auto_sdk_consent-policy_cmp

Date and time the CMP config was created.

_createdDate

Date and time the CMP config was last updated.

_updatedDate

Revision number, which increments by 1 each time the CMP config is updated.
To prevent conflicting changes,
the current revision must be passed when updating the CMP config.

updateCmpConfig( )