Cmdlets for HubSpot

Build 24.0.9060

EngagementsCalls

Retrieve the available Calls in HubSpot.

SELECT

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

SELECT * FROM EngagementsCalls WHERE ID = '11896247257'

INSERT


INSERT INTO EngagementsCalls ([Call Title], [Call notes], [Call duration], [From Number], [To Number], [Recording URL], [Call status], [Activity date])
VALUES ('CallEngagement Title', 'CallEngagement Body', '60', '123-456-7890', '789-123-4560', 'https://www.cdata.com', 'CALLING_CRM_USER', current_timestamp() )

UPDATE


UPDATE EngagementsCalls SET [Call status] = 'COMPLETED' WHERE ID = '11896247257'

DELETE


DELETE FROM EngagementsCalls WHERE ID = '11896247257'

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.

Call and meeting type String False True

The activity type of the engagement

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

Call notes preview String True True

A truncated preview of the call notes

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

Integrating App ID Decimal False True

The App ID associated with the integrating app

Authenticated recording files url provider String True True

URL which returns Authenticated audio_video URL of the recording

Call notes String False True

The body of the call

Callee object id Decimal False True

The id of the callee

Callee object type String False True

The type of callee

Call direction String False True

The direction of a call

Call outcome String False True

The outcome of the call

Call duration Decimal False True

The duration of the call_ in milliseconds

External Account ID String False True

External Account ID

External ID String False True

The external ID of the call

From Number String False True

The phone number of the person that initiated the call

From Number Name String True True

The name of the phone number that initiated the call

Transcript Available Bool False True

Flag to indicate if the call has an associated transcript

Voicemail Available String True True

Flag to indicate if the call has an associated voicemail

Recording URL String False True

The URL of the recorded call audio

Call Source String False True

The source of the call to differentiate VoIP vs Video Conferencing Apps

Call status String False True

The status of the call

Call Title String False True

The title of the call

To Number String False True

The phone number of the person that was called

To Number Name String True True

The name of the phone number that was called

Tracked terms String True True

A list of any tracked terms contained in the call transcript

Call transcription id Decimal False True

The id of the transcription

Video url String False True

Video URL of the recording

Unique Zoom Meeting ID String False True

The Zoom meeting unique identifier of the call

Calls Service Call ID Decimal True True

The Calls Service specific global unique identifier for a call

Activity 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.

Create date Datetime True True

The date that an engagement was created

Engagement Source String False True

The source that created this engagement

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 date 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.

Updated by Decimal True True

The user who last updated the engagement

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 Memberships String False True

The list of queues that contain this engagement

Read Only Object Bool True True

Is the object read only

Activity 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

Unknown Visitor Conversation Bool False True

Whether or not this communication was made with an unknown visitor

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

Activity 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