HubSpot · JSON Structure

Crm Feature Flags Api Batch Error Structure

Represents an error that occurred for a specific item in a batch operation

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

BatchError is a JSON Structure definition published by HubSpot, describing 4 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

status category message context

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-structure/crm-feature-flags-api-batch-error-structure.json",
  "name": "BatchError",
  "description": "Represents an error that occurred for a specific item in a batch operation",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Error status code",
      "example": "error"
    },
    "category": {
      "type": "string",
      "description": "Error category",
      "example": "VALIDATION_ERROR"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message",
      "example": "Invalid portal ID"
    },
    "context": {
      "type": "object",
      "description": "Additional context about the error",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "example": {
        "key": "value"
      }
    }
  },
  "required": [
    "status",
    "category",
    "message"
  ]
}