HubSpot · Schema

ErrorDetail

Detailed information about a specific error

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
message string A human-readable error message
code string An error code
subCategory string A specific error subcategory
in string The location of the error (e.g., body, query, path)
context object Additional context about the specific error
View JSON Schema on GitHub

JSON Schema

hubspot-oauth-error-detail-schema.json Raw ↑
{
  "type": "object",
  "description": "Detailed information about a specific error",
  "properties": {
    "message": {
      "type": "string",
      "description": "A human-readable error message",
      "example": "Invalid parameter value"
    },
    "code": {
      "type": "string",
      "description": "An error code",
      "example": "INVALID_PARAMETER"
    },
    "subCategory": {
      "type": "string",
      "description": "A specific error subcategory",
      "example": "MISSING_REQUIRED_FIELD"
    },
    "in": {
      "type": "string",
      "description": "The location of the error (e.g., body, query, path)",
      "example": "body"
    },
    "context": {
      "type": "object",
      "description": "Additional context about the specific error",
      "example": {
        "missingFields": [
          "client_secret"
        ]
      }
    }
  },
  "required": [
    "message"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ErrorDetail"
}