HubSpot · JSON Structure

Crm Associations Api Batch Association Archive Input Structure

Input for batch archiving associations

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

BatchAssociationArchiveInput 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/crm-associations-api-batch-association-archive-input-structure.json",
  "name": "BatchAssociationArchiveInput",
  "description": "Input for batch archiving associations",
  "type": "object",
  "properties": {
    "inputs": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "Single item in a batch association archive request",
        "properties": {
          "from": {
            "$ref": "#/components/schemas/ObjectReference"
          },
          "to": {
            "$ref": "#/components/schemas/ObjectReference"
          },
          "types": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AssociationTypeInput"
            },
            "example": [
              {
                "associationCategory": "HUBSPOT_DEFINED",
                "associationTypeId": 500123
              }
            ]
          }
        },
        "required": [
          "from",
          "to"
        ]
      },
      "description": "Associations to archive",
      "example": [
        {
          "from": {},
          "to": {},
          "types": [
            {}
          ]
        }
      ]
    }
  },
  "required": [
    "inputs"
  ]
}