PUT watchlist/{id}

PUT

/watchlist/{id}

Update watchlist

Example URI


https://sandbox.livevol.com/api/v1/watchlist/c545d492-d91a-4bc6-af54-964fe307acdb

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

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
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": "d4f35a71-e224-4a65-8baf-0fb68c33d284",
  "name": "default",
  "description": "",
  "symbols": [
    "AAPL",
    "MSFT"
  ]
}

application/xml, text/xml

Sample:

<watchlist xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <description></description>
  <id>d4f35a71-e224-4a65-8baf-0fb68c33d284</id>
  <name>default</name>
  <symbols>
    <symbol>AAPL</symbol>
    <symbol>MSFT</symbol>
  </symbols>
</watchlist>