HubSpot · JSON Structure

Conversations Api Channel Structure

Represents a communication channel for conversations.

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

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

Properties

id name type accountId createdAt

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-channel-structure.json",
  "name": "Channel",
  "description": "Represents a communication channel for conversations.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the channel",
      "example": "channel_789"
    },
    "name": {
      "type": "string",
      "description": "Display name of the channel",
      "example": "Website Chat"
    },
    "type": {
      "type": "string",
      "description": "Type of channel (e.g., EMAIL, CHAT, FACEBOOK)",
      "example": "CHAT"
    },
    "accountId": {
      "type": "string",
      "description": "Associated account ID",
      "example": "account_123"
    },
    "createdAt": {
      "type": "datetime",
      "description": "ISO 8601 timestamp when the channel was created",
      "example": "2024-01-01T00:00:00Z"
    }
  },
  "required": [
    "id",
    "name",
    "type"
  ]
}