Skip to main content

Delete User API

Overview​

Soft-deletes a user profile by setting delete: true and active: false.

  • Endpoint: /api/users/delete
  • Method: POST
  • Access: Corporate Admin / Admin

Request Body Schema​

FieldTypeRequiredDescription
idString (UUID)YesTarget user ID

Request Body Example​

{
  "id": "u9876543-21ba-fedc-3210-9876543210fe"
}

Success Response (200 OK)​

{
  "success": true,
  "message": "User deleted successfully",
  "data": {
    "id": "u9876543-21ba-fedc-3210-9876543210fe",
    "email": "vikram.singh@abbott.com",
    "active": false,
    "delete": true
  }
}

Database Impact​

  • Table: users
  • Operations: UPDATE setting delete: true, active: false.