Qodex.ai

Conversations API Collections

Number of APIs: 32

The conversations APIs enable you to manage and interact with the conversations inbox, channels, and messages. For example, you can use these APIs to:

  • Get and sort conversations inboxes, channels, threads, and messages.

  • Update thread statuses.

  • Delete and restore threads.

  • Send outbound messages via existing conversations channels.

  • Send an internal comment to an agent.

  • Retrieve conversation data to create advanced reports and analytics in external tools.

You could also use these APIs to integrate existing channels with other apps such as Slack or Microsoft Teams to send replies or receive notifications.

To get started with the conversations APIs, make sure you have set up a HubSpot developer account and created an app. You will need a developer account ID and app ID to get access to these APIs.

Fork the collections using Run in Qodex:

Run In Qodex

  1. Conversations Inbox & Messages API-Conversations - Get conversations inboxes. GET {{baseUrl}}/conversations/v3/conversations/inboxes?after=<string>&limit=<integer>&sort=<string>&sort=<string>&defaultPageLength=<integer>

  2. Conversations Inbox & Messages API-Conversations - Get a single thread. GET {{baseUrl}}/conversations/v3/conversations/threads/:threadId?archived=<boolean>&property=<string>

  3. Conversations Inbox & Messages API-Conversations - Archives a thread. DELETE {{baseUrl}}/conversations/v3/conversations/threads/:threadId

  4. Conversations Inbox & Messages API-Conversations - Archives a thread. DELETE {{baseUrl}}/conversations/v3/conversations/threads/:threadId

  5. Conversations Inbox & Messages API-Conversations - Get message history for a thread. GET {{baseUrl}}/conversations/v3/conversations/threads/:threadId/messages?after=<string>&limit=<integer>&sort=<string>&sort=<string>&archived=<boolean>&property=<string>

  6. Conversations Inbox & Messages API-Conversations - Send a message to a thread. POST {{baseUrl}}/conversations/v3/conversations/threads/:threadId/messages

  7. Conversations Inbox & Messages API-Conversations - Get actors POST {{baseUrl}}/conversations/v3/conversations/actors/batch/read?property=<string>

  8. Conversations Inbox & Messages API-Conversations - Get channel accounts. GET {{baseUrl}}/conversations/v3/conversations/channel-accounts?channelId=<integer>&channelId=<integer>&inboxId=<integer>&inboxId=<integer>&after=<string>&limit=<integer>&sort=<string>&sort=<string>&defaultPageLength=<integer>

  9. Conversations Inbox & Messages API-Conversations - Get a single channel. GET {{baseUrl}}/conversations/v3/conversations/channels/:channelId

  10. Conversations Inbox & Messages API-Conversations - Get a single message. GET {{baseUrl}}/conversations/v3/conversations/threads/:threadId/messages/:messageId?property=<string>