# About the Consent Configs API

A consent config is a configuration entity that defines user consent settings for a site, used specifically to override consent categories for app embeds (meaning, embedded script extensions within Wix apps).

> **Important:** Within this API, app embeds are sometimes referred to as tags, which are mappings of an app embed and the app that owns the embed.

You can use the Consent Configs API to override the consent categories for installed app embeds, referred to as `TAG_OVERRIDE`.

## Consent categories and loading behavior

Embeds are classified into categories that determine their loading behavior:

1. **ESSENTIAL**
   - Critical functionality required for site operation.
   - Always loaded, regardless of user preferences.
   - Example: Core functionality scripts, required third-party integrations.

2. **FUNCTIONAL**
   - Enhanced functionality that's not critical.
   - Can be conditionally loaded based on user preferences.
   - Example: Chat widgets, social media integrations.

3. **ANALYTICS**
   - Tracking and measurement code.
   - Subject to user privacy preferences.
   - Example: Google Analytics, conversion tracking.

4. **ADVERTISING**
   - Marketing and advertising related code.
   - Subject to user consent and preferences.
   - Example: Ad network scripts, retargeting pixels.

5. **DATA_TO_THIRD_PARTY**
   - Code that shares data with external services.
   - Requires careful handling for privacy compliance.
   - Example: CRM integrations, data synchronization scripts.

## Before you begin

If you configure a consent config to override an app embed to a category that is not essential, you should send the Wix users to update Wix's consent banner, either manually in the [Wix Privacy Center](fallback::https://www.wix.com/manage/privacy) or by installing the [Usercentrics](fallback::https://www.wix.com/app-market/web-solution/cookiebot-for-wix) app.

## Terminology

- **Allowlist**: A security measure that restricts access to only those items or entities that are explicitly authorized. Also known as whitelist.
- **App embed:** An embedded script extension within a Wix app. 
- **Consent categories**: Consent categories are used to organize different types of data and enable visitors to manage their consent, and enable sites to comply with privacy regulations like GDPR, which require transparency about data collection and user consent for non-essential tracking. Categories include:
  - **Essential:** Providing core functionality such as security, verification of identity and network management. These cookies can’t be disabled.
  - **Functional:** Collecting data to remember choices users make to improve and give a more personalised experience.
  - **Analytics:** Tracking visitor interactions with a site, to discover errors and provide better overall analytics.
  - **Marketing:** Tracking advertising effectiveness to provide a more relevant service and deliver better ads to suit visitors' interests.
  - **Data to third party:** Collecting data to pass on to a third party.
- **Consent config**: A configuration entity that defines user consent settings for app embeds and cookies on a site.
- **Config type**: There is currently only one config type:
  - **Tag override:**  This config type changes a tag's category.
- **Tag**: The mapping of an app and its embedded script extension.

@sdk_package_setup

# Sample Flows

This article shares some possible use cases your app could support,
as well as a sample flow that could support each use case.
This can be a helpful jumping off point as you plan your app's implementation.

## Manage an app embed's consent category

1. Call [List Apps And Storage](fallback::https://dev.wix.com/docs/api-reference/business-management/cookie-consent-policy/consent-configs/list-apps-and-storage) to get apps embeds that are in use on a site.
1. Call [Create Consent Config](fallback::https://dev.wix.com/docs/api-reference/business-management/cookie-consent-policy/consent-configs/create-consent-config) with the updated consent category to override the app embed's default category.
1. When relevant, call [Update Consent Config](fallback::https://dev.wix.com/docs/api-reference/business-management/cookie-consent-policy/consent-configs/update-consent-config) to update the consent config.

Coding Examples

Sled Tests

Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

API Reference

Velo

Picasso

GraphQL (Alpha)

Query Consent Configs