Skip to content
Get started

Delete Watchlist

$ clear-street v1:watchlist delete-watchlist
DELETE/v1/watchlists/{watchlist_id}

Delete a watchlist and all its items

ParametersExpand Collapse
--watchlist-id: string

Watchlist ID

ReturnsExpand Collapse
V1WatchlistDeleteWatchlistResponse: unknown

Delete Watchlist

clear-street v1:watchlist delete-watchlist \
  --api-key 'My API Key' \
  --watchlist-id 550e8400-e29b-41d4-a716-446655440000
{
  "data": null,
  "metadata": {
    "request_id": "cb824f1b-ea6e-4045-8169-9503be2b24d7"
  }
}
{
  "error": {
    "code": 404,
    "message": "Some requested entity was not found"
  },
  "metadata": {
    "request_id": "b8e5824d-391f-448c-a183-9d1582170a1c"
  }
}
Returns Examples
{
  "data": null,
  "metadata": {
    "request_id": "cb824f1b-ea6e-4045-8169-9503be2b24d7"
  }
}
{
  "error": {
    "code": 404,
    "message": "Some requested entity was not found"
  },
  "metadata": {
    "request_id": "b8e5824d-391f-448c-a183-9d1582170a1c"
  }
}