Delete Multiple Alerts
This API allows you to delete multiple alerts that are already set for a user.
🔑Header Parameters
| Header | Type | Description | Example |
|---|---|---|---|
| Authorization | string | Bearer token for authentication | Bearer{{access_token}} |
| Content-Type | string | Specifies request content type | application/json |
| x-api-key | string | API key used for security/auth | {{x-api-key}} |
📄Request Body Schema
Base Request Body
| Field | Type | Description | Example |
|---|---|---|---|
| data | object | List of alerts set by the user | See details below |
📦Data Object Structure Fields
| Field | Type | Description | Example |
|---|---|---|---|
| condition | Array of object | An array of conditions. Each condition is an object. | See details below |
| data | object | Contains additional data as key-value pairs | See details below |
| expiration | integer | The expiration timestamp. | -1 |
| createDate | string | The creation date and time | "2025-07-25T13:00:54.907" |
| tenantId | string | Unique identifier for the tenant. | 1404 |
| workerId | string | Identifier for the worker processing the alert. | "worker_alerts_eq_e88bf5f7-d7e6" |
| triggered | integer | Whether the alert has been triggered (1 = triggered, 0 = not triggered). | 1 |
| entryTime | string | Time the alert was initially set (ISO 8601 format) | 2025-06-01T09:00:00Z |
| UCC | string | UCC (Unique Client Code) associated with the alert | UCC_12345 |
| MessageType | string | Type of message related to the alert | USR_Alert |
| serverAlertId | string | Server-specific ID for this alert | "c70d7f4c-709d-4ec4-a42" |
| UniqueId | integer | Unique identifier for this alert | alert_5678 |
📑Condition Object (Array Of Objects)
| Field | Type | Description | Example |
|---|---|---|---|
| operand1 | object | First operand object containing market segment, token, and field | See details below |
| operand2 | object | Second operand object containing market segment, token, field, and value | See details below |
| operator | string | Operator to compare operand values (e.g., >, <, =) | > |
🛈Operand1 Object
| Field | Type | Description | Example/ENUM |
|---|---|---|---|
| marketsegment | integer | Market segment identifier | 1 |
| token | integer | Token number from the exchange scrip master file | 12345 |
| field | string | Field to compare, e.g., LIFETIMEHIGH, LIFETIMELOW, etc. | "LastTraderPrice" |
🛈Operand2 Object
| Field | Type | Description | Example |
|---|---|---|---|
| marketsegment | integer | Market segment identifier | 1 |
| token | integer | Token number from the exchange scrip master file | 12345 |
| field | string | Field to compare, e.g., LIFETIMEHIGH, LIFETIMELOW, etc. | "USE_VALUE" |
| value | integer | Value to compare against the field | 15000 |
🛈Additional Data Object Fields
| Field | Type | Description | Example/ENUM |
|---|---|---|---|
| remarks | string | Additional remarks or comments | "Alert : AXISBANK price exceeds ₹700" |
| userid | string | User ID for whom the alert is being set | user_123 |
| tenantid | string | Tenant ID | ABC123 |
| symbol | string | Symbol code for the scrip | "AXISBANK" |
| alertType | string | Type of alert (e.g., LIFETIMEHIGH, LASTTRADEDPRICE) | LIFETIMEHIGH |
| category | string | Category of alert | "EQ" |
🟢Success Response - 200 Ok
| Field | Type | Description | Example/ENUM |
|---|---|---|---|
| status | string | Status of the API call | "success" |
| code | string | Response code for the user request | "s-101" |
| message | string | Message describing feedback on the request | "Alert modified" |
| data | object | Contains details about the created alert | See details below |
📄Data Object Field
| Field | Type | Description | Example/ENUM |
|---|---|---|---|
| alertId | string | Unique identifier for the created alert | "1103c5f6-1993-4f68-8cd3" |
post
/alert-nodeengine/{tenantid}/v2/alerts/deleteScripAlert