latestOpenAPI 3.1.02026-08-22181751733.6 KB

67f9f562c2c6

tradingAlerts

Activate Or Deactivate An Alert

Activate or Deactivate existing alerts created for this account. This does not delete alerts, but disables notifications until reactivated.

post/iserver/account/{accountId}/alert/activate

Path parameters

accountIdstring required

Request body

alertIdinteger required

The alert Identifier

alertActive'1' | '0' required

Set whether or not the alert should be active (1) or inactive (0).

Response

An object containing details about the activated/deactivated alert.

request_idinteger
order_idinteger

The tracking number of the alert. Occasssionally referenced as the alertId or alert_id.

successboolean

Displays result status of alert request

textstring

Response message to clarify success status reason.

failure_liststring

If "success" returns false, will list failed order Ids