curl --request PATCH \
--url https://api.aries.com/v1/config/watchlist/{watchlist_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"add_symbols": [
"TSLA"
],
"remove_symbols": [
"MSFT"
]
}
'{
"id": 12345,
"name": "Growth Stocks",
"symbols": [
"AAPL",
"GOOGL",
"MSFT"
]
}Update Watchlist
Partially updates a watchlist owned by the authenticated user, identified by its numeric watchlist_id. Rename it, add symbols, remove symbols, or any combination, by including at least one of name, add_symbols, or remove_symbols. Symbols added are uppercased and checked against the symbol resolver; any that can’t be resolved are dropped and returned in the response’s invalid_symbols field.
Use Case: Rename an existing watchlist or adjust its symbol list as a user refines what they’re tracking, without resending the full watchlist.
curl --request PATCH \
--url https://api.aries.com/v1/config/watchlist/{watchlist_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"add_symbols": [
"TSLA"
],
"remove_symbols": [
"MSFT"
]
}
'{
"id": 12345,
"name": "Growth Stocks",
"symbols": [
"AAPL",
"GOOGL",
"MSFT"
]
}Authorizations
OAuth2 Bearer token: obtain an access token from the token endpoint and send it in the Authorization header.
Path Parameters
The numeric ID of the watchlist to update. You can get this from a previous list/create/update response (the id field in the returned watchlist).
12345
Body
At least one of name, add_symbols, or remove_symbols must be included.
- Option 1
- Option 2
- Option 3
Request body for partially updating a watchlist. Include at least one of name, add_symbols, or remove_symbols.
New name for the watchlist. Omit to leave the name unchanged; if included, it cannot be empty and must not match the name of another of the user's watchlists (case-sensitive).
1Symbols to add to the watchlist. Use exact uppercase ticker symbols; symbols that can't be resolved are dropped and returned in the response's invalid_symbols field.
["TSLA"]
Symbols to remove from the watchlist.
["MSFT"]
Response
Watchlist updated. The response contains the full, updated watchlist; check invalid_symbols for any submitted symbols that were dropped.
Saved list of symbols a user wants to monitor. Watchlists are read-only from a trading-risk perspective and do not place orders.
Watchlist identifier. Use this value when reading, updating, or deleting a specific watchlist.
Symbols from the request that could not be resolved and were dropped from symbols. Only present on create and update responses when at least one submitted symbol failed resolution.
User-facing watchlist name, such as Tech Stocks or Dividend Ideas. Show this as the list label in your app.
Symbols saved in the watchlist. Use exact uppercase ticker symbols and confirm unfamiliar symbols with symbol search. May be null for a watchlist saved through Replace All Watchlists without symbols.
Was this page helpful?