HubSpot · Schema

ErrorDetail

Detailed information about a specific error

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
message string Human-readable error message
code string Machine-readable error code
subCategory string Specific error subcategory
in string Location where the error occurred (e.g., query, path, body)
context object Additional context about the specific error
View JSON Schema on GitHub

JSON Schema

hubspot-analytics-events-error-detail-schema.json Raw ↑ 
{
  "type": "object",
  "description": "Detailed information about a specific error",
  "properties": {
    "message": {
      "type": "string",
      "description": "Human-readable error message",
      "example": "This is an example description."
    },
    "code": {
      "type": "string",
      "description": "Machine-readable error code",
      "example": "example-value"
    },
    "subCategory": {
      "type": "string",
      "description": "Specific error subcategory",
      "example": "standard"
    },
    "in": {
      "type": "string",
      "description": "Location where the error occurred (e.g., query, path, body)",
      "example": "example-value"
    },
    "context": {
      "type": "object",
      "description": "Additional context about the specific error",
      "example": {
        "key": "value"
      }
    }
  },
  "required": [
    "message"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ErrorDetail"
}