HubSpot · JSON Structure

Hubspot Engagement Notes Batch Read Notes Request Structure

Request body for batch reading notes

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

BatchReadNotesRequest is a JSON Structure definition published by HubSpot, describing 4 properties, of which 1 is required. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

inputs properties propertiesWithHistory idProperty

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

JSON Structure

Raw ↑ 
{
  "type": "object",
  "description": "Request body for batch reading notes",
  "name": "BatchReadNotesRequest",
  "properties": {
    "inputs": {
      "type": "array",
      "description": "Array of note identifiers",
      "items": {
        "type": "object",
        "description": "Input for reading a single item in a batch",
        "properties": {
          "id": {
            "type": "string",
            "description": "The note identifier"
          }
        },
        "required": [
          "id"
        ]
      }
    },
    "properties": {
      "type": "array",
      "description": "Properties to return",
      "items": {
        "type": "string"
      }
    },
    "propertiesWithHistory": {
      "type": "array",
      "description": "Properties to return with history",
      "items": {
        "type": "string"
      }
    },
    "idProperty": {
      "type": "string",
      "description": "The property to use as the identifier"
    }
  },
  "required": [
    "inputs"
  ],
  "$schema": "https://json-structure.org/draft/2020-12/schema"
}