> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # GetMarketingConsentByIdentifier # Package: marketing # Namespace: MarketingConsentService # Method link: https://dev.wix.com/docs/api-reference/business-management/marketing/marketing-consent/get-marketing-consent-by-identifier.md ## Permission Scopes: Read Marketing Consents: SCOPE.DC-MARKETING.CONSENT-READ ## Introduction 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. --- ## REST API ### Schema ``` Method: getMarketingConsentByIdentifier Description: 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. URL: https://www.wixapis.com/v1/marketing-consent/get-by Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: type Method parameters: query param name: linkLanguage | type: linkLanguage | description: Language of the page param name: type | type: MarketingConsentDetailsIdentifierType | required: true - enum: UNKNOWN_TYPE - EMAIL - PHONE - Return type: GetMarketingConsentByIdentifierResponse - name: marketingConsent | type: MarketingConsent | description: The requested marketing consent. - name: id | type: string | description: Marketing consent GUID. - name: revision | type: string | description: Revision number. - name: details | type: MarketingConsentDetails | description: Marketing consent communication details. - ONE-OF: - name: email | type: string | description: Email address used for the marketing consent. - name: phone | type: string | description: Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format used for the SMS marketing consent. - name: type | type: MarketingConsentDetailsIdentifierType | description: The communication channel of the marketing consent. - enum: UNKNOWN_TYPE, EMAIL, PHONE - name: state | type: MarketingConsentState | description: Marketing consent state. Default: `UNKNOWN_STATE`. - enum: - UNKNOWN_STATE: State of the marketing consent is unknown. - NEVER_CONFIRMED: The site visitor never confirmed to receive marketing consents. - REVOKED: The marketing consent has been removed, for example, when a site visitor unsubscribes from a newsletter. - PENDING: The marketing consent is pending confirmation. Relevant only for `{"optInLevel": "DOUBLE_CONFIRMATION"}`. - CONFIRMED: The site visitor has confirmed their marketing consent. - name: createdDate | type: string | description: Date and time the marketing consent was created. - name: updatedDate | type: string | description: Date and time the marketing consent was updated. - name: lastConfirmationActivity | type: LastConfirmationActivity | description: Last confirmation activity of the marketing consent. - name: source | type: Source | description: Source of the given consent (how the site visitor signed up). - enum: IN_PERSON, FORM, LINK_CONFIRMATION, EMAIL_SERVICE, WIX_USERS, OTHER - name: description | type: string | description: Consent description. - name: updatedDate | type: string | description: Date and time the consent was updated. - name: optInLevel | type: OptInLevel | description: Consent opt in level, either single or double confirmation. - enum: UNKNOWN_OPT_IN_LEVEL, SINGLE_CONFIRMATION, DOUBLE_CONFIRMATION - name: lastRevokeActivity | type: LastRevokeActivity | description: Last revoke activity of the marketing consent. - name: source | type: Source | description: Source of the given revoke (how the visitor signed up). - enum: IN_PERSON, FORM, REVOKE_LINK, WIX_USERS, OTHER - name: description | type: string | description: Details about the revoke, if relevant. - name: updatedDate | type: string | description: Date and time the consent was updated. - name: extendedFields | type: ExtendedFields | description: Additional fields. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: communicationEligibility | type: CommunicationEligibility | description: Details about whether the subject of the marketing consent is eligible to receive marketing messages. - name: granted | type: boolean | description: Whether the recipient of the marketing consent is eligible to receive marketing messages. For example, if a visitor cancels their marketing consent, `CommunicationEligibility.granted` is `false`. Note that this only serves as a signal for your app to decide whether or not it should send marketing messages to the recipient's email address or phone number. - name: revokeConfirmationLink | type: string | description: Cancellation link. - name: reason | type: string | description: The reason the recipient of the marketing consent isn't eligible to receive marketing messages, for example, if the visitor unsubscribed from a newsletter. ``` ### Examples ### Get a marketing consent by its communication details ```curl curl -X GET \ 'https://www.wixapis.com/marketing-consent/v1/marketing-consent/get-by?type=EMAIL&email=yourtest@test.com' \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.marketing.MarketingConsentService.getMarketingConsentByIdentifier(type, options) Description: 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. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: type, options Method parameters: param name: options | type: GetMarketingConsentByIdentifierOptions none | required: true - ONE-OF: - required: true - name: email | type: string | description: Email address used for the marketing consent. - name: phone | type: string | description: Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format used for the SMS marketing consent. - name: linkLanguage | type: string | description: Language of the page param name: type | type: MarketingConsentDetailsIdentifierType | required: true - enum: UNKNOWN_TYPE - EMAIL - PHONE - Return type: PROMISE - name: marketingConsent | type: MarketingConsent | description: The requested marketing consent. - name: _id | type: string | description: Marketing consent GUID. - name: revision | type: string | description: Revision number. - name: details | type: MarketingConsentDetails | description: Marketing consent communication details. - ONE-OF: - name: email | type: string | description: Email address used for the marketing consent. - name: phone | type: string | description: Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format used for the SMS marketing consent. - name: type | type: MarketingConsentDetailsIdentifierType | description: The communication channel of the marketing consent. - enum: UNKNOWN_TYPE, EMAIL, PHONE - name: state | type: MarketingConsentState | description: Marketing consent state. Default: `UNKNOWN_STATE`. - enum: - UNKNOWN_STATE: State of the marketing consent is unknown. - NEVER_CONFIRMED: The site visitor never confirmed to receive marketing consents. - REVOKED: The marketing consent has been removed, for example, when a site visitor unsubscribes from a newsletter. - PENDING: The marketing consent is pending confirmation. Relevant only for `{"optInLevel": "DOUBLE_CONFIRMATION"}`. - CONFIRMED: The site visitor has confirmed their marketing consent. - name: _createdDate | type: Date | description: Date and time the marketing consent was created. - name: _updatedDate | type: Date | description: Date and time the marketing consent was updated. - name: lastConfirmationActivity | type: LastConfirmationActivity | description: Last confirmation activity of the marketing consent. - name: source | type: Source | description: Source of the given consent (how the site visitor signed up). - enum: IN_PERSON, FORM, LINK_CONFIRMATION, EMAIL_SERVICE, WIX_USERS, OTHER - name: description | type: string | description: Consent description. - name: _updatedDate | type: Date | description: Date and time the consent was updated. - name: optInLevel | type: OptInLevel | description: Consent opt in level, either single or double confirmation. - enum: UNKNOWN_OPT_IN_LEVEL, SINGLE_CONFIRMATION, DOUBLE_CONFIRMATION - name: lastRevokeActivity | type: LastRevokeActivity | description: Last revoke activity of the marketing consent. - name: source | type: Source | description: Source of the given revoke (how the visitor signed up). - enum: IN_PERSON, FORM, REVOKE_LINK, WIX_USERS, OTHER - name: description | type: string | description: Details about the revoke, if relevant. - name: _updatedDate | type: Date | description: Date and time the consent was updated. - name: extendedFields | type: ExtendedFields | description: Additional fields. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: communicationEligibility | type: CommunicationEligibility | description: Details about whether the subject of the marketing consent is eligible to receive marketing messages. - name: granted | type: boolean | description: Whether the recipient of the marketing consent is eligible to receive marketing messages. For example, if a visitor cancels their marketing consent, `CommunicationEligibility.granted` is `false`. Note that this only serves as a signal for your app to decide whether or not it should send marketing messages to the recipient's email address or phone number. - name: revokeConfirmationLink | type: string | description: Cancellation link. - name: reason | type: string | description: The reason the recipient of the marketing consent isn't eligible to receive marketing messages, for example, if the visitor unsubscribed from a newsletter. ``` ### Examples ### getMarketingConsentByIdentifier ```javascript import { marketingConsent } from '@wix/marketing'; async function getMarketingConsentByIdentifier(type,options) { const response = await marketingConsent.getMarketingConsentByIdentifier(type,options); }; ``` ### getMarketingConsentByIdentifier (with elevated permissions) ```javascript import { marketingConsent } from '@wix/marketing'; import { auth } from '@wix/essentials'; async function myGetMarketingConsentByIdentifierMethod(type,options) { const elevatedGetMarketingConsentByIdentifier = auth.elevate(marketingConsent.getMarketingConsentByIdentifier); const response = await elevatedGetMarketingConsentByIdentifier(type,options); } ``` ### getMarketingConsentByIdentifier (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { marketingConsent } from '@wix/marketing'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { marketingConsent }, // Include the auth strategy and host as relevant }); async function getMarketingConsentByIdentifier(type,options) { const response = await myWixClient.marketingConsent.getMarketingConsentByIdentifier(type,options); }; ``` ---