PUT watchlist/{id}

< API Reference

PUT

/watchlist/{id}

None

Update watchlist

Example URI


https://sandbox.livevol.com/api/v1/watchlist/2401b8ea-fcd3-4e9c-bc38-e91b5d328116

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": "2c7e4fc2-6e09-437a-9b23-2fd9acd67ca9",
  "name": "default",
  "description": "",
  "symbols": [
    "AAPL",
    "MSFT"
  ]
}

application/xml, text/xml

Sample:

<watchlist xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <description></description>
  <id>2c7e4fc2-6e09-437a-9b23-2fd9acd67ca9</id>
  <name>default</name>
  <symbols>
    <symbol>AAPL</symbol>
    <symbol>MSFT</symbol>
  </symbols>
</watchlist>