< API Reference
PUT
/watchlist/{id}
None
Update watchlist

Example URI

https://api.livevol.com/v1/watchlist/637fa8b3-c0d3-4026-a9e1-f31c17aad0e8

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Watchlist Id

globally unique identifier

Required

Body Parameters

UpdateWatchlistParams

NameDescriptionTypeAdditional information
name

A watchlist name

string

Max length: 32

The value of this field is case sensitive

description

A watchlist description

string

Max length: 255

The value of this field is case sensitive

Request Formats

application/json, text/json

Sample:
{
  "name": "customWL1",
  "description": "My Custom Watchlist"
}

application/xml, text/xml

Sample:
<watchlist xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <description>My Custom Watchlist</description>
  <name>customWL1</name>
</watchlist>

Response Information

Resource Description

WatchlistResult

NameDescriptionTypeAdditional information
id

Watchlist Id

globally unique identifier

None.

name

A watchlist name

string

None.

description

A watchlist description

string

None.

symbols

Symbols collection in current watchlist

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "id": "d2c95d4b-82f8-426e-b4b1-13b8ecf0a498",
  "name": "default",
  "description": "",
  "symbols": [
    "AAPL",
    "MSFT"
  ]
}

application/xml, text/xml

Sample:
<watchlist xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <description></description>
  <id>d2c95d4b-82f8-426e-b4b1-13b8ecf0a498</id>
  <name>default</name>
  <symbols>
    <symbol>AAPL</symbol>
    <symbol>MSFT</symbol>
  </symbols>
</watchlist>