Get started

Endpoints · Watchlists

Update a watchlist

Renames or pins a watchlist, or adds and removes instruments in one atomic step.

PATCH/api/v1/watchlists/{id}

Scope: watchlists:write

Parameters

Path parameters

  • idstringpathrequired

    Watchlist id, "wl_…".

Body

  • namestringbody

    New name.

  • addstring[]body

    Instrument ids to add.

  • removestring[]body

    Instrument ids to remove.

  • instrument_idsstring[]body

    Replaces the whole list.

  • pinnedbooleanbody

    Pin or unpin.

Request
curl -X PATCH https://yieldsniper.finance/api/v1/watchlists/wl_6adccafe1c9b331c1d1bbfcc \
  -H "Authorization: Bearer $YS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "add": ["ins_0abd5ec576be07e6"],
    "remove": ["ins_2f32db0cbfbb54dd"]
  }'
Response200
{
  "object": "watchlist",
  "id": "wl_6adccafe1c9b331c1d1bbfcc",
  "name": "Treasury candidates",
  "instrument_ids": ["ins_4c29f40abec73e1b", "ins_0abd5ec576be07e6"],
  "pinned": false,
  "created_at": "2026-10-24T15:13:02.567Z",
  "updated_at": "2026-10-24T15:13:03.813Z"
}

Returns

The updated watchlist.

Object: Watchlist