HubSpot · JSON Structure

Conversations Api Actor Structure

Represents a participant in a conversation (visitor, agent, or bot).

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

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

Properties

id actorId name email type

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-actor-structure.json",
  "name": "Actor",
  "description": "Represents a participant in a conversation (visitor, agent, or bot).",
  "type": "object",
  "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",
      "example": "john@example.com"
    },
    "type": {
      "type": "string",
      "description": "Type of actor (e.g., VISITOR, AGENT, BOT)",
      "example": "VISITOR"
    }
  },
  "required": [
    "id"
  ]
}