Delete

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

Deletes a partner group. 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, 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, storage errors are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
id Int64 Required Partner group ID.

Request Example

{
  "id": 2
}

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
  }
}