Files
bookhoard/docs/developer/api/ratings/update_rating.md
T
john-okeefe c437528522 docs(api): add new endpoint documentation
- Add create_media_item.md for media item creation API

- Add delete_rating.md for rating deletion endpoint

- Add update_rating.md for rating update endpoint
2026-02-08 13:33:09 -05:00

1.2 KiB

Update Rating

Update an existing rating for a media item.

Endpoint: PUT /api/media-items/{media_id}/rating Auth: Required Content-Type: application/json

Path Parameters

Parameter Type Required Description
media_id string Yes Media item UUID

Request Body

Field Type Required Description
rating integer Yes Rating value (1-10 scale)
review string No Optional review text

Rating Scale: 1-10 (odd numbers = half-stars: 1=0.5★, 2=1★, 3=1.5★, ..., 9=4.5★, 10=5★)

Example Request

{
  "rating": 8,
  "review": "Great book! Very enjoyable read."
}

Response (200 OK)

{
  "id": "uuid",
  "media_item_id": "uuid",
  "user_id": "uuid",
  "rating": 8,
  "review": "Great book! Very enjoyable read.",
  "created_at": "2026-01-31T10:00:00Z",
  "updated_at": "2026-01-31T11:00:00Z"
}

Error Responses

Code Description
400 Invalid request data
401 Invalid or expired token
404 Media item or rating not found

Try It Out