Idempotency

Idempotency allows for safe retry of requests to all POST (add), PATCH (update), and PUT (insert) API endpoints to mitigate the risks of unintended duplicate processing. Idempotency keys are retained indefinitely after the initial successful POST, PATCH, and PUT request. Idempotency keys are scoped to each endpoint separately. A reused idempotency key for a given endpoint will return the prior success (200) response status and prior response message without any further processing at Lynx.

Lynx recommends reuse of idempotency key only for situations where request failure is suspected and retry is intended (e.g., a 500 response code was received or there is otherwise doubt whether a previous request was processed).

Any string of up to 255 characters may be used as an idempotency key (UUID version 4 is recommended).