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
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
"Coupons" Collection Fields
Coupons
MarketingConsent
Introduction
bulkUpsertMarketingConsent()
createMarketingConsent()
deleteMarketingConsent()
getMarketingConsent()
getMarketingConsentByIdentifier()
queryMarketingConsent()
removeMarketingConsent()
updateMarketingConsent()
upsertMarketingConsent()
MarketingConsentQueryBuilder
MarketingConsentQueryResult
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

updateMarketingConsent( )


Developer Preview

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

Update a marketing consent. Required fields:

  • details.type.
  • details.email OR details.phone.
  • state.

When a marketing consent's state is PENDING or CONFIRMED, the info.lastConfirmationActivity field is required. When a marketing consent's state is REVOKED, the info.lastRevokeActivity field is required.

Note: For existing marketing consents with {"type": "EMAIL"}, you can't update the state to UNKNOWN_STATE. Trying to do so maintains the current state. However, you can create a new marketing consent and set the state to UNKNOWN_STATE. Note that you can't create more than a single consent per email or phone number.

Authentication

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

Permissions
Manage Marketing Consents
Manage Stores
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
_idstringRequired

Marketing consent ID.


optionsUpdateMarketingConsentOptions

Field options. The following fields must be passed: details.type, the relevant email OR phone, and state.

Returns
Return Type:Promise<MarketingConsent>
Errors

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

Did this help?