Only
price and quantity may be changed.
- You must specify the stop_order’s
stop_order_id(UUID v4). - You must specify the
symbol. - You must specify the
side. - You must specify the
order_type. client_order_idcannot be used for modifies.
1) Authenticate
Send this immediately after you connect:2) Modify Order
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
stop_order_id | string | ✅ | UUID v4 of the order to modify. |
symbol | string | ✅ | The market symbol (e.g. AAPL-USD). |
side | enum | ✅ | Must match the original stop order’s side. See OrderDirection. |
order_type | enum | ✅ | Must match the original stop order’s type. See OrderType. |
quantity | number | Optional | New stop order quantity. Must respect symbol lot size, min, and max constraints. |
price | number | Optional | New price for when the order is triggered. Must respect tick size but not price bands. |
⚠️ Notes:
- Only
priceandquantitymay be modified.
Sample Code
Example Response
When an order is successfully modified, you receive the sameorder_response object as with add, but with status MODIFIED: