EmailSubscriptions
Lists subscription types linked to a specific email address, allowing management of subscription preferences.
Table Specific Information
Email subscriptions in HubSpot represent different types of subscriptions a given contact email may be subscribed to. When deleting an email subscription the contact will be opted out and will not receive emails from the specified subscription type(mailing group). EmailSubscriptions lists the subscriptions a given email address is subscribed to.
SELECT
When selecting email subscriptions, an email must be provided. For example:
SELECT * FROM EmailSubscriptions WHERE Email = '[email protected]'
Columns
| Name | Type | ReadOnly | References | Description |
| Email [KEY] | String | True |
The email address associated with the subscription. | |
| SubscriptionId [KEY] | Long | True |
Unique identifier of the email subscription type. | |
| IsSubscribed | Boolean | False |
Boolean flag indicating whether the customer is currently subscribed to the subscription type. | |
| ExtraUrlParameters | String | False |
Optional input-only property to specify additional query parameters when retrieving email subscription data. Format: 'param1=value1, param2=value2, param3=value3'. | |
| LegalBasis | String | False |
The lawful basis for communicating with the contact, typically for General Data Protection Regulation (GDPR) compliance. The allowed values are LEGITIMATE_INTEREST_PQL, LEGITIMATE_INTEREST_CLIENT, PERFORMANCE_OF_CONTRACT, CONSENT_WITH_NOTICE, NON_GDPR, PROCESS_AND_STORE, LEGITIMATE_INTEREST_OTHER. | |
| LegalBasisExplanation | String | False |
Explanation or supporting information about the lawful basis provided. | |
| OptState | String | False |
Specifies whether a contact is opted in or out of a given email subscription type. Possible values are OPT_IN, OPT_OUT, NOT_OPTED. Opting out is permanent and cannot be undone. The allowed values are OPT_IN, OPT_OUT, NOT_OPTED. |