MarketingEmails
Marketing emails in HubSpot.
Columns
| Name | Type | ReadOnly | References | Filterable | Description |
| Id [KEY] | String | True | True |
The email ID. | |
| Subject | String | False |
The subject of the email. | ||
| Type | String | False | True |
The email type, this is derived from other properties on the email such as subcategory. Accepted values https://developers.hubspot.com/docs/api-reference/marketing-marketing-emails-v3-v3/marketing-emails/post-marketing-v3-emails-#response-type | |
| Name | String | False |
The name of the email, as displayed on the email dashboard. | ||
| FeedbackSurveyId | String | False |
The ID of the feedback survey linked to the email. | ||
| PublishedByEmail | String | True |
Email address of the publisher. | ||
| PublishDate | String | False |
The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails. | ||
| IsTransactional | Boolean | True |
Returns whether the email is a transactional email or not. This is read only. | ||
| Language | String | False |
Language setting for the content. Accepted values https://developers.hubspot.com/docs/api-reference/marketing-marketing-emails-v3-v3/marketing-emails/post-marketing-v3-emails-#response-language | ||
| CampaignUtm | String | True |
UTM campaign tracking identifier. | ||
| BusinessUnitId | String | False |
Identifier for the business unit. | ||
| Archived | Boolean | False |
Determines if the email is archived or not. | ||
| PublishedByName | String | True |
Name of the person who published the content. | ||
| CreatedAt | String | True |
The date and time of the email's creation, in ISO8601 representation. | ||
| JitterSendTime | Boolean | False |
Whether to apply jitter to the email send time. | ||
| State | String | False |
Current state of the content or entity State. Accepted values https://developers.hubspot.com/docs/api-reference/marketing-marketing-emails-v3-v3/marketing-emails/post-marketing-v3-emails-#response-state | ||
| CreatedById | String | True |
The id of the user who created the email. | ||
| UpdatedAt | String | True |
The date and time of the last update to the email, in ISO8601 representation. | ||
| ClonedFrom | String | False |
The ID of the email this email was cloned from. | ||
| PublishedAt | String | True |
The date and time the email was published at, in ISO8601 representation. | ||
| PublishedById | String | True |
The ID of the user who published the email. | ||
| IsPublished | Boolean | False | True |
Returns the published status of the email. This is read only. | |
| UpdatedById | String | True |
The ID of the user who last updated the email. | ||
| FolderId | Int | True |
Identifier for the folder containing the content FolderId. | ||
| EmailCampaignGroupId | String | True |
Identifier for the associated email campaign group. | ||
| DeletedAt | String | True |
The date and time the email was deleted at, in ISO8601 representation. | ||
| ActiveDomain | String | False |
The active domain of the email. | ||
| Campaign | String | False | True |
The campaign GUID on the email. | |
| Subcategory | String | False |
The email subcategory. Accepted values https://developers.hubspot.com/docs/api-reference/marketing-marketing-emails-v3-v3/marketing-emails/post-marketing-v3-emails-#body-subcategory | ||
| CampaignName | String | True |
The name of the campaign. | ||
| SendOnPublish | Boolean | False |
Determines whether the email will be sent immediately on publish. | ||
| ContentPlainTextVersion | String | False |
Content related data ContentPlainTextVersion. | ||
| ContentTemplatePath | String | False |
Content related data ContentTemplatePath. | ||
| ContentSmartFields | String | False |
Content related data ContentSmartFields. | ||
| ContentThemeSettingsValues | String | False |
Content related data ContentThemeSettingsValues. | ||
| ContentFlexAreas | String | False |
Content related data ContentFlexAreas. | ||
| ContentWidgets | String | False |
Content related data ContentWidgets. | ||
| ContentWidgetContainers | String | False |
Content related data ContentWidgetContainers. | ||
| StyleSettingsEmailBodyPadding | String | False |
Content StyleSettings related data StyleSettingsEmailBodyPadding. | ||
| StyleSettingsBodyColor | String | False |
Content StyleSettings related data StyleSettingsBodyColor. | ||
| StyleSettingsBackgroundImage | String | False |
Content StyleSettings related data StyleSettingsBackgroundImage. | ||
| StyleSettingsEmailBodyWidth | String | False |
Content StyleSettings related data StyleSettingsEmailBodyWidth. | ||
| StyleSettingsSecondaryFont | String | False |
Content StyleSettings related data StyleSettingsSecondaryFont. | ||
| StyleSettingsPrimaryAccentColor | String | False |
Content StyleSettings related data StyleSettingsPrimaryAccentColor. | ||
| StyleSettingsSecondaryFontColor | String | False |
Content StyleSettings related data StyleSettingsSecondaryFontColor. | ||
| StyleSettingsPrimaryFontLineHeight | String | False |
Content StyleSettings related data StyleSettingsPrimaryFontLineHeight. | ||
| StyleSettingsSecondaryFontLineHeight | String | False |
Content StyleSettings related data StyleSettingsSecondaryFontLineHeight. | ||
| StyleSettingsColorPickerFavorite1 | String | False |
Content StyleSettings related data StyleSettingsColorPickerFavorite1. | ||
| StyleSettingsColorPickerFavorite2 | String | False |
Content StyleSettings related data StyleSettingsColorPickerFavorite2. | ||
| StyleSettingsColorPickerFavorite3 | String | False |
Content StyleSettings related data StyleSettingsColorPickerFavorite3. | ||
| StyleSettingsColorPickerFavorite4 | String | False |
Content StyleSettings related data StyleSettingsColorPickerFavorite4. | ||
| StyleSettingsColorPickerFavorite5 | String | False |
Content StyleSettings related data StyleSettingsColorPickerFavorite5. | ||
| StyleSettingsColorPickerFavorite6 | String | False |
Content StyleSettings related data StyleSettingsColorPickerFavorite6. | ||
| StyleSettingsBodyBorderColor | String | False |
Content StyleSettings related data StyleSettingsBodyBorderColor. | ||
| StyleSettingsBodyBorderWidth | Int | False |
Content StyleSettings related data StyleSettingsBodyBorderWidth. | ||
| StyleSettingsBackgroundColor | String | False |
Content StyleSettings related data StyleSettingsBackgroundColor. | ||
| StyleSettingsSecondaryAccentColor | String | False |
Content StyleSettings related data StyleSettingsSecondaryAccentColor. | ||
| StyleSettingsPrimaryFontSize | Int | False |
Content StyleSettings related data StyleSettingsPrimaryFontSize. | ||
| StyleSettingsSecondaryFontSize | Int | False |
Content StyleSettings related data StyleSettingsSecondaryFontSize. | ||
| StyleSettingsPrimaryFontColor | String | False |
Content StyleSettings related data StyleSettingsPrimaryFontColor. | ||
| StyleSettingsPrimaryFont | String | False |
Content StyleSettings related data StyleSettingsPrimaryFont. | ||
| StyleSettingsBodyBorderColorChoice | String | False |
Content StyleSettings related data StyleSettingsBodyBorderColorChoice. | ||
| StyleSettingsBackgroundImageType | String | False |
Content StyleSettings related data StyleSettingsBackgroundImageType. | ||
| StyleSettingsHeadingOneFont | String | False |
Content StyleSettings related data StyleSettingsHeadingOneFont. | ||
| StyleSettingsHeadingTwoFont | String | False |
Content StyleSettings related data StyleSettingsHeadingTwoFont. | ||
| StyleSettingsLinksFont | String | False |
Content StyleSettings related data StyleSettingsLinksFont. | ||
| StyleSettingsButtonStyleSettings | String | False |
Content StyleSettings related data StyleSettingsButtonStyleSettings. | ||
| StyleSettingsDividerStyleSettings | String | False |
Content StyleSettings related data StyleSettingsDividerStyleSettings. | ||
| StatsDeviceBreakdown | String | False |
Breakdown of statistics by device type. | ||
| StatsQualifierStats | String | False |
Statistics related to qualifiers or filters. | ||
| StatsCounters | String | False |
Basic counter-based statistics StatsCounters. | ||
| StatsRatios | String | False |
Ratio-based statistics such as open or click rates. | ||
| FromCustomReplyTo | String | False |
The reply to recipients will see. | ||
| FromFromName | String | False |
The name recipients will see. | ||
| FromReplyTo | String | False |
The from address and reply to email address (if no customReplyTo defined) recipients will see. | ||
| WebversionDomain | String | False |
Webversion related data WebversionDomain. | ||
| WebversionRedirectToPageId | String | False |
Webversion related data WebversionRedirectToPageId. | ||
| WebversionIsPageRedirected | Boolean | False |
Webversion related data WebversionIsPageRedirected. | ||
| WebversionRedirectToUrl | String | False |
Webversion related data WebversionRedirectToUrl. | ||
| WebversionTitle | String | False |
Webversion related data WebversionTitle. | ||
| WebversionMetaDescription | String | False |
Webversion related data WebversionMetaDescription. | ||
| WebversionPageExpiryEnabled | Boolean | False |
Webversion related data WebversionPageExpiryEnabled. | ||
| WebversionEnabled | Boolean | False |
Webversion related data WebversionEnabled. | ||
| WebversionSlug | String | False |
Webversion related data WebversionSlug. | ||
| WebversionUrl | String | False |
Webversion related data WebversionUrl. | ||
| WebversionExpiresAt | String | False |
Webversion related data WebversionExpiresAt. | ||
| RssDataBlogImageMaxWidth | Int | False |
RSS related data BlogImageMaxWidth. | ||
| RssDataBlogEmailType | String | False |
RSS related data RssDataBlogEmailType. | ||
| RssDataHubspotBlogId | String | False |
RSS related data RssDataHubspotBlogId. | ||
| RssDataRssEntryTemplate | String | False |
RSS related data RssDataRssEntryTemplate. | ||
| RssDataMaxEntries | Int | False |
RSS related data RssDataMaxEntries. | ||
| RssDataUseHeadlineAsSubject | Boolean | False |
RSS related data RssDataUseHeadlineAsSubject. | ||
| RssDataBlogLayout | String | False |
RSS related data RssDataBlogLayout. | ||
| RssDataUrl | String | False |
RSS related data RssDataUrl. | ||
| RssDataTiming | String | False |
RSS related data RssDataTiming. | ||
| ToLimitSendFrequency | Boolean | False |
Controls whether to limit the send frequency for recipients. | ||
| ToSuppressGraymail | Boolean | False |
Controls whether to suppress graymail (low engagement) recipients. | ||
| ToContactLists | String | False |
Data structure representing lists of IDs that should be included and excluded. | ||
| ToContactIds | String | False |
Data structure representing lists of IDs that should be included and excluded. | ||
| ToContactIlsLists | String | False |
Data structure representing lists of IDs that should be included and excluded. | ||
| TestingAbSamplingDefault | String | False |
Version of the email that should be sent if the results are inconclusive after the test period, master or variant. | ||
| TestingAbSampleSizeDefault | String | False |
Version of the email that should be sent if there are too few recipients to conduct an AB test. | ||
| TestingAbStatus | String | False |
Status of the AB test. | ||
| TestingAbTestPercentage | Int | False |
The size of your test group. | ||
| TestingHoursToWait | Int | False |
Time limit on gathering test results. After this time is up, the winning version will be sent to the remaining contacts. | ||
| TestingTestId | String | False |
The ID of the AB test. | ||
| TestingAbSuccessMetric | String | False |
Metric to determine the version that will be sent to the remaining contacts. | ||
| TestingIsAbVariation | Boolean | False |
Metric to determine tif it is an AbVariation. | ||
| SubscriptionDetailsOfficeLocationId | String | False |
ID of the selected office location. | ||
| SubscriptionDetailsPreferencesGroupId | String | False |
ID of the preferences group associated with the subscription. | ||
| SubscriptionDetailsSubscriptionId | String | False |
ID of the subscription. | ||
| SubscriptionDetailsSubscriptionName | String | False |
Name of the subscription. |