HubSpot · Schema

Actor

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

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name	Type	Description
id	string	Unique identifier for the actor
actorId	string	Actor ID reference
name	string	Display name of the actor
email	string	Email address of the actor
type	string	Type of actor (e.g., VISITOR, AGENT, BOT)

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-schema/conversations-api-actor-schema.json",
  "title": "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",
      "format": "email",
      "description": "Email address of the actor",
      "example": "[email protected]"
    },
    "type": {
      "type": "string",
      "description": "Type of actor (e.g., VISITOR, AGENT, BOT)",
      "example": "VISITOR"
    }
  },
  "required": [
    "id"
  ]
}