Skip to main content

Delete Company API

Overview​

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

  • Endpoint: /api/companies/delete
  • Method: POST
  • Access: Super Admin

Request Body Schema​

FieldTypeRequiredDescription
idString (UUID)YesTarget company ID

Request Body Example​

{
  "id": "c478a846-993d-4c8d-bf8d-d77cb3370e01"
}

Success Response (200 OK)​

{
  "success": true,
  "message": "Company deleted successfully",
  "data": {
    "id": "c478a846-993d-4c8d-bf8d-d77cb3370e01",
    "name": "Abbott Healthcare",
    "active": false,
    "delete": true
  }
}

Database Impact​

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