getMarketingConsentByIdentifier( )

Retrieves a marketing consent by its details. Required fields:

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

Note: Due to the ongoing development of our new documentation portal, the query parameter is not displaying as expected. Use the details object located in the marketing consent object in the request. You can also see the code example for reference.

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
Read Marketing Consents
Manage Stores
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
typeMarketingConsentDetailsIdentifierTypeRequired

The communication channel of the marketing consent.

optionsGetMarketingConsentByIdentifierOptions

Field options. The relevant email or phone must be passed.

Returns
Return Type:Promise<GetMarketingConsentByIdentifierResponse>
Errors

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

Did this help?