HubSpot API Data Model
ConversationThreads |
Get threads.
Catalog: ConversationsInboxMessages3
Schema: Conversations
Label: {res:itgen_hubspot_conversationthreads_plural}
This is a read-only table function. The HubSpot API may not support changing the data or the Invantive UniversalSQL driver for HubSpot does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the HubSpot API.
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function ConversationThreads. 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 |
Default Value |
Documentation |
|---|---|---|---|---|
after |
string |
☐ |
|
The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. |
archived |
boolean |
☐ |
|
Whether to return only results that have been archived. |
associatedContactId |
int64 |
☐ |
|
The ID of a contact you can optionally include to retrieve a filtered list of conversations for. This parameter cannot be used in conjunction with the `inboxId` property. |
latestMessageTimestampAfter |
datetime |
☐ |
|
The minimum `latestMessageTimestamp`. This is required only when sorting by `latestMessageTimestamp`. |
property |
string |
☐ |
|
|
threadStatus |
string |
☐ |
|
The status of the associated conversations to filter by (either `OPEN` or `CLOSED`). This property must be provided if you’re including the `associatedContactId` query parameter. |
Columns of Table Function
The columns of the table function ConversationThreads are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
archived |
boolean |
Archived |
☐ |
Whether this thread is archived. |
assignedTo |
string |
{res:itgen_hubspot_assignedto} |
☐ |
|
associatedContactId |
string |
{res:itgen_hubspot_associatedcontactid} |
☐ |
The ID of the associated Contact in the CRM. |
closedAt |
datetime |
{res:itgen_hubspot_closedat} |
☐ |
When the thread was closed. Only set if the thread is closed. |
createdAt |
datetime |
Created at |
☐ |
When the thread was created. |
id |
string |
ID |
☐ |
The unique ID of the thread. |
inboxId |
string |
{res:itgen_hubspot_inboxid} |
☐ |
The ID of the conversations inbox containing the thread. |
latestMessageReceivedTimestamp |
datetime |
{res:itgen_hubspot_latestmessagereceivedtimestamp} |
☐ |
The time that the latest message was sent on the thread. |
latestMessageSentTimestamp |
datetime |
{res:itgen_hubspot_latestmessagesenttimestamp} |
☐ |
The time that the latest message was sent on the thread. |
latestMessageTimestamp |
datetime |
{res:itgen_hubspot_latestmessagetimestamp} |
☐ |
The time that the latest message was sent or received on the thread. |
originalChannelAccountId |
string |
{res:itgen_hubspot_originalchannelaccountid} |
☐ |
|
originalChannelId |
string |
{res:itgen_hubspot_originalchannelid} |
☐ |
|
spam |
boolean |
{res:itgen_hubspot_spam} |
☐ |
Whether the thread is marked as spam. |
status |
string |
Status |
☐ |
The thread's status: `OPEN` or `CLOSED`. |
threadAssociations_associatedTicketId |
string |
{res:itgen_hubspot_threadassociations_associatedticketid} |
☐ |
|
18-12-2024 20:09 Version 24.1.33-BETA+5180
