From c2e5d5d6659112362ab6c941b4da70474de87b3b Mon Sep 17 00:00:00 2001 From: codl Date: Sun, 25 Mar 2018 19:33:13 +0200 Subject: [PATCH] document idempotency-key header (#581) --- Using-the-API/API.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Using-the-API/API.md b/Using-the-API/API.md index 167a4655..b3a920ee 100644 --- a/Using-the-API/API.md +++ b/Using-the-API/API.md @@ -628,6 +628,10 @@ Form data: Returns the new [Status](#status). +> **Note:** In order to prevent duplicate statuses, this endpoint accepts an `Idempotency-Key` header, which should be set to a unique string for each new status. In the event of a network error, a request can be retried with the same `Idempotency-Key`. Only one status will be created regardless of how many requests with the same `Idempotency-Key` did go through. +> +> See for more on idempotency and idempotency keys. + #### Deleting a status: DELETE /api/v1/statuses/:id