HubSpot · Schema

Message

Represents a message within a conversation thread.

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationSales

Properties

Name	Type	Description
id	string	Unique identifier for the message
type	string	Type of message
text	string	Plain text content of the message
richText	string	Rich text (HTML) content of the message
direction	string	Direction of the message (incoming or outgoing)
channelId	string	ID of the communication channel
channelAccountId	string	ID of the channel account
senders	array	List of message senders
recipients	array	List of message recipients
status	object	Delivery status information for a message
createdAt	string	ISO 8601 timestamp when the message was created
truncationStatus	string	Whether the message was truncated
attachments	array	Message attachments

View JSON Schema on GitHub

JSON Schema

{
  "type": "object",
  "description": "Represents a message within a conversation thread.",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the message",
      "example": "msg_123456"
    },
    "type": {
      "type": "string",
      "description": "Type of message",
      "example": "MESSAGE",
      "enum": [
        "MESSAGE",
        "COMMENT",
        "WELCOME_MESSAGE"
      ]
    },
    "text": {
      "type": "string",
      "description": "Plain text content of the message",
      "example": "Hello, I need help with my order."
    },
    "richText": {
      "type": "string",
      "description": "Rich text (HTML) content of the message",
      "example": "<p>Hello, I need help with my order.</p>"
    },
    "direction": {
      "type": "string",
      "description": "Direction of the message (incoming or outgoing)",
      "example": "INCOMING",
      "enum": [
        "INCOMING",
        "OUTGOING"
      ]
    },
    "channelId": {
      "type": "string",
      "description": "ID of the communication channel",
      "example": "channel_789"
    },
    "channelAccountId": {
      "type": "string",
      "description": "ID of the channel account",
      "example": "account_123"
    },
    "senders": {
      "type": "array",
      "description": "List of message senders",
      "example": [
        {
          "id": "actor_101",
          "actorId": "actor_101",
          "name": "John Customer",
          "email": "john@example.com",
          "type": "VISITOR"
        }
      ],
      "items": {
        "type": "object",
        "description": "Represents a participant in a conversation (visitor, agent, or bot).",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the actor",
            "example": "actor_101"
          },
          "actorId": {
            "type": "string",
            "description": "Actor ID reference",
            "example": "actor_101"
          },
          "name": {
            "type": "string",
            "description": "Display name of the actor",
            "example": "John Customer"
          },
          "email": {
            "type": "string",
            "description": "Email address of the actor",
            "format": "email",
            "example": "john@example.com"
          },
          "type": {
            "type": "string",
            "description": "Type of actor (e.g., VISITOR, AGENT, BOT)",
            "example": "VISITOR"
          }
        },
        "required": [
          "id"
        ]
      }
    },
    "recipients": {
      "type": "array",
      "description": "List of message recipients",
      "example": [
        {
          "id": "actor_101",
          "actorId": "actor_101",
          "name": "John Customer",
          "email": "john@example.com",
          "type": "VISITOR"
        }
      ],
      "items": {
        "type": "object",
        "description": "Represents a participant in a conversation (visitor, agent, or bot).",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the actor",
            "example": "actor_101"
          },
          "actorId": {
            "type": "string",
            "description": "Actor ID reference",
            "example": "actor_101"
          },
          "name": {
            "type": "string",
            "description": "Display name of the actor",
            "example": "John Customer"
          },
          "email": {
            "type": "string",
            "description": "Email address of the actor",
            "format": "email",
            "example": "john@example.com"
          },
          "type": {
            "type": "string",
            "description": "Type of actor (e.g., VISITOR, AGENT, BOT)",
            "example": "VISITOR"
          }
        },
        "required": [
          "id"
        ]
      }
    },
    "status": {
      "type": "object",
      "description": "Delivery status information for a message",
      "properties": {
        "statusType": {
          "type": "string",
          "description": "Current delivery status type",
          "example": "DELIVERED",
          "enum": [
            "SENT",
            "DELIVERED",
            "READ",
            "FAILED"
          ]
        }
      }
    },
    "createdAt": {
      "type": "string",
      "description": "ISO 8601 timestamp when the message was created",
      "format": "date-time",
      "example": "2024-01-20T10:30:00Z"
    },
    "truncationStatus": {
      "type": "string",
      "description": "Whether the message was truncated",
      "example": "NOT_TRUNCATED"
    },
    "attachments": {
      "type": "array",
      "description": "Message attachments",
      "example": [
        {
          "id": "attach_001",
          "type": "application/pdf",
          "url": "https://api.hubapi.com/files/v3/files/attach_001",
          "filename": "invoice.pdf",
          "size": 102400
        }
      ],
      "items": {
        "type": "object",
        "description": "Represents a file attachment on a message.",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the attachment",
            "example": "attach_001"
          },
          "type": {
            "type": "string",
            "description": "MIME type of the attachment",
            "example": "application/pdf"
          },
          "url": {
            "type": "string",
            "description": "URL to access the attachment",
            "format": "uri",
            "example": "https://api.hubapi.com/files/v3/files/attach_001"
          },
          "filename": {
            "type": "string",
            "description": "Original filename",
            "example": "invoice.pdf"
          },
          "size": {
            "type": "integer",
            "description": "File size in bytes",
            "example": 102400
          }
        }
      }
    }
  },
  "required": [
    "id",
    "type",
    "createdAt"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Message"
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/hubspot-conversations-message"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.