HubSpot · JSON Structure

Hubspot Blog Posts Standard Error Structure

Standard error in batch operations

Type: object Properties: 7 Required: 3
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

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

Properties

status id category message errors context links

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

JSON Structure

Raw ↑ 
{
  "type": "object",
  "description": "Standard error in batch operations",
  "name": "StandardError",
  "properties": {
    "status": {
      "type": "string",
      "description": "Error status"
    },
    "id": {
      "type": "string",
      "description": "ID of the failed item"
    },
    "category": {
      "type": "string",
      "description": "Error category"
    },
    "message": {
      "type": "string",
      "description": "Error message"
    },
    "errors": {
      "type": "array",
      "description": "Detailed errors",
      "items": {
        "type": "object",
        "description": "Detailed error information",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message"
          },
          "code": {
            "type": "string",
            "description": "Error code"
          },
          "subCategory": {
            "type": "string",
            "description": "Error subcategory"
          },
          "in": {
            "type": "string",
            "description": "Location of error"
          },
          "context": {
            "type": "object"
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "context": {
      "type": "object"
    },
    "links": {
      "type": "object"
    }
  },
  "required": [
    "status",
    "category",
    "message"
  ],
  "$schema": "https://json-structure.org/draft/2020-12/schema"
}