HubSpot · JSON Structure

Hubspot Commerce Payments Error Structure

An error response

Type: object Properties: 7 Required: 3
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Error is a JSON Structure definition published by HubSpot, describing 7 properties, of which 3 are required. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

category correlationId message subCategory errors context links

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

Raw ↑ 
{
  "type": "object",
  "description": "An error response",
  "name": "Error",
  "properties": {
    "category": {
      "type": "string",
      "description": "The error category"
    },
    "correlationId": {
      "type": "uuid",
      "description": "A unique identifier for this error instance"
    },
    "message": {
      "type": "string",
      "description": "A human-readable error message"
    },
    "subCategory": {
      "type": "string",
      "description": "A more specific error category"
    },
    "errors": {
      "type": "array",
      "description": "Detailed error information",
      "items": {
        "type": "object",
        "description": "Detailed error information",
        "properties": {
          "message": {
            "type": "string",
            "description": "The error message"
          },
          "code": {
            "type": "string",
            "description": "An error code"
          },
          "in": {
            "type": "string",
            "description": "The location of the error"
          },
          "subCategory": {
            "type": "string",
            "description": "A specific error subcategory"
          },
          "context": {
            "type": "object"
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "context": {
      "type": "object",
      "description": "Additional context about the error"
    },
    "links": {
      "type": "object",
      "description": "Related links"
    }
  },
  "required": [
    "category",
    "correlationId",
    "message"
  ],
  "$schema": "https://json-structure.org/draft/2020-12/schema"
}