Delete

[POST] .../v1/partnergroup/delete

Deletes partner group. Use this destructive method to soft-delete an empty partner group after all partners and child groups have been moved elsewhere. The method checks for active partners and child groups, sets the internal deleted flag, writes an action log record, invalidates partner and partner-group caches, sends the PartnerGroupDeleted webhook and returns row_affected. The request body is required and id must identify an existing group with no non-deleted partners and no non-deleted child groups. The current request user must have partner group delete permission. Missing body, invalid id, denied access, dependency conflicts, missing rows, transaction failures and storage errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Request Example

{
  "id": 2
}

Response Parameters

Response Example

{
  "ok": true,
  "result": {
    "row_affected": 1
  }
}