Can I assign traders through the API?
Quick answer
Yes. `PUT /v1/accounts/{number}/trader` with a name and email assigns the account to that trader, creating the trader record if none exists for the email. `DELETE` on the same path unassigns it. Both revoke the account's live sessions when the holder actually changes.
Detailed answer
Trader assignment is the most common write integration.
Assign
PUT /v1/accounts/{number}/trader with {name, email}.
- An existing trader is found by email within your firm; their stored name is kept.
- A new email creates a trader record using the name provided.
- Assigning the same trader again changes nothing and does not disconnect them, so retries are safe.
Refusal when held
If the account already belongs to a different trader, the request is refused with account_assigned and the current holder's ID. Nothing is created or changed. This protects against a wrong account number silently moving a paying trader's account.
Unassign
DELETE /v1/accounts/{number}/trader removes the assignment and revokes sessions.
Neither rotates the password
The account number and server never change, so a real handover is unassign, rotate, assign. Rotation is separate so the system doing the handover can read the new password and pass it on.
Scopes
accounts:write for assignment; credentials:read to read or rotate credentials.
PropExecutor team · Updated