Submit an update request for an individual Omnibus order.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Submits an update request for an individual Omnibus order. Note that pending the Order's status, it may or may not be eligible to be updated.

Notes:

  • At least one of quantity, notionalAmount, or taxLotElection must change.
    quantity and notionalAmount cannot both be supplied.
  • Updated size must be greater than zero or the minimum commitment amount, if applicable.
  • Updated SELL Orders may not be updated to an amount larger than the investor's holding.
  • Orders can be updated only in the Received, PendingActions, PendingExecution, or PartiallyFilled statuses.
  • Individual Orders linked to a Model Order cannot be updated directly. Use the model-order workflow instead.
  • Only one update request is allowed at a time, per Order.
  • If the order is still PendingActions, the update is applied locally and accepted immediately.

Path Params
uuid
required

Internal Monark order identifier.

Body Params

Updated order details. Only quantity, notionalAmount, and taxLotElection are amendable.

Request model for amending a pending Omnibus order through Settlement.

double | null

Replacement share quantity for sell orders.

double | null

Replacement dollar notional amount for buy orders.

string | null
enum

Replacement tax lot election.

Allowed:
taxLotIds
array of uuids | null

Replacement tax lot identifiers to sell first, in priority order. Sell orders only.
Omit to keep the current lots, or send an empty list to clear them.

taxLotIds
string | null

Operational reason sent to Settlement.

string | null

Optional actor identifier sent to Settlement.

Responses
202

Update request was accepted or queued for downstream processing.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json