Skip to main content
DELETE
Remove a test account

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

trading_account_id
string<uuid>
required

Simulated account id

Response

Test account removed. Idempotent: a retry reports the moment of the first deletion.

The body every successful delete returns.

Deletes are idempotent, so a caller that retries one it is unsure landed gets the same 200 as the caller that deleted it. That leaves the caller unable to tell the two apart from the status alone, which is what deleted_at is for: it is the moment the resource was first deleted and does not move on a repeat call.

deleted
boolean
required

Always true. A caller checking one field to confirm the outcome does not have to special-case which endpoint it called.

deleted_at
string<date-time>
required

When the resource was first deleted, not when this call was made.

resource
enum<string>
required

The resource a delete acted on.

Named rather than free text so a caller can branch on it, and so the same vocabulary is available when these deletes start emitting events.

Available options:
trading_account,
test_trading_account,
broker_credential,
oauth_client,
organization,
user,
organization_control,
account_control,
account_risk_control,
account_time_control,
symbol_control,
symbol_risk_control,
symbol_time_control
id
string | null

Absent for resources keyed by a natural composite key rather than a single identifier, which today is every control in the controls service. The path already identifies those, so nothing is lost by omitting it.