document idempotency-key header (#581)

This commit is contained in:
codl 2018-03-25 19:33:13 +02:00 committed by Eugen Rochko
parent 8ab12a626e
commit c2e5d5d665
1 changed files with 4 additions and 0 deletions

View File

@ -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 <https://stripe.com/blog/idempotency> for more on idempotency and idempotency keys.
#### Deleting a status:
DELETE /api/v1/statuses/:id