Describe a lot

PUT/v1/lots/{id}/description

Sets the line the market shows under your lot, up to 32 characters. An empty one takes it away. It is plain text: no links.

Request

Path parameters

  • idstringrequired

    The lot's id.

Request body

  • descriptionstringrequired

    The new description. Empty takes it away.

curl -X PUT 'https://api.rockvel.store/v1/lots/019a4b9d-2e17-7a58-b1c6-0d3f6a9e4b12/description' \
  -H "Authorization: Bearer $ROCKVEL_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"description":"Crown in the best spot"}'

Answer 200

An empty object.

{}

Refusals

StatusCodeWhen
409lot_goneThe lot sold or was taken down.
422bad_descriptionThe description is longer than 32 characters, has more than one line or space at its ends.

Any route can also answer with the statuses on the Errors page.