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)"
}
'{
"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"
]
}
}{
"errors": [
{
"message": "Invalid payload"
}
],
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}{
"errors": [
{
"message": "Forbidden"
}
],
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}{
"errors": [
{
"message": "Not Found"
}
],
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}{
"errors": [
{
"message": "Conflict"
}
],
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}{
"errors": [
{
"message": "Unprocessable Entity"
}
],
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}{
"errors": [
{
"message": "Internal Server Error"
}
],
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}Manage
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 --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)"
}
'{
"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"
]
}
}{
"errors": [
{
"message": "Invalid payload"
}
],
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}{
"errors": [
{
"message": "Forbidden"
}
],
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}{
"errors": [
{
"message": "Not Found"
}
],
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}{
"errors": [
{
"message": "Conflict"
}
],
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}{
"errors": [
{
"message": "Unprocessable Entity"
}
],
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}{
"errors": [
{
"message": "Internal Server Error"
}
],
"metadata": {
"request_id": "9f2c6b18-4e7a-4d05-8c31-0a6e5d2b91f4",
"timestamp": "2026-10-23T09:00:00Z"
}
}Authorizations
API key from the Bigdata Developer Platform.
Path Parameters
The id of the watchlist.
Body
application/json
Was this page helpful?