Delete

[POST] .../v1/client/delete

Deletes a CRM client and sends the ClientDeleted webhook after success. Use this destructive method to soft-delete a CRM client after confirming that the client should no longer be shown in normal client lists. The method verifies that the client exists, marks cli_deleted as true, writes an action log record, sends the ClientDeleted webhook and returns row_affected with the deleted client id. The request body is required and id must be positive; existing lead, deal, ticket and task links are not reassigned by this method, use Client/Merge when a duplicate should be consolidated into another client. The caller must have CRM client delete permission; missing body, invalid id, denied access, missing client, database errors, transaction failures and action-log errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
id Int64 Required Client ID.

Request Example

{
  "id": 126
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Update Update operation result.

Response Example

{
  "ok": true,
  "result": {
    "row_affected": 1,
    "ids": [
      126
    ]
  }
}