MarketingEmails

Create and manage HubSpot Marketing Emails.

Columns

Name Type ReadOnly References Description
Id [KEY] Long True

The id of the email.
RssToEmailTimingRepeats String False

[ 'instant', 'daily', 'weekly', 'monthly' ]
RssToEmailTimingRepeatsOnMonthly Integer False

What day of the month should the monthly email be sent [1-31].
RssToEmailTimingRepeatsOnWeekly Integer False

What day of the week should the weekly email be sent [1=monday - 7=sunday].
RssToEmailTimingSummary String False

Descripton. Not used.
RssToEmailTimingTime String False

Time the email should be sent at.
Ab Boolean True

Whether or not the page is part of an AB test.
AbHoursToWait Integer False

On AB emails, if test results are inconclusive after the specified hours, variation A will be sent.
AbSampleSizeDefault String True

['MASTER', 'VARIANT'] if there are less than 1000 recipients, only one variation will be sent.
AbSamplingDefault String False

['MASTER', 'VARIANT'] if AB test results are inconclusive in the test group, choose a variation to send (resp. A or B) to the remaining contacts.
AbStatus String False

['MASTER', 'VARIANT'] determines if the current email is variation A or variation B.
AbSuccessMetric String False

[ CLICKS_BY_OPENS, CLICKS_BY_DELIVERED, OPENS_BY_DELIVERED ] metric that will be used to determine the winning variation.
AbTestId String False

ID shared between variation A and B
AbTestPercentage Integer False

The size of the test group.
AbVariation Boolean False

Determines whether the email is a variant or not.
AbsoluteUrl String False

The URL of the web version of the email.
AllEmailCampaignIds String False

A list of email IDs that are associated with the email.

AnalyticsPageId String False

The ID used to access the analytics page of the email.
AnalyticsPageType String True

Always 'email' for an email.
Archived Boolean False

Determines whether the email is archived or not.
Author String True

The email of the user who made the last update to the email.

AuthorAt Datetime True

Timestamp of the last update to the email in milliseconds.
AuthorEmail String True

The email of the user who made the last update to the email.
AuthorName String True

The name of the user who made the last update to the email.
AuthorUserId Long True

ID of the user who made the last update to the email.
BlogEmailType String False

['instant', 'daily', 'weekly', 'monthly'] the cadence for how often blog emails should be sent.
Campaign String False

The ID of an email's marketing campaign.
CampaignName String False

The name of the email's marketing campaign.
CanSpamSettingsId Long False

ID used to retrieve the company address, shown in the footer.
CategoryId Integer True

The category ID value, which is always 2 for emails (read only).
ClonedFrom Long True

If the email was cloned, ID of the email it was cloned from.
ContentTypeCategory Integer True

The category ID value, which is always 2 for emails (read only).
CreatePage Boolean False

Enables a web version of the email when set to true.

Created Datetime True

The timestamp of the email's creation, in milliseconds.

CurrentlyPublished Boolean False

Determines the publish status of the email.

Domain String True

The domain of the web version of the email. Defaults to the primary domain.

EmailBody String False

The main content of the email within the 'main email body' module.
EmailNote String False

Optional email notes, included in the details page of the email.

EmailType String False

Type of the email.
FeedbackEmailCategory String False

[ 'NPS', 'CES', 'CUSTOM' ] If the email is a feedback email, determines type of feedback email.
FeedbackSurveyId Long False

The id of the feedback survey that is linked to the email.
FolderId Long False

If the email is in a folder, id of that folder.
FreezeDate Datetime False

The publish date or updated date if the email is not published.
FromName String False

The sender name recipients will see (linked to the replyTo address).
HtmlTitle String False

The page title of the web version of the email.
IsGraymailSuppressionEnabled Boolean False

If true, the email will not send to unengaged contacts.

IsLocalTimezoneSend Boolean False

If true, the email will adjust its send time relative to the recipients timezone.

IsPublished Boolean False

If true, the email is in a published state.
LiveDomain String True

Domain actually used in the web version (read only)
MailingListsExcluded String True

A list of all contact lists to exclude from the email send.

MailingListsIncluded String True

A list of all contact lists included in the email send.

MaxRssEntries Long False

In blog and recurring emails, the max number of entries to include.

MetaDescription String False

Meta description of the web version of the email, to drive search engine traffic to your page
Name String False

The name of the email, as displayed on the email dashboard.

PageExpiryDate Datetime False

The expiration date of the web version of an email, in milliseconds.
PageExpiryRedirectId Long False

The url of the page the user will be redirected to after the web version of the email expires.
PageRedirected Boolean False

Indicates if the email's web version has already been set to redirect
PortalId Long False

The id of the parent portal.
PreviewKey String False

The preview key used to generate the preview url before the email is published
ProcessingStatus String False

The email's processing status.
PublishDate Datetime False

The timestamp in milliseconds that the email has been published at, or scheduled to send at.

PublishImmediately Boolean False

True if the email is not scheduled but will send at publish time.
PublishedAt Datetime True

If the email has been published, the time when the publish button has been pressed.
PublishedById Long True

If the email has been published, email of the user that pressed the publish button.
PublishedByName String True

If the email has been published, name of the user that pressed the publish button.
PublishedUrl String True

AbsoluteUrl, only if the email is currentlyPublished
ReplyTo String False

The email address the recipient will see and reply to.
ResolvedDomain String True

The domain used in the web version: either the primary one or the one set in the domain field.
RssEmailAuthorLineTemplate String False

Text shown before the 'author_line' tag in blog and RSS email's items.
RssEmailBlogImageMaxWidth Integer False

The max width for blog post images in RSS emails.

RssEmailByText String False

If rssEmailAuthorLineTemplate is not set, word before the author name in blog and RSS email's items.
RssEmailClickThroughText String False

Text shown on the link to see the full post in blog and RSS email's items.
RssEmailCommentText String False

Text shown on the link to comment the post in blog and RSS email's items.
RssEmailEntryTemplate String False

Optional, custom template for every RSS entry.
RssEmailEntryTemplateEnabled Boolean False

Determines if the Entry Template is used for an RSS email.

RssEmailUrl String False

URL used for social sharing.

Slug String False

Path of the web version URL.

Subcategory String False

Subcategory.
Subject String False

The subject of the email.

Subscription Long False

The id of the email's subscription type.
SubscriptionBlogId Long False

For blog emails, id of the linked blog.
SubscriptionName String False

The name of the email's subscription type.
TemplatePath String False

The path of the email's body template within the design manager.

Transactional Boolean True

Determines whether the email is a transactional email or not.

UnpublishedAt Datetime False

The timestamp in milliseconds of when the email was unpublished.
Updated Datetime True

Timestamp of the last update in milliseconds.
UpdatedById Long True

The ID of the last user who updated the email.
Url String True

The web version URL
UseRssHeadlineAsSubject Boolean False

Setting for RSS emails, uses the latest RSS entry as the email subject.
Widgets String True

The content of layout sections of the email (widgets).
VidsExcluded String True

A list of contact IDs to exclude from being sent the email.

VidsIncluded String True

A list of contacts IDs to include in the email send.

WorkflowNames String True

A list of all linked workflows to this email.