INVALID_IDEMPOTENCY

Invalid idempotency key format. Must be a UUID or an alphanumeric string.

Category: General


HTTP status	`400` Bad Request
Retry	After fixing the cause

When it happens

The Idempotency-Key header is empty, longer than 255 characters, or contains characters other than letters, digits, _ and -. It can happen on any operation that accepts the header.

How to fix it

Send a key made only of letters, digits, _ and -, up to 255 characters. A UUID works.

Retry

Not as is: the same request fails the same way. Fix the cause described above, then send the request again, under a new Idempotency-Key if the body changed.

Rules that cite this code

LIF-004 Retry writes with the same Idempotency-Key

Example response

When this error occurs, the API answers 400 Bad Request with a JSON body of this shape:

{
  "type": "https://docs.beel.es/errors/INVALID_IDEMPOTENCY_KEY",
  "title": "INVALID_IDEMPOTENCY_KEY",
  "detail": "Invalid idempotency key format. Must be a UUID or an alphanumeric string.",
  "instance": "/v1/<resource>",
  "errors": [],
  "success": false,
  "error": {
    "code": "INVALID_IDEMPOTENCY_KEY",
    "message": "Invalid idempotency key format. Must be a UUID or an alphanumeric string.",
    "details": {}
  },
  "meta": {
    "timestamp": "2026-05-21T10:00:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}