Skip to main content
PUT

Authorizations

Authorization
string
header
required

OAuth2 Bearer token: obtain an access token from the token endpoint and send it in the Authorization header.

Body

application/json

The complete desired set of watchlists. Each entry's name must be unique within the array, and symbols must not contain duplicates within an entry.

name
string
required

Unique user-facing name for the watchlist. Enter a short label the user will recognize.

Minimum string length: 1
symbols
string[]

Stock symbols to include. Enter exact uppercase symbols and avoid duplicates. Unlike create/update, symbols here are stored as-is and are not validated against the symbol resolver.

Example:

Response

The full, resulting set of watchlists after the replace, in request order. Sending an empty array resets the user to a single new "Default" watchlist with no symbols.

Response body containing the user's saved watchlists.

user_id
integer<int64>

User ID that owns these watchlists. Use it to confirm the response belongs to the expected connected user.

watchlist
object[]

Saved watchlists for the user. Render each item as a named list of symbols.