Skip to main content
PATCH
Update a trader

Authorizations

Authorization
string
header
required

JWT Bearer token for user session auth. Format: "Bearer {token}". Used by User and Organization endpoints.

Path Parameters

traderId
string
required

The Hyperprop user ID (from GET /organization/traders list)

Body

application/json
metadata
object

Custom metadata. Replaces existing metadata wholesale unless mergeMetadata is true.

Example:
mergeMetadata
boolean

When true, the provided metadata keys are merged into the existing metadata instead of replacing it entirely

Example:

true

externalUserId
string

Your own queryable reference for this trader (null clears it). Look traders up later with GET /traders?externalUserId=...; also returned as trader.externalUserId in account payloads and webhooks.

Maximum string length: 255
Example:

"mffu-user-4471"

Response

Trader updated successfully

success
boolean
Example:

true

message
string
Example:

"Trader updated successfully"

data
object
Example: