HubSpot API Data Model
ConversationChannelAccountById |
Get a single channel account.
Catalog: ConversationsInboxMessages3
Schema: Conversations
Label: {res:itgen_hubspot_conversationchannelaccountbyid_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 ConversationChannelAccountById. 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 |
|---|---|---|---|---|
archived |
boolean |
☐ |
|
|
channelAccountId |
int64 |
☑ |
|
The unique ID of the channel account. |
Columns of Table Function
The columns of the table function ConversationChannelAccountById are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
active |
boolean |
Active |
☐ |
Whether the channel account is turned on. |
archived |
boolean |
Archived |
☐ |
|
archivedAt |
datetime |
Archived at |
☐ |
|
authorized |
boolean |
{res:itgen_hubspot_authorized} |
☐ |
|
channelId |
string |
{res:itgen_hubspot_channelid} |
☐ |
The ID of the channel that the channel account is an instance of. |
createdAt |
datetime |
Created at |
☐ |
|
deliveryIdentifier_type |
string |
{res:itgen_hubspot_deliveryidentifier_type} |
☐ |
The type of identifier. HS_EMAIL_ADDRESS for email addresses; HS_PHONE_NUMBER for a phone number; CHANNEL_SPECIFIC_OPAQUE_ID for channels that use their own proprietary identifiers, like Facebook Messenger or LiveChat. |
deliveryIdentifier_value |
string |
{res:itgen_hubspot_deliveryidentifier_value} |
☐ |
A string representation of the PublicDeliveryIdentifier, either an an E.164 phone number, an email address, or a channel-specific identifier. |
id |
string |
ID |
☐ |
The ID of the channel account. |
inboxId |
string |
{res:itgen_hubspot_inboxid} |
☐ |
The ID of the conversations inbox that contains the channel account. |
name |
string |
Name |
☐ |
The name of the channel account. |
18-12-2024 20:09 Version 24.1.33-BETA+5180
