HubSpot · Schema

ErrorDetail

Detailed information about a specific error

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
message string A human-readable message describing the specific error
code string An error code for this specific error
in string The field or parameter where the error occurred
subCategory string A specific subcategory for this error
context object Additional context for this error
View JSON Schema on GitHub

JSON Schema

hubspot-domains-error-detail-schema.json Raw ↑
{
  "type": "object",
  "description": "Detailed information about a specific error",
  "properties": {
    "message": {
      "type": "string",
      "description": "A human-readable message describing the specific error",
      "example": "This is an example description."
    },
    "code": {
      "type": "string",
      "description": "An error code for this specific error",
      "example": "example-value"
    },
    "in": {
      "type": "string",
      "description": "The field or parameter where the error occurred",
      "example": "example-value"
    },
    "subCategory": {
      "type": "string",
      "description": "A specific subcategory for this error",
      "example": "standard"
    },
    "context": {
      "type": "object",
      "description": "Additional context for this error",
      "example": {
        "key": "value"
      }
    }
  },
  "required": [
    "message"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ErrorDetail"
}