Zum Hauptinhalt springen
GET
/
conversations
/
v3
/
conversations
/
threads
/
{threadId}
Get a single thread
curl --request GET \
  --url https://api.hubapi.com/conversations/v3/conversations/threads/{threadId} \
  --header 'Authorization: Bearer <token>'
{
  "associatedContactId": "<string>",
  "threadAssociations": {
    "associatedTicketId": "<string>"
  },
  "assignedTo": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "archived": true,
  "originalChannelId": "<string>",
  "latestMessageTimestamp": "2023-11-07T05:31:56Z",
  "latestMessageSentTimestamp": "2023-11-07T05:31:56Z",
  "originalChannelAccountId": "<string>",
  "id": "<string>",
  "closedAt": "2023-11-07T05:31:56Z",
  "spam": true,
  "inboxId": "<string>",
  "status": "OPEN",
  "latestMessageReceivedTimestamp": "2023-11-07T05:31:56Z"
}

Produits pris en charge

Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing Hub -Gratuit
Sales HubSales Hub -Gratuit
Service HubService Hub -Gratuit
Content HubContent Hub -Gratuit
Cette API requiert l'une des portées suivantes :
conversations.read

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

threadId
integer
required

The unique ID of the thread.

Query Parameters

archived
boolean

Whether to return only results that have been archived. Default is false.

association
enum<string>[]

You can specify an association type here of TICKET. If this is set the response will included a thread associations object and associated ticket id if present. If there are no associations to a ticket with this conversation, then the thread associations object will not be present on the response.

property
string

A specific property to include in the thread response.

Response

successful operation

associatedContactId
string
required

The ID of the associated Contact in the CRM. If the Contact for the thread has not yet been added or created, the associatedContactId returned will be a visitorID and cannot be used to search for the Contact in the CRM.

createdAt
string<date-time>
required

When the thread was created.

archived
boolean
required

Whether this thread is archived.

originalChannelId
string
required
originalChannelAccountId
string
required
id
string
required

The unique ID of the thread.

spam
boolean
required

Whether the thread is marked as spam.

inboxId
string
required

The ID of the conversations inbox containing the thread.

status
enum<string>
required

The thread's status: OPEN or CLOSED.

Verfügbare Optionen:
OPEN,
CLOSED
threadAssociations
object
assignedTo
string
latestMessageTimestamp
string<date-time>

The time that the latest message was sent or received on the thread.

latestMessageSentTimestamp
string<date-time>

The time that the latest message was sent on the thread.

closedAt
string<date-time>

When the thread was closed. Only set if the thread is closed.

latestMessageReceivedTimestamp
string<date-time>

The time that the latest message was sent on the thread.