Errors | JazzHQ AI | Documentation

JazzHQ APIs use standard HTTP status codes to indicate whether a request was successful.

Error responses are returned as JSON and include a machine-readable message that can be used to identify the error.

Error response

{
  "message": "VALIDATION_FAILED",
  "status": 400,
  "success": false,
  "errors": [
    {
      "field": "companyName",
      "error": "COMPANY_NAME_MANDATORY"
    }
  ],
  "timestamp": "2026-08-01T09:15:00"
}

For validation errors, the errors array contains details about the fields that caused the request to fail.

Error codes

HTTP status	Code	Description
`400`	`VALIDATION_FAILED`	One or more request fields are invalid or missing.
`400`	`INVALID_REQUEST`	The request could not be processed.
`400`	`DUPLICATE_ENTRY`	The request conflicts with an existing resource.
`403`	`API_KEY_MISSING`	The API key was not provided.
`403`	`INVALID_API_KEY`	The provided API key is invalid.
`404`	`RESOURCE_NOT_FOUND`	The requested resource could not be found.
`500`	`INTERNAL_SERVER_ERROR`	An unexpected error occurred.

Examples

Authentication errors

No X-API-KEY header sent

1 {
2   "success": false,
3   "message": "API_KEY_MISSING",
4   "data": null,
5   "timestamp": "2026-08-01T09:15:00"
6 }

Invalid API key

1 {
2   "success": false,
3   "message": "INVALID_API_KEY",
4   "data": null,
5   "timestamp": "2026-08-01T09:15:00"
6 }

Validation errors

Required fields are missing

1 {
2   "message": "VALIDATION_FAILED",
3   "status": 400,
4   "success": false,
5   "errors": [
6     {
7       "field": "companyName",
8       "error": "COMPANY_NAME_MANDATORY"
9     },
10     {
11       "field": "contactEmailAddress",
12       "error": "CONTACT_EMAIL_MANDATORY"
13     }
14   ],
15   "timestamp": "2026-08-01T09:15:00"
16 }

Resource errors

Requested resource was not found

1 {
2   "message": "RESOURCE_NOT_FOUND",
3   "status": 404,
4   "success": false,
5   "errors": [
6     {
7       "field": "resource",
8       "error": "The requested resource was not found."
9     }
10   ],
11   "timestamp": "2026-08-01T09:15:00"
12 }

For validation errors, check the errors array for field-level details.