HubSpot · JSON Structure

Authors Api Batch Archive Input Structure

Input for batch archive operations

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

BatchArchiveInput 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/authors-api-batch-archive-input-structure.json",
  "name": "BatchArchiveInput",
  "description": "Input for batch archive operations",
  "type": "object",
  "properties": {
    "inputs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "ID of the author to archive"
          }
        },
        "required": [
          "id"
        ]
      },
      "description": "Array of author IDs to archive",
      "example": [
        {
          "id": "500123"
        }
      ]
    }
  },
  "required": [
    "inputs"
  ]
}