PUT
/watchlist/{id}
Update watchlist

Example URI

https://api.livevol.com/v1/watchlist/91f676d6-db21-490f-a34b-6b585d3d7778

Request Information

URI Parameters

Name Description Type Additional information
id

Watchlist Id

globally unique identifier

Required

Body Parameters

UpdateWatchlistParams

Name Description Type Additional 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

Name Description Type Additional information SIP Provider
id

Watchlist Id

globally unique identifier

None

None

name

A watchlist name

string

None

None

description

A watchlist description

string

None

None

symbols

Symbols collection in current watchlist

Collection of string

None

None

Response Formats

application/json, text/json

Sample:
{
  "id": "b3b5bd5c-8d0c-45b1-89e5-4d9177c19286",
  "name": "default",
  "description": "",
  "symbols": [
    "AAPL",
    "MSFT"
  ]
}

application/xml, text/xml

Sample:
<watchlist xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <description></description>
  <id>b3b5bd5c-8d0c-45b1-89e5-4d9177c19286</id>
  <name>default</name>
  <symbols>
    <symbol>AAPL</symbol>
    <symbol>MSFT</symbol>
  </symbols>
</watchlist>