HubSpot · JSON Structure

Engagement Notes Batch Create Notes Request Structure

Request body for batch creating notes

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

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

Properties

inputs

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/engagement-notes-batch-create-notes-request-structure.json",
  "name": "BatchCreateNotesRequest",
  "description": "Request body for batch creating notes",
  "type": "object",
  "properties": {
    "inputs": {
      "type": "array",
      "description": "Array of notes to create",
      "items": {
        "type": "object",
        "description": "Request body for creating a note",
        "required": [
          "properties"
        ],
        "properties": {
          "properties": {
            "type": "object",
            "description": "The note properties to set",
            "additionalProperties": {
              "type": "string"
            },
            "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"
            }
          },
          "associations": {
            "type": "array",
            "description": "Associations to create with other objects",
            "items": {
              "$ref": "#/components/schemas/AssociationInput"
            },
            "example": [
              {
                "to": {
                  "id": {}
                },
                "types": [
                  {}
                ]
              }
            ]
          }
        }
      },
      "maxItems": 100,
      "example": [
        {
          "properties": {
            "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"
          },
          "associations": [
            {
              "to": {
                "id": {}
              },
              "types": [
                {}
              ]
            }
          ]
        }
      ]
    }
  },
  "required": [
    "inputs"
  ]
}