HubSpot · Schema

ErrorDetail

Detailed error information for specific validation failures

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name	Type	Description
message	string	Specific error message
code	string	Error code
subCategory	string	Error sub-category
in	string	Location of the error (e.g., path, body, query)
context	object	Additional context for the error

View JSON Schema on GitHub

JSON Schema

{
  "type": "object",
  "description": "Detailed error information for specific validation failures",
  "properties": {
    "message": {
      "type": "string",
      "description": "Specific error message",
      "example": "flagState is required"
    },
    "code": {
      "type": "string",
      "description": "Error code",
      "example": "REQUIRED_FIELD"
    },
    "subCategory": {
      "type": "string",
      "description": "Error sub-category",
      "example": "MISSING_FIELD"
    },
    "in": {
      "type": "string",
      "description": "Location of the error (e.g., path, body, query)",
      "example": "body"
    },
    "context": {
      "type": "object",
      "description": "Additional context for the error",
      "example": {
        "key": "value"
      }
    }
  },
  "required": [
    "message"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ErrorDetail"
}