HubSpot · JSON Structure

Hubspot Conversations 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/draft/2020-12/schema meta-schema.

Properties

type text richText senderActorId channelId channelAccountId recipients

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

Raw ↑ 
{
  "type": "object",
  "description": "Request payload for sending a message to a thread.",
  "name": "SendMessageRequest",
  "properties": {
    "type": {
      "type": "string",
      "description": "Type of message to send",
      "enum": [
        "MESSAGE",
        "COMMENT"
      ]
    },
    "text": {
      "type": "string",
      "description": "Plain text content of the message"
    },
    "richText": {
      "type": "string",
      "description": "Rich text (HTML) content"
    },
    "senderActorId": {
      "type": "string",
      "description": "Actor ID of the sender"
    },
    "channelId": {
      "type": "string",
      "description": "Channel to send on"
    },
    "channelAccountId": {
      "type": "string",
      "description": "Channel account to use"
    },
    "recipients": {
      "type": "array",
      "description": "Message recipients",
      "items": {
        "type": "object",
        "description": "Recipient information for a message.",
        "properties": {
          "actorId": {
            "type": "string",
            "description": "Actor ID of the recipient"
          }
        }
      }
    }
  },
  "required": [
    "type",
    "text",
    "senderActorId"
  ],
  "$schema": "https://json-structure.org/draft/2020-12/schema"
}