HubSpot Conversations API
Tools that enable LLMs to interact directly with the Hubspot Conversations API
1.0.0
HubspotConversationsApi enables seamless interactions with HubSpot's Conversations API, allowing for efficient management of conversation data. Developers can leverage this toolkit to execute various functionalities within HubSpot Conversations directly.
Capabilities
- Archive and manage conversation threads for data efficiency.
- Create and retrieve details about channel accounts and inboxes.
- Publish and manage custom channel messages.
- Access detailed message history and conversation participants.
- Update statuses and configurations for conversation threads and messages.
OAuth
- Provider: Unknown
- Scopes: conversations.custom_channels.read, conversations.custom_channels.write, conversations.read, conversations.write.
Secrets
- No secrets exist for this toolkit.
Available tools(24)
| Tool name | Description | Secrets | |
|---|---|---|---|
Archives a conversation thread, marking it for deletion.
Use this tool to archive a conversation thread, which will then be permanently deleted after 30 days. Ideal for managing conversational data efficiently by removing unnecessary threads. | |||
Create a new account for a specified communication channel.
This tool is used to create a new account within a specific communication channel using Hubspot. It enables multiple accounts to communicate over a single channel with different delivery identifiers. | |||
Retrieve details of a HubSpot channel account by ID.
Fetches detailed information about a specific HubSpot channel account using the channel account ID. Use this tool to obtain information about a channel account, such as its status and configuration. | |||
Retrieve accounts for a specified custom channel.
This tool is used to fetch a list of accounts associated with a specific custom channel in Hubspot Conversations, identified by the channel ID. | |||
Retrieve details for a specific message in a custom channel.
Use this tool to get the details of a specific message sent through a custom channel in Hubspot Conversations. Ideal for obtaining message content, sender information, and timestamps. | |||
Retrieve details of a conversation inbox by ID.
Use this tool to obtain detailed information about a specific conversation inbox by providing the inbox ID. | |||
Retrieve the message history for a specific thread.
This tool retrieves the message history for a given conversation thread by its ID. It should be used when you need to access past messages of a thread in Hubspot Conversations. | |||
Retrieve a list of conversation channels from Hubspot.
Use this tool to get a list of conversation channels from Hubspot, applying optional filters and sorting if needed. | |||
Retrieve a list of conversation inboxes.
This tool fetches a list of conversation inboxes, allowing for optional filters and sorting to customize the results. | |||
Publish a message to a custom channel on HubSpot.
This tool sends a message over a specified custom channel in HubSpot Conversations. Use this tool to communicate via custom-integrated messaging channels.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Resolve ActorIds to conversation participants.
Use this tool to retrieve detailed information about participants in a conversation given their ActorIds. Typically called when there's a need to understand who the participants in a conversation are by resolving their IDs. | |||
Retrieve details of a specific actor by actor ID.
Use this tool to get information about a specific actor within Hubspot Conversations by providing their actor ID. It should be called when actor-specific details are needed. | |||
Retrieve details for a specific channel account.
Use this tool to get detailed metadata about a channel account, including its channel, inbox ID, and delivery identifiers. Ideal for understanding the configuration and associations of a channel account in Hubspot. | |||
Retrieve a list of channel accounts from Hubspot.
This tool calls the Hubspot Conversations API to retrieve a list of channel accounts. It supports optional filters and sorting to refine the results. | |||
Retrieve details of a channel using its ID.
Use this tool to get comprehensive details about a specific channel in Hubspot Conversations by providing the channel ID. | |||
Retrieve conversation threads from Hubspot Conversations.
Use this tool to fetch a list of conversation threads from Hubspot Conversations. You can apply optional filters and sorting to tailor the results. | |||
Retrieve the original text and rich text of a HubSpot message.
Use this tool to access the full original content of a message within a conversation on HubSpot. Ideal for retrieving untruncated message details when the truncation status indicates it might be truncated. | |||
Retrieve detailed information about a conversation thread by ID.
Use this to access specific conversation threads and their details for a given thread ID. | |||
Retrieve a single message from a conversation thread.
Call this tool to get the details of a specific message within a conversation thread using the message ID. Useful for accessing conversation content for review or processing. | |||
Send a new message in a conversation thread.
Use this tool to send a new message on an existing conversation thread. Ideal for continuing discussions or replying within a thread.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Update channel account name and authorization status.
Use this tool to modify the name and authorization status of a channel account in Hubspot Conversations. This is useful for managing channel accounts, including disabling them by setting the isAuthorized flag to False. | |||
Update channel account staging token details for public apps.
This tool updates the account name and delivery identifier of a channel account staging token in Hubspot Conversations. Use it when you need to modify these details for a specific channel account created from a staging token. | |||
Update the status or restore a conversation thread.
This tool updates a single thread's status or restores it within Hubspot Conversations. Use it to change the status or restore a thread based on the thread ID provided. | |||
Update the status of a conversation message.
Use this tool to update the status of a message within a custom channel on Hubspot Conversations. It indicates whether a message was successfully sent, failed, or read. Additionally, for failed messages, you can include an error message for clarification. |
Selected tools
No tools selected.
Click "Show all tools" to add tools.
Requirements
Select tools to see requirements
HubspotConversationsApi.ArchiveConversationThread
Archives a conversation thread, marking it for deletion. Use this tool to archive a conversation thread, which will then be permanently deleted after 30 days. Ideal for managing conversational data efficiently by removing unnecessary threads.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
thread_identifier | string | Required | The unique identifier of the conversation thread to archive. This is a required field and should match the specific thread you wish to archive. |
Requirements
Output
json— Response from the API endpoint 'delete-/conversations/v3/conversations/threads/{threadId}'.HubspotConversationsApi.CreateChannelAccount
Create a new account for a specified communication channel. This tool is used to create a new account within a specific communication channel using Hubspot. It enables multiple accounts to communicate over a single channel with different delivery identifiers.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
account_name | string | Required | The name of the account to be created for the channel. It identifies the account within the specified communication channel. |
channel_id | string | Required | The unique identifier for the communication channel where the account will be created. This should be a string value. |
inbox_id | string | Required | The unique identifier for the inbox where the channel account will be created. This should be a string that corresponds to an existing inbox in Hubspot. |
is_authorized | boolean | Required | Boolean to indicate if the account should be authorized. Set to true for authorized accounts, false otherwise. |
delivery_identifier_type | string | Optional | Type of identifier: HS_EMAIL_ADDRESS, HS_PHONE_NUMBER, or CHANNEL_SPECIFIC_OPAQUE_ID. |
delivery_identifier_value | string | Optional | A string representation of the delivery identifier. Can be an E.164 phone number, an email address, or a channel-specific identifier. |
Requirements
Output
json— Response from the API endpoint 'post-/conversations/v3/custom-channels/{channelId}/channel-accounts'.HubspotConversationsApi.GetChannelAccountDetails
Retrieve details of a HubSpot channel account by ID. Fetches detailed information about a specific HubSpot channel account using the channel account ID. Use this tool to obtain information about a channel account, such as its status and configuration.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
channel_account_id | string | Required | The unique ID of the HubSpot channel account to retrieve details for. This ID is required to fetch the channel account's information. |
Requirements
Output
json— Response from the API endpoint 'get-/conversations/v3/conversations/channel-accounts/{channelAccountId}'.HubspotConversationsApi.GetCustomChannelAccounts
Retrieve accounts for a specified custom channel. This tool is used to fetch a list of accounts associated with a specific custom channel in Hubspot Conversations, identified by the channel ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
custom_channel_id | string | Required | The unique identifier of the custom channel to retrieve accounts for. Must be a valid string. |
Requirements
Output
json— Response from the API endpoint 'get-/conversations/v3/custom-channels/{channelId}/channel-accounts'.HubspotConversationsApi.GetCustomChannelMessageDetails
Retrieve details for a specific message in a custom channel. Use this tool to get the details of a specific message sent through a custom channel in Hubspot Conversations. Ideal for obtaining message content, sender information, and timestamps.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
channel_id | string | Required | The unique identifier for the custom channel from which the message was sent. Required to fetch specific message details. |
message_id | string | Required | The unique identifier of the message to retrieve details for. This ID is used to specify the exact message in the custom channel. |
Requirements
Output
json— Response from the API endpoint 'get-/conversations/v3/custom-channels/{channelId}/messages/{messageId}'.HubspotConversationsApi.GetInboxDetails
Retrieve details of a conversation inbox by ID. Use this tool to obtain detailed information about a specific conversation inbox by providing the inbox ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
inbox_id | string | Required | The unique identifier for the conversation inbox you wish to retrieve details for. It should be a string representing the inbox ID. |
Requirements
Output
json— Response from the API endpoint 'get-/conversations/v3/conversations/inboxes/{inboxId}'.HubspotConversationsApi.GetMessageHistoryForThread
Retrieve the message history for a specific thread. This tool retrieves the message history for a given conversation thread by its ID. It should be used when you need to access past messages of a thread in Hubspot Conversations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
thread_id | string | Required | The unique identifier for the conversation thread whose message history is to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'get-/conversations/v3/conversations/threads/{threadId}/messages'.HubspotConversationsApi.ListConversationChannels
Retrieve a list of conversation channels from Hubspot. Use this tool to get a list of conversation channels from Hubspot, applying optional filters and sorting if needed.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'get-/conversations/v3/conversations/channels'.HubspotConversationsApi.ListConversationInboxes
Retrieve a list of conversation inboxes. This tool fetches a list of conversation inboxes, allowing for optional filters and sorting to customize the results.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'get-/conversations/v3/conversations/inboxes'.HubspotConversationsApi.PublishCustomChannelMessage
Publish a message to a custom channel on HubSpot. This tool sends a message over a specified custom channel in HubSpot Conversations. Use this tool to communicate via custom-integrated messaging channels. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
custom_channel_id | string | Optional | The unique ID of the custom channel where the message will be published. Must be a string. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/conversations/v3/custom-channels/{channelId}/messages'.HubspotConversationsApi.ResolveConversationActors
Resolve ActorIds to conversation participants. Use this tool to retrieve detailed information about participants in a conversation given their ActorIds. Typically called when there's a need to understand who the participants in a conversation are by resolving their IDs.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
actor_ids | array<string> | Required | A list of Actor IDs to resolve into detailed participant information. Each entry should be a string representing an Actor ID. |
Requirements
Output
json— Response from the API endpoint 'post-/conversations/v3/conversations/actors/batch/read'.HubspotConversationsApi.RetrieveActorDetails
Retrieve details of a specific actor by actor ID. Use this tool to get information about a specific actor within Hubspot Conversations by providing their actor ID. It should be called when actor-specific details are needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
actor_id | string | Required | The unique identifier for the actor whose details are to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'get-/conversations/v3/conversations/actors/{actorId}'.HubspotConversationsApi.RetrieveChannelAccountDetails
Retrieve details for a specific channel account. Use this tool to get detailed metadata about a channel account, including its channel, inbox ID, and delivery identifiers. Ideal for understanding the configuration and associations of a channel account in Hubspot.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
channel_account_id | string | Required | Unique identifier for the specific channel account to retrieve details about. Provided as a string. |
channel_identifier | string | Required | The unique identifier for the channel. Used to specify which channel's account details to retrieve. |
Requirements
Output
json— Response from the API endpoint 'get-/conversations/v3/custom-channels/{channelId}/channel-accounts/{channelAccountId}'.HubspotConversationsApi.RetrieveChannelAccounts
Retrieve a list of channel accounts from Hubspot. This tool calls the Hubspot Conversations API to retrieve a list of channel accounts. It supports optional filters and sorting to refine the results.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'get-/conversations/v3/conversations/channel-accounts'.HubspotConversationsApi.RetrieveChannelDetails
Retrieve details of a channel using its ID. Use this tool to get comprehensive details about a specific channel in Hubspot Conversations by providing the channel ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
channel_id | string | Required | The unique ID of the channel to retrieve details for in Hubspot Conversations. |
Requirements
Output
json— Response from the API endpoint 'get-/conversations/v3/conversations/channels/{channelId}'.HubspotConversationsApi.RetrieveConversationThreads
Retrieve conversation threads from Hubspot Conversations. Use this tool to fetch a list of conversation threads from Hubspot Conversations. You can apply optional filters and sorting to tailor the results.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'get-/conversations/v3/conversations/threads'.HubspotConversationsApi.RetrieveFullMessageContent
Retrieve the original text and rich text of a HubSpot message. Use this tool to access the full original content of a message within a conversation on HubSpot. Ideal for retrieving untruncated message details when the truncation status indicates it might be truncated.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
conversation_thread_id | string | Required | The unique identifier for the conversation thread containing the message. |
message_id | string | Required | The unique identifier for the message. Used to retrieve the message's full original content. |
Requirements
Output
json— Response from the API endpoint 'get-/conversations/v3/conversations/threads/{threadId}/messages/{messageId}/original-content'.HubspotConversationsApi.RetrieveThreadById
Retrieve detailed information about a conversation thread by ID. Use this to access specific conversation threads and their details for a given thread ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
conversation_thread_id | string | Required | The unique identifier for the conversation thread you wish to retrieve. Provide the specific thread ID to access its details. |
Requirements
Output
json— Response from the API endpoint 'get-/conversations/v3/conversations/threads/{threadId}'.HubspotConversationsApi.RetrieveThreadMessage
Retrieve a single message from a conversation thread. Call this tool to get the details of a specific message within a conversation thread using the message ID. Useful for accessing conversation content for review or processing.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
message_id | string | Required | The unique identifier for the specific message within a thread. Used to retrieve message details. |
thread_id | string | Required | The unique identifier of the conversation thread from which to retrieve the message. |
Requirements
Output
json— Response from the API endpoint 'get-/conversations/v3/conversations/threads/{threadId}/messages/{messageId}'.HubspotConversationsApi.SendConversationMessage
Send a new message in a conversation thread. Use this tool to send a new message on an existing conversation thread. Ideal for continuing discussions or replying within a thread. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
thread_id | string | Optional | The unique identifier for the conversation thread where the message will be sent. It should be a string that corresponds to the existing thread ID in Hubspot. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/conversations/v3/conversations/threads/{threadId}/messages'.HubspotConversationsApi.UpdateChannelAccountInfo
Update channel account name and authorization status. Use this tool to modify the name and authorization status of a channel account in Hubspot Conversations. This is useful for managing channel accounts, including disabling them by setting the isAuthorized flag to False.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
channel_account_id | string | Required | The unique identifier for the channel account to be updated. It is required for specifying which channel account to modify. |
channel_id | string | Required | The unique identifier for the channel in Hubspot Conversations. Required to specify which channel account to update. |
channel_account_name | string | Optional | The new name for the channel account. This updates the display name associated with the account. |
set_authorization_status | boolean | Optional | Boolean value to update the channel account's authorization. Set to False to disable the account. |
Requirements
Output
json— Response from the API endpoint 'patch-/conversations/v3/custom-channels/{channelId}/channel-accounts/{channelAccountId}'.HubspotConversationsApi.UpdateChannelAccountStaging
Update channel account staging token details for public apps. This tool updates the account name and delivery identifier of a channel account staging token in Hubspot Conversations. Use it when you need to modify these details for a specific channel account created from a staging token.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
account_name | string | Required | The name of the account to be updated for the channel account staging token. |
account_token | string | Required | The unique token identifying the specific channel account staging. Required for updating account details. |
channel_id | string | Required | The unique identifier for the channel to update. This is necessary to specify which channel's staging token details are being modified. |
delivery_identifier_type | string | Required | Type of delivery identifier: HS_EMAIL_ADDRESS, HS_PHONE_NUMBER, or CHANNEL_SPECIFIC_OPAQUE_ID. |
delivery_identifier_value | string | Required | The PublicDeliveryIdentifier in string format, such as an E.164 phone number, an email address, or a channel-specific identifier. |
Requirements
Output
json— Response from the API endpoint 'patch-/conversations/v3/custom-channels/{channelId}/channel-account-staging-tokens/{accountToken}'.HubspotConversationsApi.UpdateConversationThread
Update the status or restore a conversation thread. This tool updates a single thread's status or restores it within Hubspot Conversations. Use it to change the status or restore a thread based on the thread ID provided.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
thread_identifier | string | Required | The unique identifier for the conversation thread to update or restore. |
is_thread_archived | boolean | Optional | Set to true to archive or false to restore the thread. Determines if the thread is currently archived. |
thread_status | string | Optional | Set the thread's status to `OPEN` or `CLOSED`. |
Requirements
Output
json— Response from the API endpoint 'patch-/conversations/v3/conversations/threads/{threadId}'.HubspotConversationsApi.UpdateMessageStatus
Update the status of a conversation message. Use this tool to update the status of a message within a custom channel on Hubspot Conversations. It indicates whether a message was successfully sent, failed, or read. Additionally, for failed messages, you can include an error message for clarification.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
channel_identifier | string | Required | The unique identifier for the custom channel where the message is located. It is required to specify which channel the message belongs to. |
message_id | string | Required | Unique identifier of the message to be updated. |
message_status | string | Required | Specifies the status of the message. Valid values are SENT, FAILED, and READ. |
error_message_for_failed_status | string | Optional | Provide an error message when the status is FAILED to clarify the reason for failure. Only use this when 'statusType' is 'FAILED'. |
Requirements
Output
json— Response from the API endpoint 'patch-/conversations/v3/custom-channels/{channelId}/messages/{messageId}'.