Go Headless

/

Velo
Articles
API Overview
Getting Started
Tutorials
Velo Package Readmes
Release Notes

Velo-Only APIs
About Velo-Only APIs and the SDK
$w
$widget
wix-animations-frontend
wix-configs-backend
wix-http-functions
wix-realtime-backend
wix-application
wix-editor
wix-widget

APIs
About Velo APIs and the SDK
wix-activity-counters.v2
wix-analytics.v2
wix-auth
wix-billing.v2
wix-billing-backend
wix-blog-backend
wix-bookings-frontend
wix-bookings.v1
wix-bookings.v2
wix-bookings-backend
wix-business-tools.v2
Introduction
Locations
SiteProperties
Introduction
getSiteProperties()
updateBusinessContact()
updateBusinessProfile()
updateBusinessSchedule()
updateConsentPolicy()
wix-cache-backend
wix-captcha.v2
wix-captcha-backend
wix-chat-backend
wix-comments.v2
wix-crm-frontend
wix-crm.v2
wix-crm-backend
wix-dashboard
wix-dashboard-management.v2
wix-data
wix-data.v2
wix-ecom.v2
wix-ecom-frontend
wix-ecom-backend
wix-email-marketing.v2
wix-events-frontend
wix-events.v2
wix-events-backend
wix-fetch
wix-forms.v2
wix-forum.v2
wix-forum-backend
wix-groups.v2
wix-groups-backend
wix-inbox.v2
wix-location-frontend
wix-loyalty.v2
wix-marketing-backend
wix-marketing.v2
wix-marketing-tags.v2
wix-media-backend
wix-media.v2
wix-members-frontend
wix-members.v2
wix-members-backend
wix-mobile
wix-multilingual.v2
wix-navigate-mobile
wix-pay-frontend
wix-pay-backend
wix-payment-provider-backend
wix-pricing-plans-frontend
wix-pricing-plans.v2
wix-pricing-plans-backend
wix-pro-gallery-backend
wix-realtime-frontend
wix-reviews.v2
wix-restaurants.v2
wix-search
wix-secrets-backend
wix-secrets-backend.v2
wix-seo-frontend
wix-site-frontend
wix-site-backend
wix-storage-frontend
wix-storage-mobile
wix-stores.v2
wix-stores-frontend
wix-stores-backend
wix-table-reservations.v2
wix-tags.v1
wix-urls.v2
wix-web-module
wix-window-frontend
wix-site-plugins.v1

Events & Service Plugins
About Events & Service Plugins and the SDK
Activity Counters
Automations
Billing
Bookings
Business Tools
Comments
CRM
Data
eCommerce
Email Marketing
Forms
Forum
Groups
Inbox
Loyalty
Marketing
Marketing Tags
Media
Members
Pricing Plans
Payments
Pro-Gallery
Routers
Site Monitoring
Stores
Table Reservations
Wix Events





updateConsentPolicy( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates a site's default consent policy.

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Consent Policy
Learn more about app permissions.
Method Declaration
Copy
function updateConsentPolicy(consentPolicy: ConsentPolicy): Promise<void>;
Method Parameters
consentPolicyConsentPolicyRequired

Default consent policy defined by the Wix user. Can be further limited by site visitors.

Update Consent Policy (dashboard page code)
This example uses elevate(), which enables site visitors to call functions without the required permissions. Exercise caution when using elevate() to prevent security vulnerabilities.
JavaScript
import { siteProperties } from "wix-business-tools.v2"; import { elevate } from "wix-auth"; /* Sample objectArg value: * { * advertising: true, * analytics: true, * dataToThirdParty: true, * essential: true, * functional: true * } */ export async function myUpdateConsentPolicyFunction(consentPolicy) { try { const elevatedUpdateConsentPolicy = elevate( siteProperties.updateConsentPolicy, ); await elevatedUpdateConsentPolicy(consentPolicy); console.log("Success! Updated policy"); return true; } catch (error) { console.error(error); // Handle the error } } /* Promise resolves to void */
Errors
401Unauthenticated

There is 1 error with this status code.

403Permission Denied

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?