Delete

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

Soft-deletes a CRM client. 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 the record as deleted, 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, storage errors are returned as HTTP 200 ErrorResult.

Request Parameters

Request Example

{
  "id": 126
}

Response Parameters

Response Example

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