Organization

Update a trading account

Update an existing trading account. This is the endpoint for reflecting anything that happens on your side — payouts, manual passes, balance corrections, risk decisions — onto the account. Only organization admins (or API keys with write/admin permission) can update accounts.

Allowed fields:

Field	Description
`status`	Account status: `not_started`, `in_progress`, `passed`, `failed`, `expired`
`initialBalance`	Starting balance
`currentBalance`	Current balance
`highWaterMark`	Highest balance achieved
`customerId`	Reassign the account to a different customer of yours (resale, correction). Look accounts up later with `GET /trading-accounts?customerId=...`. Cannot be cleared, and on linked accounts the new customer must not be soulbound to a different Hyperprop login (`409 CUSTOMER_ALREADY_BOUND`)
`metadata`	Custom JSON — notes, tags, payout records, anything you need (see merge semantics below)
`mergeMetadata`	`true` = merge the provided keys into existing metadata. Omitted/`false` = replace metadata wholesale
`reason`	Why you made the change — stored in the audit trail and included in webhook events

Metadata: replace vs merge

By default, metadata replaces the stored object entirely. Send "mergeMetadata": true to update only the keys you pass and preserve the rest:

// Stored:  { "tier": "gold", "notes": "VIP" }
// Request: { "metadata": { "notes": "VIP - churned" }, "mergeMetadata": true }
// Result:  { "tier": "gold", "notes": "VIP - churned" }

The merge is shallow (top-level keys only). Nested objects and arrays are replaced as a whole — so to append to an array (e.g. a payouts list), first read the current metadata via GET /trading-accounts/{accountId}, append your entry, and send the full array back with mergeMetadata: true. Metadata is opaque to Hyperprop: we store and return it verbatim, but never compute on it.

Recipe — record a payout / balance withdrawal:

Hyperprop has no built-in payout ledger — payouts stay in your system. The pattern below reflects the withdrawal on the balance and keeps an auditable record on the account:

curl -X PATCH "https://api.example.com/platform/v1/organization/trading-accounts/{accountId}" \
  -H "X-API-Key: hp_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "currentBalance": 48000,
    "reason": "Payout PO-1042 - 2000 USD withdrawal",
    "mergeMetadata": true,
    "metadata": {
      "payouts": [
        { "id": "PO-1042", "type": "balance_withdrawal", "amount": 2000, "currency": "USD", "date": "2026-07-08", "status": "paid" }
      ],
      "totalPaidOut": 2000
    }
  }'

The same pattern works for any custom workflow (e.g. recording a drawdown-lock decision under a metadata.mll key): make the risk decision in your system, then persist the resulting balance/status here plus a metadata record of why.

Example — manually pass an account:

curl -X PATCH "https://api.example.com/platform/v1/organization/trading-accounts/{accountId}" \
  -H "X-API-Key: hp_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"status": "passed", "reason": "Trader hit target during feed outage", "mergeMetadata": true, "metadata": {"manualPass": true}}'

Example — balance correction:

curl -X PATCH "https://api.example.com/platform/v1/organization/trading-accounts/{accountId}" \
  -H "X-API-Key: hp_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"currentBalance": 52500, "highWaterMark": 52500, "reason": "Balance adjustment for data feed error"}'

Status change side effects:

passed, failed, or expired automatically sets completedAt (and may end the trader’s market-data entitlement)
not_started clears startedAt, completedAt, and violationReason (full reset)

Audit trail & webhooks: Every change is logged with before/after values and who made it — inspect via GET /trading-accounts/{accountId}/changes or the org-wide GET /audit-log. Changes made with an API key are attributed to that key (adminEmail: "api-key", with the key’s ID recorded); session changes are attributed to the admin’s email. Changes also emit webhook events to your configured endpoints: account.status_changed (plus account.passed/account.failed convenience events) for status changes, and account.updated for balance/metadata changes — each carrying your reason and the previous values.

Error responses: Every error returns { statusCode, error, message, code } — switch on code:

Status	`code`	When
400	`VALIDATION_ERROR`	Payload failed validation (empty payload, invalid status value, wrong types)
400	`NO_FIELDS_TO_UPDATE`	No updatable field was provided
401	`UNAUTHORIZED`	Missing/invalid API key or session
403	`INSUFFICIENT_PERMISSIONS` / `NOT_ADMIN`	Key or user lacks admin/write permission
403	`ACCOUNT_NOT_IN_ORG`	The account belongs to a different organization
404	`ACCOUNT_NOT_FOUND`	No account with this ID
500	`UPDATE_ACCOUNT_ERROR`	Unexpected server error

PATCH

organization

trading-accounts

{accountId}

Update a trading account

curl --request PATCH \
  --url https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "notes": "VIP customer",
    "supportTicket": "TKT-123"
  },
  "mergeMetadata": true,
  "status": "passed",
  "initialBalance": 100000,
  "currentBalance": 105000,
  "highWaterMark": 107500,
  "customerId": "mffu-cust-4471",
  "externalRef": "mffu-cust-4471",
  "reason": "Balance adjustment for data feed error"
}
'

import requests

url = "https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}"

payload = {
    "metadata": {
        "notes": "VIP customer",
        "supportTicket": "TKT-123"
    },
    "mergeMetadata": True,
    "status": "passed",
    "initialBalance": 100000,
    "currentBalance": 105000,
    "highWaterMark": 107500,
    "customerId": "mffu-cust-4471",
    "externalRef": "mffu-cust-4471",
    "reason": "Balance adjustment for data feed error"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    metadata: {notes: 'VIP customer', supportTicket: 'TKT-123'},
    mergeMetadata: true,
    status: 'passed',
    initialBalance: 100000,
    currentBalance: 105000,
    highWaterMark: 107500,
    customerId: 'mffu-cust-4471',
    externalRef: 'mffu-cust-4471',
    reason: 'Balance adjustment for data feed error'
  })
};

fetch('https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'metadata' => [
        'notes' => 'VIP customer',
        'supportTicket' => 'TKT-123'
    ],
    'mergeMetadata' => true,
    'status' => 'passed',
    'initialBalance' => 100000,
    'currentBalance' => 105000,
    'highWaterMark' => 107500,
    'customerId' => 'mffu-cust-4471',
    'externalRef' => 'mffu-cust-4471',
    'reason' => 'Balance adjustment for data feed error'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}"

	payload := strings.NewReader("{\n  \"metadata\": {\n    \"notes\": \"VIP customer\",\n    \"supportTicket\": \"TKT-123\"\n  },\n  \"mergeMetadata\": true,\n  \"status\": \"passed\",\n  \"initialBalance\": 100000,\n  \"currentBalance\": 105000,\n  \"highWaterMark\": 107500,\n  \"customerId\": \"mffu-cust-4471\",\n  \"externalRef\": \"mffu-cust-4471\",\n  \"reason\": \"Balance adjustment for data feed error\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"metadata\": {\n    \"notes\": \"VIP customer\",\n    \"supportTicket\": \"TKT-123\"\n  },\n  \"mergeMetadata\": true,\n  \"status\": \"passed\",\n  \"initialBalance\": 100000,\n  \"currentBalance\": 105000,\n  \"highWaterMark\": 107500,\n  \"customerId\": \"mffu-cust-4471\",\n  \"externalRef\": \"mffu-cust-4471\",\n  \"reason\": \"Balance adjustment for data feed error\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"metadata\": {\n    \"notes\": \"VIP customer\",\n    \"supportTicket\": \"TKT-123\"\n  },\n  \"mergeMetadata\": true,\n  \"status\": \"passed\",\n  \"initialBalance\": 100000,\n  \"currentBalance\": 105000,\n  \"highWaterMark\": 107500,\n  \"customerId\": \"mffu-cust-4471\",\n  \"externalRef\": \"mffu-cust-4471\",\n  \"reason\": \"Balance adjustment for data feed error\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Trading account updated successfully",
  "data": {
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "accountNumber": "ACC-MKVEUQWQ",
    "type": "evaluation",
    "status": "passed",
    "initialBalance": 100000,
    "currentBalance": 110000,
    "highWaterMark": 112000,
    "dailyStartingBalance": 109000,
    "startedAt": "2025-01-16T09:00:00.000Z",
    "completedAt": "2025-02-15T16:30:00.000Z",
    "violationReason": null,
    "metadata": {},
    "userId": "f994bc02-343c-4026-8a57-afc085eca8d5",
    "createdAt": "2025-01-15T10:00:00.000Z",
    "updatedAt": "2025-02-17T14:30:00.000Z"
  }
}

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "No valid fields to update",
  "code": "NO_FIELDS_TO_UPDATE"
}

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid or expired session"
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "This account does not belong to your organization",
  "code": "ACCOUNT_NOT_IN_ORG"
}

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Trading account not found",
  "code": "ACCOUNT_NOT_FOUND"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

accountId

string

required

The trading account ID

Body

application/json

metadata

object

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

Example:

{
  "notes": "VIP customer",
  "supportTicket": "TKT-123"
}

mergeMetadata

boolean

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

Example:

true

status

enum<string>

Account status

Available options:

not_started,

in_progress,

passed,

failed,

expired

Example:

"passed"

initialBalance

number

Initial account balance

Example:

100000

currentBalance

number

Current account balance

Example:

105000

highWaterMark

number

Highest balance achieved

Example:

107500

customerId

string

Reassign the account to a different customer of yours (resale, correction). Cannot be cleared — every account always has a customerId. On linked accounts the new customerId must not be bound to a different Hyperprop login (409 CUSTOMER_ALREADY_BOUND).

Maximum string length: 255

Example:

"mffu-cust-4471"

externalRef

string

DEPRECATED alias for customerId — use customerId instead. Null is ignored (customerId cannot be cleared).

Maximum string length: 255

Example:

"mffu-cust-4471"

reason

string

Reason for the change (logged in audit trail)

Example:

"Balance adjustment for data feed error"

Response

Account updated successfully

success

boolean

Example:

true

message

string

Example:

"Trading account updated successfully"

data

object

Show child attributes

⌘I

Update a trading account

curl --request PATCH \
  --url https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "notes": "VIP customer",
    "supportTicket": "TKT-123"
  },
  "mergeMetadata": true,
  "status": "passed",
  "initialBalance": 100000,
  "currentBalance": 105000,
  "highWaterMark": 107500,
  "customerId": "mffu-cust-4471",
  "externalRef": "mffu-cust-4471",
  "reason": "Balance adjustment for data feed error"
}
'

import requests

url = "https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}"

payload = {
    "metadata": {
        "notes": "VIP customer",
        "supportTicket": "TKT-123"
    },
    "mergeMetadata": True,
    "status": "passed",
    "initialBalance": 100000,
    "currentBalance": 105000,
    "highWaterMark": 107500,
    "customerId": "mffu-cust-4471",
    "externalRef": "mffu-cust-4471",
    "reason": "Balance adjustment for data feed error"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    metadata: {notes: 'VIP customer', supportTicket: 'TKT-123'},
    mergeMetadata: true,
    status: 'passed',
    initialBalance: 100000,
    currentBalance: 105000,
    highWaterMark: 107500,
    customerId: 'mffu-cust-4471',
    externalRef: 'mffu-cust-4471',
    reason: 'Balance adjustment for data feed error'
  })
};

fetch('https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'metadata' => [
        'notes' => 'VIP customer',
        'supportTicket' => 'TKT-123'
    ],
    'mergeMetadata' => true,
    'status' => 'passed',
    'initialBalance' => 100000,
    'currentBalance' => 105000,
    'highWaterMark' => 107500,
    'customerId' => 'mffu-cust-4471',
    'externalRef' => 'mffu-cust-4471',
    'reason' => 'Balance adjustment for data feed error'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}"

	payload := strings.NewReader("{\n  \"metadata\": {\n    \"notes\": \"VIP customer\",\n    \"supportTicket\": \"TKT-123\"\n  },\n  \"mergeMetadata\": true,\n  \"status\": \"passed\",\n  \"initialBalance\": 100000,\n  \"currentBalance\": 105000,\n  \"highWaterMark\": 107500,\n  \"customerId\": \"mffu-cust-4471\",\n  \"externalRef\": \"mffu-cust-4471\",\n  \"reason\": \"Balance adjustment for data feed error\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"metadata\": {\n    \"notes\": \"VIP customer\",\n    \"supportTicket\": \"TKT-123\"\n  },\n  \"mergeMetadata\": true,\n  \"status\": \"passed\",\n  \"initialBalance\": 100000,\n  \"currentBalance\": 105000,\n  \"highWaterMark\": 107500,\n  \"customerId\": \"mffu-cust-4471\",\n  \"externalRef\": \"mffu-cust-4471\",\n  \"reason\": \"Balance adjustment for data feed error\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"metadata\": {\n    \"notes\": \"VIP customer\",\n    \"supportTicket\": \"TKT-123\"\n  },\n  \"mergeMetadata\": true,\n  \"status\": \"passed\",\n  \"initialBalance\": 100000,\n  \"currentBalance\": 105000,\n  \"highWaterMark\": 107500,\n  \"customerId\": \"mffu-cust-4471\",\n  \"externalRef\": \"mffu-cust-4471\",\n  \"reason\": \"Balance adjustment for data feed error\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Trading account updated successfully",
  "data": {
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "accountNumber": "ACC-MKVEUQWQ",
    "type": "evaluation",
    "status": "passed",
    "initialBalance": 100000,
    "currentBalance": 110000,
    "highWaterMark": 112000,
    "dailyStartingBalance": 109000,
    "startedAt": "2025-01-16T09:00:00.000Z",
    "completedAt": "2025-02-15T16:30:00.000Z",
    "violationReason": null,
    "metadata": {},
    "userId": "f994bc02-343c-4026-8a57-afc085eca8d5",
    "createdAt": "2025-01-15T10:00:00.000Z",
    "updatedAt": "2025-02-17T14:30:00.000Z"
  }
}

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "No valid fields to update",
  "code": "NO_FIELDS_TO_UPDATE"
}

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid or expired session"
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "This account does not belong to your organization",
  "code": "ACCOUNT_NOT_IN_ORG"
}

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Trading account not found",
  "code": "ACCOUNT_NOT_FOUND"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Platform API

Trade API

Market Data API

Update a trading account

Authorizations

Path Parameters

Body

Response