Cmdlets for HubSpot

Build 24.0.9060

EngagementsTasks

Retrieve the available Tasks in HubSpot.

SELECT

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

SELECT * FROM EngagementsTasks WHERE ID = '11896356808'

INSERT


INSERT INTO EngagementsTasks ([Task title], [Task notes], [Task status], [Task type], [Activity date])
VALUES ('Test Task Title', 'Body of the task', 'IN_PROGRESS', 'LINKED_IN_MESSAGE', current_timestamp())

UPDATE


UPDATE EngagementsTasks SET [Task notes] = 'Updated Task body test', [Task status] = 'COMPLETED' WHERE ID = '11896363224'

DELETE


DELETE FROM EngagementsTasks WHERE ID = '11896363224'

Columns

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

Unique identifier of the object.

Archived Bool True False

Whether the object is archived or not.

CreatedAt Datetime True False

When the object was created.

UpdatedAt Datetime True False

When the object was last updated.

Business units String False True

The business units this record is assigned to.

AtMentioned Owner Ids String False True

The owners that have been at_mentioned on the engagement

Attached file IDs String False True

The IDs of the files that are attached to the engagement

Notes _preview_ String True True

A plain_text preview of the notes field on a task

HTML Body Preview String True True

The HTML representation of the engagement body preview

Body Preview Truncated Bool True True

Indicates if the engagement body was truncated for the preview

Calendar Event ID String True True

The event ID for the synced task.

Created by Decimal True True

The user who created the engagement

Created by user ID Decimal True True

The user that created this object. This value is automatically set by HubSpot and may not be modified.

Created at Datetime True True

The date that an engagement was created

Source String False True

The source that created this engagement

Source ID String False True

The specific ID of the process that created this engagement

Follow up action String False True

What action should be performed during follow up

GDPR deleted Bool True True

Indicates the body of this engagement has been cleared because of a GDPR delete request

Last modified at Datetime True True

The date any property on this engagement was modified

Merged object IDs String True True

The list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.

Last modified by Decimal True True

The user who last updated the engagement

MS Teams message ID String True True

The message ID for the created task.

Associated Companies Decimal True True

The number of companies associated with this task

Associated Contacts Decimal True True

The number of contacts associated with this task

Associated Deals Decimal True True

The number of deals associated with this task

Associated Queue Objects Decimal True True

The number of objects associated with this task that support task queues

Associated Tickets Decimal True True

The number of tickets associated with this task

Record ID Decimal True True

The unique ID for this record. This value is automatically set by HubSpot and may not be modified.

Product name String False True

The name of the product associated with this engagement

Queue String False True

The list of queues that contain this engagement

Read Only Object Bool True True

Is the object read only

Task repeat status String True True

Indicates whether the task is currently repeating

Scheduled tasks String True True

Notes String False True

The content in the notes field on a task

Completed at Datetime True True

The date that the task was completed

Contact Time Zone String True True

The time zone of the associated contact

For Object Type String False True

The object type for the task

Task is all day Bool False True

Determines if the task is due all day or at a specific time

Last contacted Datetime True True

The last time a call_ email_ or meeting was logged for the associated contact. This is set automatically by HubSpot based on user actions in the contact record

Last engagement Datetime True True

The date of the last sales activity with the associated contact. This is set automatically by HubSpot based on user actions in the contact record

Priority String False True

The priority of the task

Task probability to complete Decimal True True

The probability the task will be completed

Relative Task Reminders String False True

The dates _relative to the due date_ when reminders will be sent

Reminder String False True

The dates when reminders will be sent

Interval String True True

How often the task should repeat

Send Default Reminder Bool False True

Whether or not a reminder should be sent when the task is due

Sequence Enrollment Is Active Bool True True

Whether the sequence enrollment this task is a part of is currently active

Sequence step enrollment Id String True True

The id of the sequence step that created the task

Sequence step number Decimal True True

The order of this task in the sequence at time of enrollment

Task Status String False True

The status of the task

Task Title String False True

The subject text for the task

Task template id Decimal True True

The id of template the task was created from

Task Type String False True

The type of task

Due date Datetime False True

The date that an engagement occurred

Unique creation key String True True

Unique property used for idempotent creates

Unique ID String False True

The unique ID of the engagement

Updated by user ID Decimal True True

The user that last updated this object. This value is automatically set by HubSpot and may not be modified.

User IDs of all notification followers String True True

The user IDs of all users that have clicked follow within the object to opt_in to getting follow notifications

User IDs of all notification unfollowers String True True

The user IDs of all object owners that have clicked unfollow within the object to opt_out of getting follow notifications

User IDs of all owners String True True

The user IDs of all owners of this object

Owner Assigned Date Datetime True True

The timestamp when an owner was assigned to this engagement

Assigned to String False True

The user that the activity is assigned to in HubSpot. This can be any HubSpot user or Salesforce integration user_ and can be set manually or via Workflows.

HubSpot Team String True True

The team of the owner of an engagement.

All owner ids String True True

The value of all owner referencing properties for this object_ both default and custom

All team ids String True True

The team ids corresponding to all owner referencing properties for this object_ both default and custom

All accessible team ids String True True

The team ids_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060