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	Error code
subCategory	string	Error subcategory
in	string	Location where error occurred
context	object

View JSON Schema on GitHub

JSON Schema

{
  "type": "object",
  "description": "Detailed information about a specific error.",
  "properties": {
    "message": {
      "type": "string",
      "description": "Human-readable error message",
      "example": "Invalid thread ID format"
    },
    "code": {
      "type": "string",
      "description": "Error code",
      "example": "INVALID_FORMAT"
    },
    "subCategory": {
      "type": "string",
      "description": "Error subcategory",
      "example": "PARAMETER_ERROR"
    },
    "in": {
      "type": "string",
      "description": "Location where error occurred",
      "example": "path"
    },
    "context": {
      "type": "object",
      "example": {
        "key": "value"
      }
    }
  },
  "required": [
    "message"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ErrorDetail"
}