In order to safely retry a request without performing twice the same operation, you can provide an additional X-Idempotency-Key header when creating or updating an object. GET and DELETE requests are idempotent by definition so sending an idempotency key with these verbs has no effect and should be avoided.
Our Idempotency works by storing the URL, verb, company_id, and response for each idempotency key used in a request. Subsequent requests that share the same URL, verb, company_id, and idempotency key as a previous one will have no impact and receive the previously stored response. This applies to both successful and error responses. It's important to note that while a key can be reused for different URLs or methods, we strongly advise against doing so.
As for the keys, the creation and format of them is up to you with a maximum of 250 characters in length. Our recommendation is to use V4 UUIDs.
| Header | Type | Description |
|---|---|---|
| X-Idempotency-Key | string | Optional key used to perform an idempotent request. Max. length: 250 characters. |