Navigation: Catalog: MarketingEmailsV33 > Schemas > Schema: MarketingEmails > Tables

MarketingEmails

Get all marketing emails for a HubSpot account.The results can be filtered, allowing you to find a specific set of emails. See the table below for a full list of filtering options.

Catalog: MarketingEmailsV33

Schema: MarketingEmails

Label: {res:itgen_hubspot_marketingemails_plural}

Retrieve: true

Insert: true

Update: false

Delete: false

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function MarketingEmails. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name	Data Type	Required	Documentation
after	string	☐	The cursor token value to get the next set of results. You can get this from the `paging.next.after` JSON property of a paged response containing more results.
archived	boolean	☐	Specifies whether to return archived emails. Defaults to `false`.
createdAfter	datetime	☐	Only return emails created after the specified time.
createdAt	datetime	☐	Only return emails created at exactly the specified time.
createdBefore	datetime	☐	Only return emails created before the specified time.
includeStats	boolean	☐	Include statistics with emails.
isPublished	boolean	☐	Filter by published/draft emails. All emails will be returned if not present.
type	string	☐	Email types to be filtered by. Multiple types can be included. All emails will be returned if not present. (Waarden: AB_EMAIL, BATCH_EMAIL, LOCALTIME_EMAIL, AUTOMATED_AB_EMAIL, BLOG_EMAIL, BLOG_EMAIL_CHILD, RSS_EMAIL, RSS_EMAIL_CHILD, RESUBSCRIBE_EMAIL, OPTIN_EMAIL, OPTIN_FOLLOWUP_EMAIL, AUTOMATED_EMAIL, FEEDBACK_CES_EMAIL, FEEDBACK_CUSTOM_EMAIL, FEEDBACK_CUSTOM_SURVEY_EMAIL, FEEDBACK_NPS_EMAIL, FOLLOWUP_EMAIL, LEADFLOW_EMAIL, SINGLE_SEND_API, MARKETING_SINGLE_SEND_API, SMTP_TOKEN, TICKET_EMAIL, MEMBERSHIP_REGISTRATION_EMAIL, MEMBERSHIP_PASSWORD_SAVED_EMAIL, MEMBERSHIP_PASSWORD_RESET_EMAIL, MEMBERSHIP_EMAIL_VERIFICATION_EMAIL, MEMBERSHIP_OTP_LOGIN_EMAIL)
updatedAfter	datetime	☐	Only return emails last updated after the specified time.
updatedAt	datetime	☐	Only return emails last updated at exactly the specified time.
updatedBefore	datetime	☐	Only return emails last updated before the specified time.

Columns of Table Function

The columns of the table function MarketingEmails are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert.

Name	Data Type	Label	Required	Documentation
activeDomain	string	{res:itgen_hubspot_activedomain}	☐	The active domain of the email.
archived	boolean	Archived	☐	Determines if the email is archived or not.
businessUnitId	string	{res:itgen_hubspot_businessunitid}	☐
campaign	string	Campaign	☐	The ID of the campaign this email is associated to.
content_flexAreas	string	{res:itgen_hubspot_content_flexareas}	☐
content_plainTextVersion	string	{res:itgen_hubspot_content_plaintextversion}	☐
content_smartFields	string	{res:itgen_hubspot_content_smartfields}	☐
content_styleSettings	string	{res:itgen_hubspot_content_stylesettings}	☐
content_templatePath	string	{res:itgen_hubspot_content_templatepath}	☐
content_themeSettingsValues	string	{res:itgen_hubspot_content_themesettingsvalues}	☐
content_widgetContainers	string	{res:itgen_hubspot_content_widgetcontainers}	☐
content_widgets	string	{res:itgen_hubspot_content_widgets}	☐
createdAt	datetime	Created at	☐	The date and time of the email's creation, in ISO8601 representation.
createdById	string	Created by ID	☐	The id of the user who created the email.
deletedAt	datetime	Deleted at	☐
feedbackSurveyId	string	{res:itgen_hubspot_feedbacksurveyid}	☐	The ID of the feedback survey linked to the email.
folderId	int64	Folder ID	☐
from_customReplyTo	string	{res:itgen_hubspot_from_customreplyto}	☐	The reply to recipients will see.
from_fromName	string	{res:itgen_hubspot_from_fromname}	☐	The name recipients will see.
from_replyTo	string	{res:itgen_hubspot_from_replyto}	☐	The from address and reply to email address (if no customReplyTo defined) recipients will see.
id	string	ID	☐	The email ID.
isPublished	boolean	{res:itgen_hubspot_ispublished}	☐	Returns the published status of the email. This is read only.
isTransactional	boolean	{res:itgen_hubspot_istransactional}	☐	Returns whether the email is a transactional email or not. This is read only.
language	string	Language	☐
name	string	Name	☐	The name of the email, as displayed on the email dashboard.
publishDate	datetime	Publish Date	☐	The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails.
publishedAt	datetime	Published at	☐	The date and time the email was published at, in ISO8601 representation.
publishedById	string	{res:itgen_hubspot_publishedbyid}	☐
rssData_blogEmailType	string	{res:itgen_hubspot_rssdata_blogemailtype}	☐
rssData_blogImageMaxWidth	int32	{res:itgen_hubspot_rssdata_blogimagemaxwidth}	☐
rssData_blogLayout	string	{res:itgen_hubspot_rssdata_bloglayout}	☐
rssData_hubspotBlogId	string	{res:itgen_hubspot_rssdata_hubspotblogid}	☐
rssData_maxEntries	int32	{res:itgen_hubspot_rssdata_maxentries}	☐
rssData_rssEntryTemplate	string	{res:itgen_hubspot_rssdata_rssentrytemplate}	☐
rssData_timing	string	{res:itgen_hubspot_rssdata_timing}	☐
rssData_url	string	{res:itgen_hubspot_rssdata_url}	☐
rssData_useHeadlineAsSubject	boolean	{res:itgen_hubspot_rssdata_useheadlineassubject}	☐
sendOnPublish	boolean	{res:itgen_hubspot_sendonpublish}	☐	Determines whether the email will be sent immediately on publish.
state	string	State	☐	The email state.
stats_counters	string	{res:itgen_hubspot_stats_counters}	☐	Counters like number of `sent`, `open` or `delivered`.
stats_deviceBreakdown	string	{res:itgen_hubspot_stats_devicebreakdown}	☐	Statistics by device.
stats_qualifierStats	string	{res:itgen_hubspot_stats_qualifierstats}	☐	Number of emails that were dropped and bounced.
stats_ratios	string	{res:itgen_hubspot_stats_ratios}	☐	Ratios like `openratio` or `clickratio`
subcategory	string	Subcategory	☐	The email subcategory.
subject	string	{res:itgen_hubspot_subject}	☐	The subject of the email.
subscriptionDetails_officeLocationId	string	{res:itgen_hubspot_subscriptiondetails_officelocationid}	☐	ID of the selected office location.
subscriptionDetails_preferencesGroupId	string	{res:itgen_hubspot_subscriptiondetails_preferencesgroupid}	☐
subscriptionDetails_subscriptionId	string	{res:itgen_hubspot_subscriptiondetails_subscriptionid}	☐	ID of the subscription.
testing_abSampleSizeDefault	string	{res:itgen_hubspot_testing_absamplesizedefault}	☐	Version of the email that should be sent if there are too few recipients to conduct an AB test.
testing_abSamplingDefault	string	{res:itgen_hubspot_testing_absamplingdefault}	☐	Version of the email that should be sent if the results are inconclusive after the test period, master or variant.
testing_abStatus	string	{res:itgen_hubspot_testing_abstatus}	☐	Status of the AB test.
testing_abSuccessMetric	string	{res:itgen_hubspot_testing_absuccessmetric}	☐	Metric to determine the version that will be sent to the remaining contacts.
testing_abTestPercentage	int32	{res:itgen_hubspot_testing_abtestpercentage}	☐	The size of your test group.
testing_hoursToWait	int32	{res:itgen_hubspot_testing_hourstowait}	☐	Time limit on gathering test results. After this time is up, the winning version will be sent to the remaining contacts.
testing_testId	string	{res:itgen_hubspot_testing_testid}	☐	The ID of the AB test.
to_limitSendFrequency	boolean	{res:itgen_hubspot_to_limitsendfrequency}	☐
to_suppressGraymail	boolean	{res:itgen_hubspot_to_suppressgraymail}	☐
type	string	Type	☐	The email type, this is derived from other properties on the email such as subcategory.
updatedAt	datetime	Updated at	☐	The date and time of the last update to the email, in ISO8601 representation.
updatedById	string	Updated by ID	☐	The id of the user who last updated the email.
webversion_domain	string	{res:itgen_hubspot_webversion_domain}	☐
webversion_expiresAt	datetime	{res:itgen_hubspot_webversion_expiresat}	☐
webversion_metaDescription	string	{res:itgen_hubspot_webversion_metadescription}	☐
webversion_redirectToPageId	string	{res:itgen_hubspot_webversion_redirecttopageid}	☐
webversion_redirectToUrl	string	{res:itgen_hubspot_webversion_redirecttourl}	☐
webversion_slug	string	{res:itgen_hubspot_webversion_slug}	☐
webversion_title	string	{res:itgen_hubspot_webversion_title}	☐

18-12-2024 20:09 Version 24.1.33-BETA+5180

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.

Please enable JavaScript to view this site.

HubSpot API Data Model

MarketingEmails

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information