HubSpot · Schema

ErrorDetail

Detailed error information

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
message string Error message
code string Error code
subCategory string Error subcategory
in string Location of the error
context object Additional context
View JSON Schema on GitHub

JSON Schema

hubspot-source-code-error-detail-schema.json Raw ↑
{
  "type": "object",
  "description": "Detailed error information",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error message",
      "example": "Required property 'path' is missing"
    },
    "code": {
      "type": "string",
      "description": "Error code",
      "example": "MISSING_REQUIRED_PROPERTY"
    },
    "subCategory": {
      "type": "string",
      "description": "Error subcategory",
      "example": "standard"
    },
    "in": {
      "type": "string",
      "description": "Location of the error",
      "example": "body"
    },
    "context": {
      "type": "object",
      "description": "Additional context",
      "example": {
        "missingScopes": [
          "scope1",
          "scope2"
        ]
      }
    }
  },
  "required": [
    "message"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ErrorDetail"
}