Skip to main content

Delete Employee Band API

Overview

Deletes an Employee Band if no users are currently assigned to it.

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

Request Body Schema

FieldTypeRequiredDescription
idString (UUID)YesTarget Employee Band ID

Request Body Example

{
"id": "b1234567-89ab-cdef-0123-456789abcdef"
}

Success Response (200 OK)

{
"success": true,
"message": "Employee Band deleted successfully",
"data": {
"id": "b1234567-89ab-cdef-0123-456789abcdef",
"name": "Band 1"
}
}

Error Response (400 Bad Request)

{
"success": false,
"message": "Cannot delete Employee Band 'Band 1' because it has 5 assigned user(s)",
"data": null
}

Database Impact

  • Table: employee_bands (EmployeeBand model)
  • Operations: DELETE record by ID.