> ## Documentation Index > Fetch the complete documentation index at: https://docs.hyperprop.com/llms.txt > Use this file to discover all available pages before exploring further. # 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:** ```bash 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:** ```bash 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:** ```bash 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. ## OpenAPI ````yaml /api-reference/openapi.json patch /v1/organization/traders/{traderId} openapi: 3.0.0 info: title: Hyperprop Platform API version: 1.0.0 description: >- REST API for the Hyperprop Trading Platform — provision evaluation and funded trading accounts, manage traders and plans, react to account lifecycle events via signed webhooks, and reconcile billing. Built for prop firms integrating from their own backend. Authentication, quick start, error handling, idempotency, pagination, custom metadata, webhooks, and the MCP connector are documented at https://docs.hyperprop.com. x-logo: url: https://app.hyperprop.com/logo-icon.svg altText: Hyperprop href: https://hyperprop.com servers: - url: https://api.hyperprop.com/platform description: Production security: [] tags: - name: Trading accounts description: Create, update, and inspect trading accounts. - name: Traders description: Look up and update the traders in your organization. - name: Trading plans description: Define the plans you sell. - name: Trading rules description: Define how accounts are evaluated. - name: Lockouts description: Pause and resume trading on an account. - name: Payouts description: Check payout eligibility and record payouts. - name: Purchases description: Purchases recorded for your organization. - name: Time Machine description: Restore accounts to an earlier trading day or instant. - name: Webhooks description: Register webhook endpoints and inspect deliveries. - name: Events description: Your organization's event history and real-time event stream. - name: Reconciliation description: Balances, end-of-day snapshots, and fills for reconciliation. - name: Analytics description: Organization performance and plan economics. - name: Billing description: 'Your Hyperprop bill: activity, billing cycles, and forecasts.' - name: Team and roles description: Manage dashboard access for your staff. - name: API keys description: Manage your organization's API key. - name: Logs and health description: API request logs, the audit log, and integration health. - name: Organization profile description: Your organization's profile and logo. - name: Support description: Open and follow up on support tickets. - name: Partner access description: >- Read a trader's journal as an approved partner app, with the trader's own key. paths: /v1/organization/traders/{traderId}: patch: tags: - Traders summary: Update a trader description: >- 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:** ```bash 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:** ```bash 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:** ```bash 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. operationId: patchV1OrganizationTradersTraderid parameters: - description: The Hyperprop user ID (from GET /organization/traders list) x-format: guid: true name: traderId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Model896' responses: '200': description: Trader updated successfully content: '*/*': schema: $ref: '#/components/schemas/Model898' '400': description: Bad Request - No valid fields to update content: '*/*': schema: $ref: '#/components/schemas/Model899' '401': description: Authentication required content: '*/*': schema: $ref: '#/components/schemas/Model9' '403': description: Forbidden - Not an admin content: '*/*': schema: $ref: '#/components/schemas/Model900' '404': description: Not Found - Trader not found in your organization content: '*/*': schema: $ref: '#/components/schemas/Model901' '500': description: An unexpected error occurred content: '*/*': schema: $ref: '#/components/schemas/Model5' security: - X-API-Key: [] components: schemas: Model896: type: object properties: metadata: $ref: '#/components/schemas/Model895' mergeMetadata: type: boolean description: >- When true, the provided metadata keys are merged into the existing metadata instead of replacing it entirely example: true externalUserId: type: string description: >- 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. example: acme-user-4471 maxLength: 255 Model898: type: object properties: success: type: boolean example: true message: type: string example: Trader updated successfully data: $ref: '#/components/schemas/Model897' Model899: type: object properties: statusCode: type: number example: 400 error: type: string example: Bad Request message: type: string example: No valid fields to update code: type: string example: NO_FIELDS_TO_UPDATE Model9: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 401 error: type: string example: Unauthorized message: type: string example: Authentication required code: type: string description: Machine-readable error code — switch on this, not on message text example: UNAUTHORIZED Model900: type: object properties: statusCode: type: number example: 403 error: type: string example: Forbidden message: type: string example: Admin access required code: type: string example: ADMIN_REQUIRED Model901: type: object properties: statusCode: type: number example: 404 error: type: string example: Not Found message: type: string example: Trader not found code: type: string example: TRADER_NOT_FOUND Model5: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 500 error: type: string example: Internal Server Error message: type: string example: An unexpected error occurred code: type: string description: Machine-readable error code — switch on this, not on message text example: INTERNAL_ERROR Model895: type: object description: >- Custom metadata. Replaces existing metadata wholesale unless mergeMetadata is true. example: customerTier: gold notes: VIP customer internalId: '12345' Model897: type: object 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' properties: userId: type: string organizationUserId: type: string email: type: string fullName: type: string externalUserId: type: string description: Your external reference for this trader (null if not set) metadata: $ref: '#/components/schemas/changes' createdAt: type: string updatedAt: type: string changes: type: object securitySchemes: X-API-Key: type: apiKey name: X-API-Key in: header description: >- Organization API key. Format: "hp_live_{key}". Organization admins manage the key in the dashboard. ```` ## Related topics - [Introduction](/introduction.md) - [Update personal risk settings.](/trade-api/risk/update-personal-risk-settings.md) - [Update a trading rule](/platform-api/trading-rules/update-a-trading-rule.md) - [Update your organization profile](/platform-api/organization-profile/update-your-organization-profile.md) - [Update a webhook](/platform-api/webhooks/update-a-webhook.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.