removeMarketingConsent( )

Developer Preview

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

Removes a marketing consent. The consent is cancelled, and the state is updated to REVOKED. The marketing consent entity still exists, but the recipient is no longer eligible to receive commmunication. To delete a marketing consent entirely, use Delete Marketing Consent.

Required fields:

  • details.type.
  • details.email OR details.phone.
  • info.lastRevokeActivity.
Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Marketing Consents
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
detailsMarketingConsentDetailsRequired

Marketing consent communication details.

optionsRemoveMarketingConsentOptions

Field options. The lastRevokeActivity field must be passed.

Returns
Return Type:Promise<RemoveMarketingConsentResponse>
JavaScript
Errors

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

Did this help?