Deactivate a trading account

Deactivate a trading account with a reason and, when requested, submit close-position requests for its open positions.

PATCH /api/accounts/{id}/deactivate/

cURL

DeactivateWithoutClosingPositions

curl --request PATCH \
  --url https://api.example.com/api/accounts/{id}/deactivate/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "Temporary suspension for review",
  "close_positions": false
}
'

200

SuccessResponse-PositionsNotClosed

{
  "success": true,
  "message": "Account deactivated successfully.",
  "results": [
    {
      "account_id": 1001,
      "challenge_short_code": "001122",
      "is_active": false,
      "is_passed": false,
      "failure_reason": "Temporary suspension for review",
      "failed_at": "2026-01-07T15:45:00Z",
      "deactivated_at": "2026-01-07T15:45:00Z",
      "positions_closed": false,
      "open_position_count": 3
    }
  ],
  "summary": {
    "updated": 1,
    "positions_closed": 0,
    "position_close_requested": 0,
    "position_close_submitted": 0,
    "position_close_failed": 0
  },
  "duration_ms": 45
}

Authorizations

Authorization · string · header · required

Token-based authentication with required prefix "Token"

Path Parameters

id · integer · required

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

reason · string

Maximum string length: 500

close_positions · boolean · default: false

Response

200 - application/json

Standard serializer for operation responses. A command or a task should return a response matching this format. Operation = a request to perform some action, e.g. sync, update, delete, create, etc.

success · boolean · required

Indicates whether the operation completed successfully.

results · any[] · required

List containing the result items produced by the operation. The structure of each item depends on the executed operation.

summary · object · required

Aggregated summary information about the operation results (e.g. counts of updated, created, failed or unchanged records).

Show child attributes

duration_ms · number<double> · required

Execution time of the operation in milliseconds.

message · string | null

Optional human-readable message describing the operation outcome.