Update a watchlist

Update the fields you send. Fields you leave out are not changed.

items replaces the whole list, so send every item you want the watchlist to keep. Duplicate items are removed. At least one of name, items, or description is expected.

PATCH /v1/watchlists/{watchlist_id}

cURL

rename

curl --request PATCH \
  --url https://api.bigdata.com/v1/watchlists/{watchlist_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "MAMAA stocks (US)"
}
'

200

{
  "metadata": {
    "request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
    "timestamp": "2026-10-23T09:00:00Z"
  },
  "results": {
    "id": "b548fc37-87d3-4bc7-b482-eeeeb7060f78",
    "user_id": "A1B2C3D4E5",
    "created_at": "2026-10-20T10:15:00.000000Z",
    "updated_at": "2026-10-23T08:30:00.000000Z",
    "interacted_at": null,
    "name": "MAMAA stocks (US)",
    "description": "Large-cap US technology companies",
    "items": [
      "0157B1",
      "12E454",
      "228D42",
      "4A6F00",
      "D8442A"
    ]
  }
}

Authorizations

X-API-KEY · string · header · required

API key from the Bigdata Developer Platform.

Path Parameters

watchlist_id · string · required

The id of the watchlist.

Body

application/json

name · string

New name.

Required string length: 1 - 255

items · string[]

New list of items. It replaces the current list. Duplicates are removed. A watchlist holds at most 2000 items.

Maximum array length: 2000

description · string

New description.

Maximum string length: 4000

Response

200

application/json

The updated watchlist.

metadata · object · required

Show child attributes

results · object · required

Show child attributes