CData Python Connector for HubSpot

Build 25.0.9454

MarketingEmails

Enables creation, management, and retrieval of marketing emails in HubSpot for email campaign management.

Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Unique identifier for the marketing email.

RssToEmailTimingRepeats String False

Defines how frequently an RSS-to-email campaign sends. Accepts these values: 'instant', 'daily', 'weekly', 'monthly'.

RssToEmailTimingRepeatsOnMonthly Integer False

Specifies the day of the month (1-31) when a monthly Really Simple Syndication (RSS) email should be sent.

RssToEmailTimingRepeatsOnWeekly Integer False

Specifies the day of the week (1=Monday to 7=Sunday) when a weekly RSS email should be sent.

RssToEmailTimingSummary String False

Summary description for the RSS-to-email timing. Reserved for future use.

RssToEmailTimingTime String False

Time of day the RSS email should be sent.

Ab Boolean True

Indicates whether the email is part of an A/B test campaign.

AbHoursToWait Integer False

Number of hours to wait before finalizing an A/B test. If results are inconclusive, variation A is used.

AbSampleSizeDefault String True

List showing which variations are used when there are fewer than 1000 recipients. Typically includes 'MASTER' and 'VARIANT'.

AbSamplingDefault String False

Default variation selected if A/B test results are inconclusive. Specifies whether 'MASTER' or 'VARIANT' is sent.

AbStatus String False

Specifies whether the email variation is the primary (MASTER) or secondary (VARIANT) version in an A/B test.

AbSuccessMetric String False

Metric used to determine the winning variation in an A/B test. Options include clicks by opens, clicks by delivered, or opens by delivered.

AbTestId String False

Unique test ID shared between variation A and B emails.

AbTestPercentage Integer False

Percentage size of the audience segment included in the A/B test group.

AbVariation Boolean False

Indicates whether the current email is a variation in an A/B test.

AbsoluteUrl String False

Full URL of the web version of the email.

AllEmailCampaignIds String False

List of all related email campaign IDs associated with this email.

AnalyticsPageId String False

ID used to reference the email's analytics page.

AnalyticsPageType String True

Type of analytics page. Always 'email' for email analytics.

Archived Boolean False

Boolean flag indicating whether the email is archived.

Author String True

Email address of the user who last updated the email.

AuthorAt Datetime True

Timestamp showing when the email was last updated.

AuthorEmail String True

Email address of the user who last updated the email.

AuthorName String True

Full name of the user who last updated the email.

AuthorUserId Long True

ID of the user who last updated the email.

BlogEmailType String False

Specifies how frequently blog-related emails are sent. Possible values: 'instant', 'daily', 'weekly', 'monthly'.

Campaign String False

ID of the marketing campaign associated with the email.

CampaignName String False

Name of the marketing campaign associated with the email.

CanSpamSettingsId Long False

CAN-SPAM settings ID used to retrieve the organization's address shown in the email footer.

CategoryId Integer True

Static category ID, always 2, indicating this is an email (read-only).

ClonedFrom Long True

ID of the source email if this email was cloned from an existing one.

ContentTypeCategory Integer True

Category type ID for content, always 2 for emails (read-only).

CreatePage Boolean False

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

Created Datetime True

Datetime when the email was initially created.

CurrentlyPublished Boolean False

Boolean flag indicating whether the email is currently published and visible to recipients.

Domain String True

Domain name used in the web version of the email. Defaults to the primary domain.

EmailBody String False

Main content body of the email, typically containing text, images, and links.

EmailNote String False

Optional internal notes about the email, visible on the email details page.

EmailType String False

Specifies the type or category of the email (for example, regular, automated, RSS-based).

FeedbackEmailCategory String False

For feedback emails, specifies the type of feedback collected: Net Promoter Score (NPS), Customer Effort Score (CES), or Custom.

FeedbackSurveyId Long False

ID referencing the feedback survey associated with the email, if applicable.

FolderId Long False

ID of the folder in which the email is stored.

FreezeDate Datetime False

The timestamp representing either the email's publish date or last update date if unpublished.

FromName String False

Sender name displayed to recipients, typically linked to the reply-to address.

HtmlTitle String False

HTML title for the web version of the email, displayed in browser tabs and search results.

IsGraymailSuppressionEnabled Boolean False

If true, the email avoids sending to contacts marked as unengaged.

IsLocalTimezoneSend Boolean False

If true, email send times are adjusted to match each recipient's local timezone.

IsPublished Boolean False

Boolean indicating whether the email is currently published and live.

LiveDomain String True

The live domain name used in the web version of the email (read-only field).

MailingListsExcluded String True

Comma-separated list of contact lists to exclude from receiving the email.

MailingListsIncluded String True

Comma-separated list of contact lists to include in the email send.

MaxRssEntries Long False

Maximum number of RSS feed entries or blog posts included in the email content.

MetaDescription String False

Meta description of the web version of the email, aiding search engine visibility.

Name String False

The display name of the email as shown in the email dashboard.

PageExpiryDate Datetime False

Expiration timestamp for the web-hosted version of the email.

PageExpiryRedirectId Long False

ID of the redirect URL for the web version after expiration.

PageRedirected Boolean False

Boolean indicating whether the web version of the email has been set to redirect.

PortalId Long False

ID of the HubSpot portal that owns this email.

PreviewKey String False

Preview key used to generate a shareable preview URL for the email before publishing.

ProcessingStatus String False

Current processing status of the email, such as draft, scheduled, or sent.

PublishDate Datetime False

Timestamp when the email was published or scheduled to be sent.

PublishImmediately Boolean False

If true, the email will be sent immediately after being published.

PublishedAt Datetime True

Timestamp indicating when the publish button was pressed for the email.

PublishedById Long True

ID of the user who published the email.

PublishedByName String True

Name of the user who published the email.

PublishedUrl String True

Absolute URL for the published email's web version.

ReplyTo String False

Reply-to email address displayed to recipients.

ResolvedDomain String True

Domain used in the web version, either the default primary domain or a custom domain.

RssEmailAuthorLineTemplate String False

Prefix text displayed before the author's name in blog and RSS email entries.

RssEmailBlogImageMaxWidth Integer False

Maximum pixel width for images included in blog and RSS emails.

RssEmailByText String False

Fallback prefix displayed before the author name if no specific author line template is set.

RssEmailClickThroughText String False

Link text prompting recipients to view the full blog post in RSS emails.

RssEmailCommentText String False

Link text prompting recipients to comment on the blog post in RSS emails.

RssEmailEntryTemplate String False

Optional custom HTML template used for each RSS feed entry in the email.

RssEmailEntryTemplateEnabled Boolean False

Boolean indicating whether the custom entry template is enabled for the RSS email.

RssEmailUrl String False

URL used for sharing the RSS email content on social media platforms.

Slug String False

URL path component used in the web version of the email.

Subcategory String False

Subcategory classification of the email, typically used for organizational purposes.

Subject String False

The subject line of the email displayed to recipients.

Subscription Long False

ID referencing the email subscription type assigned to the email.

SubscriptionBlogId Long False

For blog subscription emails, the ID of the blog linked to the email.

SubscriptionName String False

Name of the subscription type assigned to the email.

TemplatePath String False

File path to the email's body template within the HubSpot design manager.

Transactional Boolean True

Boolean indicating whether the email is marked as transactional (non-marketing).

UnpublishedAt Datetime False

Timestamp indicating when the email was unpublished.

Updated Datetime True

Timestamp showing when the email was last updated.

UpdatedById Long True

ID of the user who last updated the email content.

Url String True

The full URL to access the web-hosted version of the email.

UseRssHeadlineAsSubject Boolean False

If true, the email's subject line is dynamically set using the latest RSS feed headline.

Widgets String True

List of layout widgets and content sections used in the email design.

VidsExcluded String True

Comma-separated list of contact IDs excluded from receiving the email.

VidsIncluded String True

Comma-separated list of contact IDs specifically included to receive the email.

WorkflowNames String True

List of workflow names linked to the email, for automation purposes.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454