HubSpot · Schema

BatchArchiveNotesRequest

Request body for batch archiving notes

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
inputs array Array of note identifiers to archive
View JSON Schema on GitHub

JSON Schema

engagement-notes-batch-archive-notes-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-schema/engagement-notes-batch-archive-notes-request-schema.json",
  "title": "BatchArchiveNotesRequest",
  "description": "Request body for batch archiving notes",
  "type": "object",
  "properties": {
    "inputs": {
      "type": "array",
      "description": "Array of note identifiers to archive",
      "items": {
        "type": "object",
        "description": "Input for reading a single item in a batch",
        "required": [
          "id"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "The note identifier",
            "example": "1024"
          }
        }
      },
      "maxItems": 100,
      "example": [
        {
          "id": "1024"
        }
      ]
    }
  },
  "required": [
    "inputs"
  ]
}