Watchlist

Mark every unread alert as read

Marks every unread alert of the account as read. The optional JSON body narrows it with the filters GET /watchlist/alerts takes: alert_type, company_number, since, until. Answers with marked_read, the number of alerts marked (0 when none were unread).

post/watchlist/alerts/read

Request

  • Base URL: https://api.companystack.co.uk
  • URL: https://api.companystack.co.uk/watchlist/alerts/read
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Request body

alert_typestring
company_numberstring
sincestring date-time
untilstring date-time

Response

How many alerts were marked as read

successboolean required
marked_readinteger required

Alerts marked as read by this request; 0 when none were unread

Changes

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