BatchAssociationArchiveInput

{
  "type": "object",
  "description": "Input for batch archiving associations",
  "properties": {
    "inputs": {
      "type": "array",
      "description": "Associations to archive",
      "example": [
        {
          "from": {},
          "to": {},
          "types": [
            {}
          ]
        }
      ],
      "items": {
        "type": "object",
        "description": "Single item in a batch association archive request",
        "properties": {
          "from": {
            "type": "object",
            "description": "Reference to a CRM object by ID",
            "properties": {
              "id": {
                "type": "string",
                "description": "ID of the object",
                "example": "500123"
              }
            },
            "required": [
              "id"
            ]
          },
          "to": {
            "type": "object",
            "description": "Reference to a CRM object by ID",
            "properties": {
              "id": {
                "type": "string",
                "description": "ID of the object",
                "example": "500123"
              }
            },
            "required": [
              "id"
            ]
          },
          "types": {
            "type": "array",
            "example": [
              {
                "associationCategory": "HUBSPOT_DEFINED",
                "associationTypeId": 500123
              }
            ],
            "items": {
              "type": "object",
              "description": "Input for specifying an association type",
              "properties": {
                "associationCategory": {
                  "type": "string",
                  "example": "HUBSPOT_DEFINED",
                  "enum": [
                    "HUBSPOT_DEFINED",
                    "USER_DEFINED",
                    "INTEGRATOR_DEFINED"
                  ]
                },
                "associationTypeId": {
                  "type": "integer",
                  "example": 500123
                }
              },
              "required": [
                "associationCategory",
                "associationTypeId"
              ]
            }
          }
        },
        "required": [
          "from",
          "to"
        ]
      }
    }
  },
  "required": [
    "inputs"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "BatchAssociationArchiveInput"
}