Delete a Client Sub Organization Type

This endpoint removes a specific sub-organization type from the list of all sub-organization types available for the Enterprise API user. The sub-organization type ID is required.

HTTP Method and URL

DELETE {{host}}/api/v2/sub-organization/types/:subOrgTypeId/delete?user_type=ENTERPRISE_API

Authentication Requirements

Requires Bearer Token in the 'Authorization' header.

Path and Query Parameters

• Path Parameter:

  • subOrgTypeId (required): The ID of the sub-organization type to delete (e.g., 4)

• Query Parameter:

  • user_type (required): Set to 'ENTERPRISE_API'

Example Request

DELETE {{host}}/api/v2/sub-organization/types/4/delete?user_type=ENTERPRISE_API

Headers:
Authorization: Bearer {{user-token}}

Example Successful Response

Status: 200 OK

{
  "message": "Sub-organization type deleted successfully."
}

Error Responses

• 400 Bad Request: Invalid sub-organization type ID.

• 401 Unauthorized: Missing or invalid authentication token.

• 404 Not Found: Sub-organization type not found.

• 409 Conflict: Sub-organization type cannot be deleted due to dependencies.

Usage Notes

• Only users with appropriate permissions can delete sub-organization types.

• Deleting a sub-organization type may affect related entities.

• Refer to saved examples for variations in request and response payloads.