HubSpot · Schema

BatchError

Represents an error that occurred for a specific item in a batch operation

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name	Type	Description
status	string	Error status code
category	string	Error category
message	string	Human-readable error message
context	object	Additional context about the error

View JSON Schema on GitHub

JSON Schema

{
  "type": "object",
  "description": "Represents an error that occurred for a specific item in a batch operation",
  "properties": {
    "status": {
      "type": "string",
      "description": "Error status code",
      "example": "error"
    },
    "category": {
      "type": "string",
      "description": "Error category",
      "example": "VALIDATION_ERROR"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message",
      "example": "Invalid portal ID"
    },
    "context": {
      "type": "object",
      "description": "Additional context about the error",
      "example": {
        "key": "value"
      }
    }
  },
  "required": [
    "status",
    "category",
    "message"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "BatchError"
}