Listings

Update a listing

Update any field on an item (price, title, description, status, etc.). This route does NOT accept an Idempotency-Key (check the parameters of an operation before sending one — this spec declares the header only on the six routes that honour it). Retry safety comes from the conflict check instead: on a timeout, re-read the item with GET and re-apply the change, and treat the "changed while you were editing" 409 below as your signal that a concurrent write landed first.

put/api/items/{id}

Request

  • Base URL: https://clearlist.me
  • URL: https://clearlist.me/api/items/{id}
  • Auth: one of:
    • API key in header X-ClearList-API-Key
    • OAuth 2 (authorization code, authorization URL https://clearlist.me/oauth/authorize, token URL https://clearlist.me/api/oauth/token, scopes: write)

Request body

object required

Response

Updated. The body carries the full updated item document.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.