Skip to main content

Delete Multiple Alerts

This API allows you to delete multiple alerts that are already set for a user.

🔑Header Parameters

HeaderTypeDescriptionExample
AuthorizationstringBearer token for authenticationBearer{{access_token}}
Content-TypestringSpecifies request content typeapplication/json
x-api-keystringAPI key used for security/auth{{x-api-key}}

📄Request Body Schema

Base Request Body

FieldTypeDescriptionExample
dataobjectList of alerts set by the userSee details below

📦Data Object Structure Fields

FieldTypeDescriptionExample
conditionArray of objectAn array of conditions. Each condition is an object.See details below
dataobjectContains additional data as key-value pairsSee details below
expirationintegerThe expiration timestamp.-1
createDatestringThe creation date and time"2025-07-25T13:00:54.907"
tenantIdstringUnique identifier for the tenant.1404
workerIdstringIdentifier for the worker processing the alert."worker_alerts_eq_e88bf5f7-d7e6"
triggeredintegerWhether the alert has been triggered (1 = triggered, 0 = not triggered).1
entryTimestringTime the alert was initially set (ISO 8601 format)2025-06-01T09:00:00Z
UCCstringUCC (Unique Client Code) associated with the alertUCC_12345
MessageTypestringType of message related to the alertUSR_Alert
serverAlertIdstringServer-specific ID for this alert"c70d7f4c-709d-4ec4-a42"
UniqueIdintegerUnique identifier for this alertalert_5678

📑Condition Object (Array Of Objects)

FieldTypeDescriptionExample
operand1objectFirst operand object containing market segment, token, and fieldSee details below
operand2objectSecond operand object containing market segment, token, field, and valueSee details below
operatorstringOperator to compare operand values (e.g., >, <, =)>

🛈Operand1 Object

FieldTypeDescriptionExample/ENUM
marketsegmentintegerMarket segment identifier1
tokenintegerToken number from the exchange scrip master file12345
fieldstringField to compare, e.g., LIFETIMEHIGH, LIFETIMELOW, etc."LastTraderPrice"

🛈Operand2 Object

FieldTypeDescriptionExample
marketsegmentintegerMarket segment identifier1
tokenintegerToken number from the exchange scrip master file12345
fieldstringField to compare, e.g., LIFETIMEHIGH, LIFETIMELOW, etc."USE_VALUE"
valueintegerValue to compare against the field15000

🛈Additional Data Object Fields

FieldTypeDescriptionExample/ENUM
remarksstringAdditional remarks or comments"Alert : AXISBANK price exceeds ₹700"
useridstringUser ID for whom the alert is being setuser_123
tenantidstringTenant IDABC123
symbolstringSymbol code for the scrip"AXISBANK"
alertTypestringType of alert (e.g., LIFETIMEHIGH, LASTTRADEDPRICE)LIFETIMEHIGH
categorystringCategory of alert"EQ"

🟢Success Response - 200 Ok

FieldTypeDescriptionExample/ENUM
statusstringStatus of the API call"success"
codestringResponse code for the user request"s-101"
messagestringMessage describing feedback on the request"Alert modified"
dataobjectContains details about the created alertSee details below

📄Data Object Field

FieldTypeDescriptionExample/ENUM
alertIdstringUnique identifier for the created alert"1103c5f6-1993-4f68-8cd3"
post/alert-nodeengine/{tenantid}/v2/alerts/deleteScripAlert