HubSpot · Schema

Thread

Represents a conversation thread containing messages between participants.

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
id string Unique identifier for the thread
inboxId string ID of the inbox containing this thread
status string Current status of the thread
spam boolean Whether the thread is marked as spam
associatedContactId string ID of the associated CRM contact
assignedTo string User ID the thread is assigned to
originalChannelId string ID of the original communication channel
originalChannelAccountId string ID of the original channel account
latestMessageTimestamp string ISO 8601 timestamp of the latest message
latestMessageSentTimestamp string ISO 8601 timestamp of the latest sent message
latestMessageReceivedTimestamp string ISO 8601 timestamp of the latest received message
closedAt string ISO 8601 timestamp when the thread was closed
createdAt string ISO 8601 timestamp when the thread was created
archived boolean Whether the thread is archived
View JSON Schema on GitHub

JSON Schema

conversations-api-thread-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-schema/conversations-api-thread-schema.json",
  "title": "Thread",
  "description": "Represents a conversation thread containing messages between participants.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the thread",
      "example": "987654321"
    },
    "inboxId": {
      "type": "string",
      "description": "ID of the inbox containing this thread",
      "example": "12345678"
    },
    "status": {
      "type": "string",
      "enum": [
        "OPEN",
        "CLOSED"
      ],
      "description": "Current status of the thread",
      "example": "OPEN"
    },
    "spam": {
      "type": "boolean",
      "description": "Whether the thread is marked as spam",
      "example": false
    },
    "associatedContactId": {
      "type": "string",
      "description": "ID of the associated CRM contact",
      "example": "101"
    },
    "assignedTo": {
      "type": "string",
      "description": "User ID the thread is assigned to",
      "example": "user_456"
    },
    "originalChannelId": {
      "type": "string",
      "description": "ID of the original communication channel",
      "example": "channel_789"
    },
    "originalChannelAccountId": {
      "type": "string",
      "description": "ID of the original channel account",
      "example": "account_123"
    },
    "latestMessageTimestamp": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp of the latest message",
      "example": "2024-01-20T10:30:00Z"
    },
    "latestMessageSentTimestamp": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp of the latest sent message",
      "example": "2024-01-20T10:25:00Z"
    },
    "latestMessageReceivedTimestamp": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp of the latest received message",
      "example": "2024-01-20T10:30:00Z"
    },
    "closedAt": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when the thread was closed",
      "example": "2024-01-21T15:00:00Z"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when the thread was created",
      "example": "2024-01-15T09:00:00Z"
    },
    "archived": {
      "type": "boolean",
      "description": "Whether the thread is archived",
      "example": false
    }
  },
  "required": [
    "id",
    "inboxId",
    "status",
    "createdAt"
  ]
}