createMarketingConsent( )

Developer Preview

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

Creates a confirmed marketing consent with a state of CONFIRMED. Required fields:

  • details.type.
  • details.email OR details.phone.
  • lastConfirmationActivity.

To create a marketing consent with a different state, use Upsert Marketing Consent, or Bulk Upsert Marketing Consent.

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
marketingConsentMarketingConsentRequired

Marketing consent to create.

Returns
Return Type:Promise<MarketingConsent>
JavaScript
Errors

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

Did this help?