HubSpot · JSON Structure

Conversations Api Send Message Request Structure

Request payload for sending a message to a thread.

Type: object Properties: 7 Required: 3
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

SendMessageRequest is a JSON Structure definition published by HubSpot, describing 7 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

type text richText senderActorId channelId channelAccountId recipients

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-structure/conversations-api-send-message-request-structure.json",
  "name": "SendMessageRequest",
  "description": "Request payload for sending a message to a thread.",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "MESSAGE",
        "COMMENT"
      ],
      "description": "Type of message to send",
      "example": "MESSAGE"
    },
    "text": {
      "type": "string",
      "description": "Plain text content of the message",
      "example": "Thank you for reaching out. How can I help you today?"
    },
    "richText": {
      "type": "string",
      "description": "Rich text (HTML) content",
      "example": "<p>Thank you for reaching out. How can I help you today?</p>"
    },
    "senderActorId": {
      "type": "string",
      "description": "Actor ID of the sender",
      "example": "actor_agent_123"
    },
    "channelId": {
      "type": "string",
      "description": "Channel to send on",
      "example": "channel_789"
    },
    "channelAccountId": {
      "type": "string",
      "description": "Channel account to use",
      "example": "account_123"
    },
    "recipients": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "Recipient information for a message.",
        "properties": {
          "actorId": {
            "type": "string",
            "description": "Actor ID of the recipient",
            "example": "actor_101"
          }
        }
      },
      "description": "Message recipients",
      "example": [
        {
          "actorId": "actor_101"
        }
      ]
    }
  },
  "required": [
    "type",
    "text",
    "senderActorId"
  ]
}