Delete Group

DELETE

https://platform-api.convirza.com/v3/groups/{id}

Groups

Last modified:2026-04-03 14:27:57

Soft-deletes a group (organizational unit) by marking its status as deleted. The group's historical data, call records, and configuration are preserved in the database.

What happens on delete

org_unit_status is set to deleted.

The group disappears from active hierarchy views, user selectors, and reporting filters.

deleted_at and deleted_by (the admin user ID) are recorded for audit purposes.

All historical call data attributed to this group remains searchable by Admins.

Restrictions — deletion is blocked when:

The group has active child sub-groups. You must delete or reassign all children first.

The group has users currently assigned to it. Reassign or delete all users first.

The group is a root/billing-level organization unit (top-level orgs cannot be deleted via API).

Reversibility
Soft deletion is not reversible via this API.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200

application/json

Group deleted successfully

Body

🟠400

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE 'https://platform-api.convirza.com/v3/groups/' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "code": 200,
    "message": "Resource deleted successfully",
    "data": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-03-29T12:00:00.000Z"
}

Modified at 2026-04-03 14:27:57

Partial Update Group

Create Group