Skip to main content
PATCH
Update an order

Authorizations

x-definitive-api-key
string
header
default:dpka_513a2bd7_57a2_46d2_927b_2a3857fe271b
required

Your Definitive API key.

Path Parameters

orderId
string<uuid>
required

Flash order ID.

Body

application/json
updateMessage
string
required

UTF-8 plaintext the funder wallet signed. Binds the order id, an RFC3339 Issued At: freshness stamp, and every updated value. Format:

The Limit line (Limit Cross Price: or Limit Notional Price:) and the Trigger line (Trigger <Lower|Upper> <Cross|Notional> Price:, direction matching trigger.triggerType) are each optional and appear at most once, matching the request fields; at least one is required, and when both are present the Limit line comes first. Same bytes across EVM and SVM.

Minimum string length: 1
userSignature
string
required

Funder wallet signature over updateMessage. Accepts 0x-prefixed hex (EVM convention) or base58 (Solana convention). EVM: 65 bytes from EIP-191 personal_sign. SVM: 64 bytes from Ed25519.

Minimum string length: 1
limitNotionalPrice
string

New USD limit price for the traded (targetAsset) asset. Mutually exclusive with limitCrossPrice; set exactly one. Must equal the value signed in updateMessage exactly — no normalization is applied.

Example:

"4000"

limitCrossPrice
string

New pair-rate limit price — how many contraAsset units one targetAsset unit is worth. Mutually exclusive with limitNotionalPrice; set exactly one. Must equal the value signed in updateMessage exactly — no normalization is applied.

Example:

"4000"

trigger
object

New trigger price for a single-trigger order (stop, stop-loss / stop-limit, take-profit / take-profit-limit). Not valid on limit orders. On the market-execution types (stop, take-profit) the trigger is the only updatable field; on the -limit variants a trigger and/or a limit can travel in one update. A trigger update moves the threshold only: the direction and the price basis (cross vs notional) must match what the order's trigger was placed with — unlike the limit price, the trigger's basis cannot be switched by an update.

Response

Order updated successfully

ok
enum<boolean>
required
Available options:
true