HubSpot · JSON Structure

Hubspot Commerce Payments Batch Error Structure

An error from a batch operation

Type: object Properties: 8 Required: 2
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

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

Properties

status id category message errors context links subCategory

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

JSON Structure

Raw ↑ 
{
  "type": "object",
  "description": "An error from a batch operation",
  "name": "BatchError",
  "properties": {
    "status": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "category": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "Detailed error information",
        "properties": {
          "message": {
            "type": "string",
            "description": "The error message"
          },
          "code": {
            "type": "string",
            "description": "An error code"
          },
          "in": {
            "type": "string",
            "description": "The location of the error"
          },
          "subCategory": {
            "type": "string",
            "description": "A specific error subcategory"
          },
          "context": {
            "type": "object"
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "context": {
      "type": "object"
    },
    "links": {
      "type": "object"
    },
    "subCategory": {
      "type": "string"
    }
  },
  "required": [
    "category",
    "message"
  ],
  "$schema": "https://json-structure.org/draft/2020-12/schema"
}