Modify Order Strategy
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
Response
Non-empty if the request failed
Bearer authentication of the form Bearer <token>, where token is your auth token.
Non-empty if the request failed
Available to: All authenticated users
Environments: Demo, Live
Rate Limit: 500 requests per hour, 2-second back-off, counts all requests
Sends a command to an Order Strategy that is already running, identified by its orderStrategyId. Order strategies are the multi-bracket constructs created with startOrderStrategy; this endpoint adjusts one of those strategies after it is live without tearing it down and rebuilding it. To stop a strategy entirely, use interruptOrderStrategy instead.
The request body requires orderStrategyId and a command string (up to 1024 characters) describing the change to apply. The optional customTag50 carries a registered tag; if your account requires tag50 registration, an unregistered tag is rejected before the command runs.
As with other order commands, success is not guaranteed — the underlying orders may already have filled, the strategy may have completed, or the exchange may reject the change. The endpoint returns an OrderStrategyStatusResponse. When the request is rejected, the response carries a failureReason and an errorText describing the problem; on success the response includes the updated orderStrategy.
Common Failure Scenarios
TooLate).AnotherCommandPending).Unauthorized).customTag50 is missing or unregistered.Error Messages
See the failureReason enum in the OrderStrategyStatusResponse schema for the complete list of values.