Skip to content
Watchlist

Set watchlist note

Saves the alias and description of a security for the Client and overwrites any existing note. The alias replaces the security name in display; if the Client leaves it empty, the Broker App sends the security name. The Broker App limits the alias to 20 characters and the description to 2,000 characters. After saving, refresh the display name in the watchlist. If the request fails, the note is unchanged; the Broker App shows message and keeps the Client input.

POSThttps://api.lbkrs.com/v1/watchlist/stocknote/set

Request body application/json

counter_idstringrequired

Security ID (counter_id)

notestringrequired

Alias

descriptionstringrequired

Description. Can be an empty string

Responses

HTTP 200The request succeeded. The response body contains the result of the “Set watchlist note” operation.
Standard response envelopecodemessagedata
dataobjectdata structure

Always null. A code of 0 means the note was saved

No nested fields

Whale Docs