Skip to main content
PATCH
Update a trader

Authorizations

X-API-Key
string
header
required

Organization API key (hp_live_...), sent in the X-API-Key header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A full-access key can call every endpoint in this reference. A read-only key can call GET endpoints (and create a trading stream token); any other request returns 403 READ_ONLY_KEY. A key with an IP allowlist returns 403 IP_NOT_ALLOWED from any other address. Each endpoint lists which keys can call it under Access.

Headers

Idempotency-Key
string

Optional. A value that identifies this operation on your side, at most 255 characters. A retry with the same key, method, path and body within 24 hours returns the original response (with Idempotency-Replayed: true) instead of repeating the change. The same key with a different body returns 409 IDEMPOTENCY_KEY_REUSED; a retry while the first request is still running returns 409 IDEMPOTENCY_KEY_IN_PROGRESS. A response that contains a credential (such as a new API key or signing secret) is not saved: the change is still not repeated, and a retry returns 409 IDEMPOTENCY_KEY_COMPLETED with the original status in originalStatus. Server errors (5xx) are not saved, so a retry runs again. If the key cannot be recorded, the request is not run and returns 503 IDEMPOTENCY_UNAVAILABLE; retry with the same key.

Maximum string length: 255

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. At most 16 KB as JSON, 50 top-level keys and 5 levels of nesting; larger metadata returns 400 METADATA_TOO_LARGE.

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:

"acme-user-4471"

Response

Trader updated successfully

success
boolean
Example:

true

message
string
Example:

"Trader updated successfully"

data
object
Example: