Facebook
LinkedIn
YouTube
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API Documentation
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API Documentation
  1. Users
  • Platform
    • Users
      • List Users
        GET
      • Get User Details
        GET
      • Update User
        PUT
      • Partial Update User
        PATCH
      • Delete User
        DELETE
      • Create User
        POST
    • Groups
      • List Child Groups
      • Get Group Tree
      • Get Group Details
      • List Groups
      • Get Org Unit Hierarchy
      • Update Group
      • Partial Update Group
      • Delete Group
      • Create Group
    • Webhooks
      • List Webhooks
      • Get Webhook Details
      • Update Webhook
      • Partial Update Webhook
      • Delete Webhook
      • Create Webhook
    • Media Prompts
      • List Prompts
      • Upload Prompt
      • Delete Prompt
  • AI Voice Agents
    • List AI Voice Agents
      GET
    • Create Agent
      POST
    • Get Agent Details
      GET
    • Update Agent
      PUT
    • Partial Update Agent
      PATCH
    • Delete Agent
      DELETE
  • Phone Numbers
    • Assigned Numbers
      GET
    • Provisioned Numbers
      GET
    • Reserved Numbers
      DELETE
    • Phone Numbers
      POST
    • Available Numbers
      GET
  • Provisioned Routes
    • List Provisioned Routes
      GET
    • Create Provisioned Route
      POST
    • Get Provisioned Route Details
      GET
    • Delete Provisioned Route
      DELETE
    • Update Provisioned Route
      PUT
    • Partial Update Provisioned Route
      PATCH
  • SMS Broadcasts
    • List Broadcasts
    • Create Broadcast
    • Get Broadcast Details
    • Update Broadcast
    • Partial Update Broadcast
    • Delete Broadcast
  • Conversation
    • Calls
      • Get Calls List
      • Get Call By ID
    • SMS
      • Get SMS Conversations
  • Miscellaneous
    • List Ad Sources
    • List Industries
    • List Tags
    • Create Tag
    • Update Tag
    • Delete Tag
  1. Users

Delete User

DELETE
https://platform-api.convirza.com/v3/users/{id}
Users
Last modified:2026-04-03 14:27:57
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 ********************
or
Path Params

Responses

🟢200
application/json
User deleted successfully
Body

🟠400
🟠401
🟠404
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request DELETE 'https://platform-api.convirza.com/v3/users/' \
--header 'Authorization: Bearer <token>'
Response 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
Previous
Partial Update User
Next
Create User
Built with