Unlink a trader (issues a fresh import key)
Detach the trader from an account before trading starts — wrong customer, refund, resale, or a mistaken import.
What happens:
- The trader is detached (
userIdback tonull) - The old import key is voided forever and a fresh key is issued (returned in the response and in the webhook)
- An
account.unlinkedwebhook fires with the unlinked trader’s email, the voided key, and the new key
Soulbound bindings are NOT released by unlink. If the account’s customerId is bound to a Hyperprop login, the fresh key can still only be redeemed by that same login. That’s intentional — the binding belongs to the customer, not the account. Two follow-ups depending on why you’re unlinking:
- Resold to a different customer → change the account’s
customerIdto the new customer’s ID (PATCH /trading-accounts/{accountId}), then hand over the fresh key. - Same customer, lost Hyperprop login → rebind the customer to their new login (
POST /trader-bindings/{bindingId}/rebind) — the fresh key then becomes redeemable by the new login, and any still-active accounts on the old login are failed.
When it’s refused — 409 ACCOUNT_ALREADY_STARTED:
Only not_started accounts with zero order history can be unlinked. Once a trader has placed trades there is history, journal data, and snapshots that belong to them — unlinking would orphan all of it. Handle post-start situations with account status changes (PATCH /trading-accounts/{accountId}/status) instead.
Note: if the import had already started a billing cycle, that cycle is not reversed — the new redemption of the fresh key will not double-bill inside the same cycle window.
Permissions: organization admins only.
Error codes: ACCOUNT_NOT_FOUND, NOT_LINKED, ACCOUNT_ALREADY_STARTED, UNLINK_ERROR.
Authorizations
JWT Bearer token for user session auth. Format: "Bearer {token}". Used by User and Organization endpoints.
Path Parameters
Trading account ID
Related topics
Bulk-create unlinked accounts with import keysImport a trading account with an import keyPreview an import key (no redemption)Register a webhook endpointCreate a trading account