Skip to content

Watchlist:UpdateWatchlist

Updates the details of an existing User Watchlist

Controller: Watchlist
Topic: UpdateWatchlist Action: Publish
Permissions: Zenith/Market

NameTypeExpectDescription
WatchlistIDStringAlwaysA unique identifier of the existing Watchlist to update.
DetailsObjectAlwaysThe new details to assign.
NameTypeExpectDescription
NameStringAlwaysA display name for this Watchlist.
DescriptionStringOptionalA brief description for this Watchlist, if any.
CategoryStringOptionalThe category this Watchlist belongs to, if any.

No Response Body.

Send:

{"Controller":"Watchlist","Topic":"UpdateWatchlist","TransactionID":1,"Data":{"WatchlistID":"123ABC","Details":{"Name":"Updated Watchlist","Description":"Custom Description","Category":"Custom"}}}

Receive:

{
"Controller":"Watchlist",
"Topic":"UpdateWatchlist",
"TransactionID":1
}