Traders

Update a trader

Update an organization trader’s metadata or external reference. Only organization admins can update traders.

The traderId is the Hyperprop user ID (the userId field from the GET /organization/traders list).

Allowed fields:

Field	Description
`metadata`	Custom organization data about this trader (replaces existing)
`mergeMetadata`	`true` = merge the provided metadata keys instead of replacing
`externalUserId`	Queryable external reference — your own user ID for this trader. Look them up with `GET /traders?externalUserId=...` (send `null` to clear)

Use metadata to store any organization-specific data about traders, such as:

Internal customer IDs
Customer tier/level
Notes
Custom tags

Use externalUserId (rather than metadata) for the one reference you want to query by — it is indexed and exact-match filterable, and flows through webhook payloads as trader.externalUserId.

Example - Update metadata:

curl -X PATCH "https://api.hyperprop.com/platform/v1/organization/traders/{userId}" \
  -H "X-API-Key: hp_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"metadata": {"customerTier": "platinum", "internalId": "CUST-12345", "notes": "VIP customer"}}'

Example - Set your external reference:

curl -X PATCH "https://api.hyperprop.com/platform/v1/organization/traders/{userId}" \
  -H "X-API-Key: hp_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"externalUserId": "acme-user-4471"}'

To clear metadata:

curl -X PATCH "https://api.hyperprop.com/platform/v1/organization/traders/{userId}" \
  -H "X-API-Key: hp_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"metadata": {}}'

Permissions: Only organization admins can update traders.

PATCH

organization

traders

{traderId}

Update a trader

curl --request PATCH \
  --url https://api.hyperprop.com/platform/v1/organization/traders/{traderId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "metadata": {
    "customerTier": "gold",
    "notes": "VIP customer",
    "internalId": "12345"
  },
  "mergeMetadata": true,
  "externalUserId": "acme-user-4471"
}
'

import requests

url = "https://api.hyperprop.com/platform/v1/organization/traders/{traderId}"

payload = {
    "metadata": {
        "customerTier": "gold",
        "notes": "VIP customer",
        "internalId": "12345"
    },
    "mergeMetadata": True,
    "externalUserId": "acme-user-4471"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    metadata: {customerTier: 'gold', notes: 'VIP customer', internalId: '12345'},
    mergeMetadata: true,
    externalUserId: 'acme-user-4471'
  })
};

fetch('https://api.hyperprop.com/platform/v1/organization/traders/{traderId}', 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/traders/{traderId}",
  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' => [
        'customerTier' => 'gold',
        'notes' => 'VIP customer',
        'internalId' => '12345'
    ],
    'mergeMetadata' => true,
    'externalUserId' => 'acme-user-4471'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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/traders/{traderId}"

	payload := strings.NewReader("{\n  \"metadata\": {\n    \"customerTier\": \"gold\",\n    \"notes\": \"VIP customer\",\n    \"internalId\": \"12345\"\n  },\n  \"mergeMetadata\": true,\n  \"externalUserId\": \"acme-user-4471\"\n}")

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

	req.Header.Add("X-API-Key", "<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/traders/{traderId}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"metadata\": {\n    \"customerTier\": \"gold\",\n    \"notes\": \"VIP customer\",\n    \"internalId\": \"12345\"\n  },\n  \"mergeMetadata\": true,\n  \"externalUserId\": \"acme-user-4471\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/traders/{traderId}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"metadata\": {\n    \"customerTier\": \"gold\",\n    \"notes\": \"VIP customer\",\n    \"internalId\": \"12345\"\n  },\n  \"mergeMetadata\": true,\n  \"externalUserId\": \"acme-user-4471\"\n}"

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

{
  "success": true,
  "message": "Trader updated successfully",
  "data": {
    "userId": "f994bc02-343c-4026-8a57-afc085eca8d5",
    "organizationUserId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "email": "trader@example.com",
    "fullName": "John Smith",
    "externalUserId": "acme-user-4471",
    "metadata": {
      "customerTier": "gold",
      "notes": "VIP customer",
      "supportPriority": "high"
    },
    "createdAt": "2026-01-15T10:00:00.000Z",
    "updatedAt": "2026-02-17T14:30:00.000Z"
  }
}

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

{
  "success": false,
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required",
  "code": "UNAUTHORIZED"
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Admin access required",
  "code": "ADMIN_REQUIRED"
}

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Trader not found",
  "code": "TRADER_NOT_FOUND"
}

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

Authorizations

X-API-Key

string

header

required

Organization API key. Format: "hp_live_{key}". Organization admins manage the key in the dashboard.

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:

{
  "customerTier": "gold",
  "notes": "VIP customer",
  "internalId": "12345"
}

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

Show child attributes

Example:

{
  "userId": "f994bc02-343c-4026-8a57-afc085eca8d5",
  "organizationUserId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "email": "trader@example.com",
  "fullName": "John Smith",
  "externalUserId": "acme-user-4471",
  "metadata": {
    "customerTier": "gold",
    "notes": "VIP customer",
    "supportPriority": "high"
  },
  "createdAt": "2026-01-15T10:00:00.000Z",
  "updatedAt": "2026-02-17T14:30:00.000Z"
}

⌘I

Update a trader

curl --request PATCH \
  --url https://api.hyperprop.com/platform/v1/organization/traders/{traderId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "metadata": {
    "customerTier": "gold",
    "notes": "VIP customer",
    "internalId": "12345"
  },
  "mergeMetadata": true,
  "externalUserId": "acme-user-4471"
}
'

import requests

url = "https://api.hyperprop.com/platform/v1/organization/traders/{traderId}"

payload = {
    "metadata": {
        "customerTier": "gold",
        "notes": "VIP customer",
        "internalId": "12345"
    },
    "mergeMetadata": True,
    "externalUserId": "acme-user-4471"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    metadata: {customerTier: 'gold', notes: 'VIP customer', internalId: '12345'},
    mergeMetadata: true,
    externalUserId: 'acme-user-4471'
  })
};

fetch('https://api.hyperprop.com/platform/v1/organization/traders/{traderId}', 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/traders/{traderId}",
  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' => [
        'customerTier' => 'gold',
        'notes' => 'VIP customer',
        'internalId' => '12345'
    ],
    'mergeMetadata' => true,
    'externalUserId' => 'acme-user-4471'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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/traders/{traderId}"

	payload := strings.NewReader("{\n  \"metadata\": {\n    \"customerTier\": \"gold\",\n    \"notes\": \"VIP customer\",\n    \"internalId\": \"12345\"\n  },\n  \"mergeMetadata\": true,\n  \"externalUserId\": \"acme-user-4471\"\n}")

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

	req.Header.Add("X-API-Key", "<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/traders/{traderId}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"metadata\": {\n    \"customerTier\": \"gold\",\n    \"notes\": \"VIP customer\",\n    \"internalId\": \"12345\"\n  },\n  \"mergeMetadata\": true,\n  \"externalUserId\": \"acme-user-4471\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/traders/{traderId}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"metadata\": {\n    \"customerTier\": \"gold\",\n    \"notes\": \"VIP customer\",\n    \"internalId\": \"12345\"\n  },\n  \"mergeMetadata\": true,\n  \"externalUserId\": \"acme-user-4471\"\n}"

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

{
  "success": true,
  "message": "Trader updated successfully",
  "data": {
    "userId": "f994bc02-343c-4026-8a57-afc085eca8d5",
    "organizationUserId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "email": "trader@example.com",
    "fullName": "John Smith",
    "externalUserId": "acme-user-4471",
    "metadata": {
      "customerTier": "gold",
      "notes": "VIP customer",
      "supportPriority": "high"
    },
    "createdAt": "2026-01-15T10:00:00.000Z",
    "updatedAt": "2026-02-17T14:30:00.000Z"
  }
}

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

{
  "success": false,
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required",
  "code": "UNAUTHORIZED"
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Admin access required",
  "code": "ADMIN_REQUIRED"
}

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Trader not found",
  "code": "TRADER_NOT_FOUND"
}

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

Platform API

Trade API

Update a trader

Authorizations

Path Parameters

Body

Response