Create Alert

Create a market-condition alert for the authenticated user.

Available to: All authenticated users

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Creates an Alert owned by the calling user. Supply the alert condition in expression; the server parses it before the alert is saved. When parsing succeeds, the alert is created with status set to Active and the server begins watching for the condition. The response returns the created alert, including its assigned id, which you use for later modifyAlert, dismissAlert, resetAlert, and deleteAlert requests.

Request fields:

• expression (required) — the condition the alert watches for, up to 4096 characters.
• validUntil — optional expiration time; the alert stops watching after this time.
• triggerLimits — optional maximum number of times the alert may trigger (0–10). Once triggeredCounter reaches this value, the alert stops watching until it is reset.
• message — optional text (up to 256 characters) delivered with the alert when it triggers.

When the expression cannot be parsed, the alert is not created and the response carries a non-empty errorText describing the parse problem, with no alert.

Common Failure Scenarios

• The expression is malformed or references an unsupported condition, so it fails to parse.
• The expression exceeds 4096 characters or triggerLimits is outside the 0–10 range.

A created alert is never removed by a trigger. To stop an alert, dismissAlert sets it to Inactive; to re-arm a triggered or failed alert, use resetAlert; to remove it, use deleteAlert.

Error Messages