HubSpot · Schema

BatchAssociationResponse

Response from batch association operations

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationSales

Properties

Name Type Description
status string Status of the batch operation
results array Successfully processed associations
requestedAt string When the batch was requested
startedAt string When processing started
completedAt string When processing completed
numErrors integer Number of errors encountered
errors array List of errors
links object
View JSON Schema on GitHub

JSON Schema

crm-associations-api-batch-association-response-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/crm-associations-api-batch-association-response-schema.json",
  "title": "BatchAssociationResponse",
  "description": "Response from batch association operations",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "PENDING",
        "PROCESSING",
        "CANCELED",
        "COMPLETE"
      ],
      "description": "Status of the batch operation",
      "example": "PENDING"
    },
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "Result of an association query",
        "properties": {
          "from": {
            "$ref": "#/components/schemas/ObjectReference"
          },
          "to": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Association"
            },
            "description": "Associated objects",
            "example": [
              {
                "toObjectId": "500123",
                "associationTypes": [
                  {
                    "associationCategory": "HUBSPOT_DEFINED",
                    "associationTypeId": 500123,
                    "label": "Example Record"
                  }
                ]
              }
            ]
          },
          "paging": {
            "$ref": "#/components/schemas/Paging"
          }
        },
        "required": [
          "from",
          "to"
        ]
      },
      "description": "Successfully processed associations",
      "example": [
        {
          "from": {},
          "to": [
            {
              "toObjectId": "500123",
              "associationTypes": [
                {
                  "associationCategory": "HUBSPOT_DEFINED",
                  "associationTypeId": 500123,
                  "label": "Example Record"
                }
              ]
            }
          ],
          "paging": {}
        }
      ]
    },
    "requestedAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the batch was requested",
      "example": "2025-03-15T14:30:00Z"
    },
    "startedAt": {
      "type": "string",
      "format": "date-time",
      "description": "When processing started",
      "example": "2025-03-15T14:30:00Z"
    },
    "completedAt": {
      "type": "string",
      "format": "date-time",
      "description": "When processing completed",
      "example": "2025-03-15T14:30:00Z"
    },
    "numErrors": {
      "type": "integer",
      "description": "Number of errors encountered",
      "example": 100
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "Standard error in batch operations",
        "properties": {
          "status": {
            "type": "string",
            "example": "active"
          },
          "id": {
            "type": "string",
            "example": "500123"
          },
          "category": {
            "type": "string",
            "example": "standard"
          },
          "message": {
            "type": "string",
            "example": "This is an example description."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ErrorDetail"
            },
            "example": [
              {
                "message": "This is an example description.",
                "code": "example-value",
                "subCategory": "standard",
                "in": "example-value",
                "context": {
                  "key": "value"
                }
              }
            ]
          },
          "context": {
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "example": {
              "key": "value"
            }
          },
          "links": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "example": {
              "key": "value"
            }
          }
        },
        "required": [
          "status",
          "category",
          "message"
        ]
      },
      "description": "List of errors",
      "example": [
        {
          "status": "active",
          "id": "500123",
          "category": "standard",
          "message": "This is an example description.",
          "errors": [
            {}
          ],
          "context": {
            "key": "value"
          },
          "links": {
            "key": "value"
          }
        }
      ]
    },
    "links": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "example": {
        "key": "value"
      }
    }
  },
  "required": [
    "status",
    "results",
    "startedAt",
    "completedAt"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Schema 
curl "https://apis.io/api/v1/json-schemas/crm-associations-api-batch-association-response"
All schemas 
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.