Userpilot · Schema

ErrorResponse

Standard error response object.

ProductOnboardingIn-App GuidanceAnalyticsCustomer Success

Properties

Name Type Description
errors array
View JSON Schema on GitHub

JSON Schema

userpilot-errorresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ErrorResponse",
  "title": "ErrorResponse",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "details": {
            "type": "string",
            "description": "Detailed error information."
          },
          "error": {
            "type": "string",
            "description": "Short error code or label."
          },
          "error_code": {
            "type": "string",
            "description": "Error code for programmatic handling."
          },
          "message": {
            "type": "string",
            "description": "Human-readable error message."
          }
        }
      }
    }
  },
  "description": "Standard error response object."
}