HubSpot · Schema

Error

Standard error response

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
category string
correlationId string
message string
subCategory string
context object
links object
errors array
View JSON Schema on GitHub

JSON Schema

hubspot-crm-associations-error-schema.json Raw ↑
{
  "type": "object",
  "description": "Standard error response",
  "properties": {
    "category": {
      "type": "string",
      "example": "VALIDATION_ERROR"
    },
    "correlationId": {
      "type": "string",
      "format": "uuid",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "message": {
      "type": "string",
      "example": "This is an example description."
    },
    "subCategory": {
      "type": "string",
      "example": "standard"
    },
    "context": {
      "type": "object",
      "example": {
        "key": "value"
      }
    },
    "links": {
      "type": "object",
      "example": {
        "key": "value"
      }
    },
    "errors": {
      "type": "array",
      "example": [
        {
          "message": "This is an example description.",
          "code": "example-value",
          "subCategory": "standard",
          "in": "example-value",
          "context": {
            "key": "value"
          }
        }
      ],
      "items": {
        "type": "object",
        "description": "Details about a specific error",
        "properties": {
          "message": {
            "type": "string",
            "example": "This is an example description."
          },
          "code": {
            "type": "string",
            "example": "example-value"
          },
          "subCategory": {
            "type": "string",
            "example": "standard"
          },
          "in": {
            "type": "string",
            "example": "example-value"
          },
          "context": {
            "type": "object",
            "example": {
              "key": "value"
            }
          }
        },
        "required": [
          "message"
        ]
      }
    }
  },
  "required": [
    "category",
    "correlationId",
    "message"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Error"
}