---
title: "CaseModuleErrorResponse"
url: "https://developers.zinnia.com/apis/case-management-1-0-0/versions/0091226b-6452-4e75-93ce-4bbfe022aad5/schemas/CaseModuleErrorResponse"
---

> Full API specification: https://developers.zinnia.com/apis/case-management-1-0-0/versions/0091226b-6452-4e75-93ce-4bbfe022aad5.md

# CaseModuleErrorResponse

Canonical error envelope for Case module.

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Case Management API
  version: 1.0.0
servers:
  - url: https://dev.api.zinnia.io/
    description: Dev Environment
  - url: https://qa.api.zinnia.io/
    description: QA Environment
  - url: https://uat.api.zinnia.io/
    description: UAT Environment
  - url: https://api.zinnia.io/
    description: PROD Environment
components:
  schemas:
    CaseModuleErrorResponse:
      type: object
      description: Canonical error envelope for Case module.
      properties:
        message:
          type: string
          description: High-level error message.
          example: Invalid link type
        traceId:
          type: string
          description: Trace/correlation id for debugging (derived from requestId or
            X-Correlation-Id).
          example: 0286d47a-7ad9-499c-8ca0-8f6634d236a3
        detail:
          type: string
          description: Detailed message including error code context.
          example: "[INVALID_LINK_TYPE] Invalid linkType: foo. Valid values are: CHILD,
            DUPLICATE, RELATED"
        timestamp:
          type: integer
          format: int64
          description: Epoch timestamp in milliseconds.
          example: 1681395423438
```
