Grails API Documentation

PATCH /api/v1/watchlist/:id

Update notification preferences for a watchlist entry.

Authentication: Required

Cache: None

Path Parameters

Parameter	Type	Required	Description
`id`	number	Yes	Watchlist entry ID

Request Body

Field	Type	Required	Description
`notifyOnSale`	boolean	No	Notify when name is sold
`notifyOnOffer`	boolean	No	Notify on new offers
`notifyOnListing`	boolean	No	Notify when listed
`notifyOnPriceChange`	boolean	No	Notify on price changes
`minOfferThreshold`	number \| null	No	Minimum offer amount (0+, or null)

At least one field must be provided.

Sample Request


curl -X PATCH -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  https://api.grails.app/api/v1/watchlist/1 \
  -d '{ "notifyOnPriceChange": true }'

Response


// 200 OK
{
  "success": true,
  "data": {
    "id": 1,
    "notifyOnSale": true,
    "notifyOnOffer": true,
    "notifyOnListing": true,
    "notifyOnPriceChange": true,
    "minOfferThreshold": null
  },
  "meta": {
    "timestamp": "2026-04-08T00:00:00.000Z",
    "version": "1.0.0"
  }
}

Error Responses

Status	Code	Description
400	`NO_UPDATES`	No fields provided
403	`FORBIDDEN`	Entry belongs to another user
404	`NOT_FOUND`	Watchlist entry not found