getMarketingConsentByIdentifier( )

Developer Preview

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

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

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

Permissions
Manage Marketing Consents
Read Marketing Consents
Learn more about app permissions.
Method Declaration
Copy
function getMarketingConsentByIdentifier(
  type: MarketingConsentDetailsIdentifierType,
  options: GetMarketingConsentByIdentifierOptions,
): Promise<GetMarketingConsentByIdentifierResponse>;
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>
JavaScript
import { marketingConsent } from "wix-marketing.v2";

async function getMarketingConsentByIdentifier(type, options) {
  try {
    const result = await marketingConsent.getMarketingConsentByIdentifier(
      type,
      options,
    );
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}
Errors

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

Did this help?