CData Python Connector for HubSpot

Build 25.0.9454

EngagementsEmails

Retrieves all email engagement records in HubSpot, supporting email interaction analysis.

SELECT

When selecting Email Engagements, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators is: =.

SELECT * FROM EngagementsEmails WHERE ID = '11896047040'

INSERT


INSERT INTO EngagementsEmails ([Activity date], [Email Direction], [Attached Video Opened], [Attached Video Watched], [Email send status], [Email subject], [Email body], [UpdatedAt])
VALUES (CURRENT_TIMESTAMP(), 'EMAIL', TRUE, TRUE, 'BOUNCED', 'subject', 'text', CURRENT_TIMESTAMP() )

UPDATE


UPDATE EngagementsEmails SET [Email body] = 'Updated email body', [Email send status] = 'FAILED' WHERE ID = '11896047040'

DELETE


DELETE FROM EngagementsEmails WHERE ID = '11896047040'

Columns

Name Type ReadOnly References Filterable Description
Id [KEY] Long True True

Unique identifier for the email engagement object.

Archived Bool True False

Indicates whether the email engagement has been archived.

CreatedAt Datetime True False

Timestamp when the email engagement was originally created.

UpdatedAt Datetime True False

Timestamp when the email engagement was most recently updated.

Business units String False True

The business units this email engagement is associated with.

AtMentioned Owner Ids String False True

User IDs of owners who were mentioned in the email body.

Attached file IDs String False True

Identifiers of files attached to the email engagement.

Body preview String True True

A shortened preview of the email body content.

HTML Body Preview String True True

HTML-formatted version of the email body preview.

Body Preview Truncated Bool True True

Indicates whether the email body preview was truncated due to length.

Activity created by String True True

The user who originally created the email engagement.

Created by user ID Decimal True True

User ID that created this record. This value is set automatically by HubSpot and cannot be modified.

Create date Datetime True True

The date the email engagement was created in the CRM timeline.

Email direction and unique ID String True True

Direction of the email (sent or received) along with its unique identifier.

Attached Video String False True

ID of a video file attached to the email, if applicable.

Attached Video Name String False True

Name of the video file that was attached to the email.

Attached Video Opened Bool False True

Indicates whether the attached video was opened by the recipient.

Attached Video Watched Bool False True

Indicates whether the attached video was watched by the recipient.

Email BCC Address String True True

Email addresses of the BCC recipients of the email.

Email BCC First Name String True True

First names of recipients in the BCC field.

Email BCC Last Name String True True

Last names of recipients in the BCC field.

Email BCC String True True

Raw header value representing BCC recipients of the email.

Email Bounce Error Detail Message String False True

Descriptive error message returned when the email bounced.

Email Bounce Error Detail Status Code Decimal False True

Status code returned with the email bounce error.

Email CC Address String True True

Email addresses of the CC recipients of the email.

Email CC First Name String True True

First names of recipients in the CC field.

Email CC Last Name String True True

Last names of recipients in the CC field.

Email CC String True True

Raw header value representing CC recipients of the email.

Email Direction String False True

Direction the email was sent in, such as inbound or outbound.

Encoded Email Associations Request String True True

Encoded string representing the email's association request payload.

Error Message String False True

Message describing any error that occurred during email sending.

Email Send Id String True True

Identifier of the email send event, used when sent through Facsimile.

Email From Address String True True

Email address of the sender.

Email From First Name String True True

First name of the sender.

Email From Last Name String True True

Last name of the sender.

Email From String True True

Raw header value representing the sender of the email.

Email Headers String False True

Raw header metadata including sender and recipient details.

Email body String False True

The content of the email message sent from a HubSpot record. Does not include replies from recipients.

Logged From String False True

Indicates the source from which the email was logged, such as Gmail, Outlook, or HubSpot CRM.

Media Processing Status String False True

Current processing status of media files, such as images or attachments, included in the email.

Email is member of forwarded subthread Bool False True

Indicates whether the email is part of a forwarded subthread in a conversation.

Message ID String False True

Unique message identifier for the email, used for threading and tracking.

EmailMigratedViaPortalDataMigration String False True

Shows whether the email was migrated from another portal using HubSpot's DataMigration tool.

Email pending inline image file IDs String False True

IDs of inline image files pending processing within the email body.

PostSend Status String False True

Summary of the final result after the email was sent, such as 'successful send', 'bounced', or 'dropped'.

RecipientDrop Reasons String False True

List of recipients who did not receive the email, along with reasons for dropping.

Email Send Event Id String False True

Unique ID of the email send event used for logging and tracking.

Email Send Event Id Created Datetime False True

Timestamp when the email send event ID was created.

Email Sender Address String True True

Email address of the actual sender of the message.

Email Sender First Name String True True

First name of the email's sender.

Email Sender Last Name String True True

Last name of the email's sender.

Email Sender String True True

Raw header value representing the sender of the email.

Sent Via String False True

Platform or method used to send the email, such as HubSpot, Gmail, or API.

Email send status String False True

Status indicating the delivery result of the email, such as sent, failed, or pending.

Email subject String False True

Subject line of the email, visible to recipients.

Text String False True

Plaintext version of the email body, without HTML formatting.

Thread ID String False True

ID representing the email thread or conversation this email is part of.

Email To Address String True True

Email addresses of the primary recipients.

Email To First Name String True True

First names of the recipients in the To field.

Email To Last Name String True True

Last names of the recipients in the To field.

Email To String True True

Raw header value representing the email's To field.

Tracker Key String False True

Unique key used to track engagement with the email, such as opens and clicks.

Validation Skipped String False True

Details if standard validations were skipped when logging this email.

Engagement Source String False True

System or tool that initiated or logged the email engagement.

Engagement Source ID String False True

Unique identifier of the process or system that created the email engagement.

Follow up action String False True

Recommended follow-up action for the email, such as replying or scheduling a meeting.

GDPR deleted Bool True True

Indicates whether the email body was deleted in response to a GDPR request.

Last modified date Datetime True True

Timestamp of the most recent update to the email engagement record.

Merged object IDs String True True

List of object IDs that were merged into this email engagement. Managed automatically by HubSpot.

Updated by String True True

User who last modified the email engagement.

Record ID Decimal True True

Unique HubSpot-assigned ID for the email engagement record. Automatically generated and unchangeable.

Product name String False True

Name of the product or service referenced or associated with the email engagement.

Queue Memberships String False True

List of queue identifiers where this email engagement is stored or categorized.

Read Only Object Bool True True

Indicates whether the record is read-only and cannot be edited by users or workflows.

Activity date Datetime False True

Date and time when the email activity occurred. Reflects the moment the email was logged or sent.

Unique creation key String True True

A unique identifier used to ensure idempotent email engagement creation and avoid duplicates.

Unique ID String False True

Secondary unique identifier for the email engagement, separate from the primary Record ID.

Updated by user ID Decimal True True

User ID of the last person to update the email engagement. Automatically assigned by HubSpot.

User IDs of all notification followers String True True

List of user IDs that are following this engagement for notification purposes.

User IDs of all notification unfollowers String True True

List of owner user IDs who have opted out of notifications for this engagement.

User IDs of all owners String True True

All owner user IDs associated with this engagement, including default and custom owners.

Owner Assigned Date Datetime True True

Timestamp when an owner was most recently assigned to this email engagement.

Activity assigned to String False True

User ID of the person assigned to this email activity. Can include HubSpot or Salesforce integration users.

HubSpot Team String True True

Team name or ID associated with the primary owner of this email engagement.

All owner ids String True True

All owner-related property values, including default and custom, associated with this engagement.

All team ids String True True

Team IDs corresponding to all assigned owners of this email engagement.

All accessible team ids String True True

Team IDs, including inherited ones from higher in the hierarchy, that have access to this engagement.

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