Delete Company Group
The DELETE endpoint removes a specified company group identified by companyGroup_id.
Endpoint
- URL:
/companyGroup/{companyGroup_id} - Method:
DELETE
Authentication
- Header:
accessToken - Type: Bearer Token
- Value:
<ACCESS-TOKEN>
Path Parameters
| Parameter | Type | Description |
|---|---|---|
companyGroup_id | string | The unique identifier of the company group to delete. |
Request Headers
| Header | Type | Description |
|---|---|---|
accessToken | string | Access token for authentication. (required) |
Response
- Status Code: 200 OK
Sample Response Body
{
"success": true,
"message": "Company group deleted successfully"
}
Success Response Fields
| Field | Type | Description |
|---|---|---|
success | boolean | Indicates the success status of the request, typically true for a successful operation. |
message | string | A message conveying the outcome of the operation, e.g., "Company group deleted successfully". |
Error Responses
| Status Code | Description |
|---|---|
| 400 | Bad Request: Invalid input data. |
| 401 | Unauthorized: Access token is invalid or missing. |
| 404 | Not Found: The specified company group could not be found. |
| 500 | Internal Server Error: An error occurred on the server. |
Notes
- Ensure you replace
{companyGroup_id}in the URL with the actual unique identifier of the company group being deleted. - Provide a valid and active access token in the request header to authenticate your request.