Modify Scrip Alert
This API allows you to modify an existing alert that has been set for a specific scrip. You can update conditions and other properties of the alert.
🛣️Path Parameters
| Parameter | Type | Required | Description | Example/ENUM |
|---|
| tenantid | string | Yes | Unique identifier for the tenant | ABC123 |
| version | string | Yes | API version (choose between v1 and v2) | v1 |
| Header | Type | Description | Example/ENUM |
|---|
| Authorization | string | Bearer token for API authentication | Bearer{{access_token}} |
| x-api-key | string | API key required to access the resource | {{x-api-key}} |
📦Request Body Schema
Base Request Body
| 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" |
| serverAlertId | string | Unique server-generated ID for the alert | "3c0bca4a-fd94-4d66" |
| UniqueId | string | Unique identifier for the 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 |
🧾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" |