Skip to content

ResetSettingsByLoginsList

Deletes all custom settings stored for the supplied trading-account logins. The operation affects only settings rows and does not modify or delete the accounts.

The same handler is exposed through the HTTP alias DELETE /settings/by-logins, while this page documents the TCP command.

Access

The authenticated session must satisfy all requirements:

  • session type: SESSION_MANAGER, SESSION_ADMIN, or SESSION_DEALER;
  • scope: access_backoffice;
  • permission: set_accounts.

Request Parameters

Name Type Required Description
logins array Yes Array containing 1–500 positive integers (logins). Duplicate values are accepted and processed once.

Full Request Example

{
  "command": "ResetSettingsByLoginsList",
  "extID": "reset-settings-list-1",
  "__token": "manager-jwt",
  "data": {
    "logins": [123456, 123457, 123458]
  }
}

The internal __access object is created by the server from the authenticated session and must not be sent inside data.

Response Parameters

Name Type Description
requested_logins int Number of items supplied in logins, including duplicates.
unique_logins int Number of distinct logins processed.
deleted_settings int Number of individual settings rows deleted across all supplied logins.

Full Successful Response

{
  "extID": "reset-settings-list-1",
  "status": 200,
  "data": {
    "requested_logins": 3,
    "unique_logins": 3,
    "deleted_settings": 8
  }
}

Unlike single-login ResetSettings, this bulk operation is idempotent. It returns HTTP/TCP status 200 with deleted_settings: 0 when none of the supplied logins has stored settings. Missing settings for one login do not reject other logins.

Errors

Status Error Description
400 INVALID_DATA logins is absent, is not an array, is empty, exceeds 500 items, or contains a non-integer/non-positive value.
401 Authentication error The TCP token is absent, invalid, or expired.
403 Access denied Session type, access_backoffice scope, or set_accounts permission is missing.
500 INVALID_RESET_SETTINGS Settings storage is unavailable or the delete statement failed.

Example failure response:

{
  "extID": "reset-settings-list-1",
  "status": 500,
  "data": {
    "error": "INVALID_RESET_SETTINGS",
    "message": "Unknown error"
  }
}

The method uses one parameterized delete statement for all unique logins and has JOURNAL_POLICY_ALL, so successful and failed attempts are recorded.