HubSpot · Schema

Note

Represents a note engagement in the CRM

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
id string The unique identifier for the note
properties object The note properties
propertiesWithHistory object Properties with their change history
createdAt string When the note was created
updatedAt string When the note was last updated
archived boolean Whether the note is archived
archivedAt string When the note was archived (if archived)
View JSON Schema on GitHub

JSON Schema

hubspot-engagement-notes-note-schema.json Raw ↑
{
  "type": "object",
  "description": "Represents a note engagement in the CRM",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for the note",
      "example": "1024"
    },
    "properties": {
      "type": "object",
      "description": "The note properties",
      "example": {
        "hs_note_body": "Met with client to discuss Q1 goals. They are interested in expanding their subscription.",
        "hs_timestamp": "2024-01-15T10:30:00.000Z",
        "hubspot_owner_id": "12345"
      }
    },
    "propertiesWithHistory": {
      "type": "object",
      "description": "Properties with their change history",
      "example": {
        "key": "value"
      }
    },
    "createdAt": {
      "type": "string",
      "description": "When the note was created",
      "format": "date-time",
      "example": "2024-01-15T10:30:00.000Z"
    },
    "updatedAt": {
      "type": "string",
      "description": "When the note was last updated",
      "format": "date-time",
      "example": "2024-01-15T11:00:00.000Z"
    },
    "archived": {
      "type": "boolean",
      "description": "Whether the note is archived",
      "example": false
    },
    "archivedAt": {
      "type": "string",
      "description": "When the note was archived (if archived)",
      "format": "date-time",
      "example": "2025-03-15T14:30:00Z"
    }
  },
  "required": [
    "id",
    "properties",
    "createdAt",
    "updatedAt",
    "archived"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Note"
}