Delete User

DELETE

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

Users

Last modified:2026-07-24 13:10:44

Soft-deletes a user by marking their account status as deleted. The user's data and call history are preserved in the database for audit and reporting purposes.

What happens on delete

The user's user_status is set to deleted.

Active login sessions are immediately invalidated — the user is logged out.

The deleted_at timestamp and deleted_by (the admin's user ID) are recorded.

Historical call records, tags, and interactions attributed to this user remain intact.

Restrictions

A user cannot be deleted while they have an active live call in progress.

Once deleted, the user's email address becomes available for re-registration.

Reversibility
Soft deletion is not directly reversible via this API. Contact support to restore a deleted account if needed.

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

User deleted successfully

Bodyapplication/json

🟠400

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff --request DELETE 'https://platform-api.convirza.com/v3/users/{id}' \
--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-07-24 13:10:44

Partial Update User

Get Group Tree