Delete

[POST] .../v1/channel/delete

Soft-deletes a CRM channel. Logically remove a CRM channel from normal channel lists without physically deleting the row. The method marks the channel as deleted and inactive, sends the ChannelDeleted webhook and returns row_affected with changed ids. The request body is required and id must be positive; typical workflow is to use Channel/Get to select the channel, then Channel/Delete only after confirming that it should no longer be used. The caller must have CRM channel delete permission; missing body, invalid id, denied access, missing channel, storage errors are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
id Int64 Required Channel ID.

Request Example

{
  "id": 3
}

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": [
      3
    ]
  }
}