Skip to main content

Delete Watchlist

This API allows a user to delete an existing Watchlist that was created by them. Deletion is version-controlled to prevent accidental overrides.

🔍Query Parameters

ParameterTypeRequiredDescriptionExample/ENUM
idstringYesUnique ID of the Watchlist to be deletedb515ae62-2f92-40ef-845b-309719d8242f
_versionnumberYesCurrent version number of the Watchlist (for safe delete)1

🔑Header Parameters

HeaderTypeRequiredDescriptionExample/ENUM
AuthorizationstringYesBearer token for user authenticationBearer{{access_token}}
x-api-keystringYesAPI key for access control{{x-api-key}}

🟢Success Response - 200 Ok

FieldTypeDescriptionExample/ENUM
statusstringStatus of the API call"success"
codestringResponse code"s-101"
messagestringDescriptive success message"Watchlist Deleted successfully"
dataarray of objectList of Watchlist objectsSee details below

🧭Watchlist Object Schema

FieldTypeDescriptionExample/ENUM
idstringUnique Watchlist ID"32b95c61-370-b215-bb8857f9c949"
sWatchListNamestringName of the Watchlist"My Portfolio"
bIsPrivatebooleanIf true, watchlist is privatetrue
bIsDefaultbooleanIf true, this is the default watchlistfalse
sUserIdstringUser ID of the watchlist creator"user123"
sTenantIdstringTenant/Broker ID"1256878"
sSettingsstringReserved for future (must be valid JSON string)"{\"subCount\":13}"
scripsarrayList of scrips within the watchlistSee Scrip Object below
_versionnumberVersion number of the watchlist1
_deletedbooleanFlag to indicate if deletedtrue
_lastChangedAtnumberEpoch timestamp of last change1718008123
createdAtstringISO date-time of watchlist creation"2025-06-01T12:00:00Z"
updatedAtstringISO date-time of last update"2025-06-10T09:45:00Z"

📝Scrip Objects

FieldTypeRequiredDescriptionExample/ENUM
nMarketSegmentIdnumberYesExchange segment ID
1
nTokennumberYesExchange token number for the scrip123456
nSequenceNonumberYesSequence number in the Watchlist1, 2, ...
sSettingsstringNoReserved for future settings (JSON string)""
delete/nontransactional/v1/watchListProfile