HubSpot · Schema

BatchCreateNotesRequest

Request body for batch creating notes

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
inputs array Array of notes to create
View JSON Schema on GitHub

JSON Schema

hubspot-engagement-notes-batch-create-notes-request-schema.json Raw ↑
{
  "type": "object",
  "description": "Request body for batch creating notes",
  "properties": {
    "inputs": {
      "type": "array",
      "description": "Array of notes to create",
      "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": [
                {}
              ]
            }
          ]
        }
      ],
      "items": {
        "type": "object",
        "description": "Request body for creating a note",
        "properties": {
          "properties": {
            "type": "object",
            "description": "The note properties to set",
            "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",
            "example": [
              {
                "to": {
                  "id": {}
                },
                "types": [
                  {}
                ]
              }
            ],
            "items": {
              "type": "object",
              "description": "Association to create with another object",
              "properties": {
                "to": {
                  "type": "object",
                  "example": {
                    "id": "101"
                  },
                  "properties": {
                    "id": {
                      "type": "object"
                    }
                  },
                  "required": [
                    "id"
                  ]
                },
                "types": {
                  "type": "array",
                  "description": "The association types",
                  "example": [
                    {
                      "associationCategory": "HUBSPOT_DEFINED",
                      "associationTypeId": 202
                    }
                  ],
                  "items": {
                    "type": "object"
                  }
                }
              },
              "required": [
                "to",
                "types"
              ]
            }
          }
        },
        "required": [
          "properties"
        ]
      }
    }
  },
  "required": [
    "inputs"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "BatchCreateNotesRequest"
}