HubSpot · JSON Structure

Hubspot Engagement Calls Batch Error Structure

Error information for a batch operation item

Type: object Properties: 5
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

BatchError is a JSON Structure definition published by HubSpot, describing 5 properties. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

status category message context errors

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

Raw ↑ 
{
  "type": "object",
  "description": "Error information for a batch operation item",
  "name": "BatchError",
  "properties": {
    "status": {
      "type": "string",
      "description": "The error status"
    },
    "category": {
      "type": "string",
      "description": "The error category"
    },
    "message": {
      "type": "string",
      "description": "The error message"
    },
    "context": {
      "type": "object"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "Detailed error information",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message"
          },
          "code": {
            "type": "string",
            "description": "Error code"
          },
          "in": {
            "type": "string",
            "description": "Field where error occurred"
          },
          "subCategory": {
            "type": "string",
            "description": "Error subcategory"
          },
          "context": {
            "type": "object"
          }
        },
        "required": [
          "message"
        ]
      }
    }
  },
  "$schema": "https://json-structure.org/draft/2020-12/schema"
}