HubSpot · Schema

Error

An error response.

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
status string
message string
correlationId string
category string
errors array
View JSON Schema on GitHub

JSON Schema

hubspot-crm-search-error-schema.json Raw ↑
{
  "type": "object",
  "description": "An error response.",
  "properties": {
    "status": {
      "type": "string",
      "example": "active"
    },
    "message": {
      "type": "string",
      "example": "This is an example description."
    },
    "correlationId": {
      "type": "string",
      "example": "500123"
    },
    "category": {
      "type": "string",
      "example": "standard"
    },
    "errors": {
      "type": "array",
      "example": [
        {
          "message": "This is an example description.",
          "in": "example-value",
          "code": "example-value"
        }
      ],
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "in": {
            "type": "string"
          },
          "code": {
            "type": "string"
          }
        }
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Error"
}