Skip to content

MngDeleteClient

Deletes one client record by customer_id. Trading accounts are not deleted and keep their link.

The command is available through the manager command API only; there is no REST path for it. The kind is fixed by the command name, so customer_kind is not accepted on input. See Clients and Leads Commands.

It replaces the deprecated MngDeleteCustomer. To delete many records at once, and optionally their accounts, use MngDeleteClientsByFilter.

Access Control

Allowed sessions:

  • SESSION_MANAGER
  • SESSION_ADMIN
  • SESSION_DEALER
  • SESSION_CRM_MANAGER
  • SESSION_CRM_ADMIN

The caller must have CRM access and del_clients. The record brand and desk must be inside the manager scope; admin scope bypasses this check.

Request

{
  "command": "MngDeleteClient",
  "extID": "1",
  "data": {
    "customer_id": 1
  }
}

Request Data

Field Type Required Description
customer_id int Yes Target customer id, 1 or greater

Response Data

{
  "customer_id": 1
}

Errors

HTTP Error Description
400 INVALID_DATA Request validation failed
400 RET_INVALID_DATA The customer exists but is not a client
403 RET_NOT_ENOUGH_RIGHTS Missing permission, missing scope, or the record is outside the caller's visibility
404 RET_NOT_FOUND No customer with that identifier exists

Every error carries a message field with free-form text. Its contents are not part of the contract; branch on error.