Delete Classes
Endpoint used to delete a class linked to a specific school in Toolzz LMS.
Warning: This endpoint will only work correctly if the domain of your institution is manually provided in the URL. Otherwise, the endpoint may fail or return a validation error.
Request Example
Section titled “Request Example”curl --request DELETE \ --url 'https://{your-institution-domain}/api/v1/schools/{schoolId}/classrooms/{classroomId}?hasConfirmation=true' \ --header 'Authorization: Bearer <token>'Response Example
Section titled “Response Example”{ "success": true, "message": "Classroom deleted successfully"}Request description
Section titled “Request description”Access Token
Section titled “Access Token”| Parameter | Type | Description | Required |
|---|---|---|---|
Authorization | String | Access token (“Bearer” must be before the token) | Yes |
URL Parameters (Path)
Section titled “URL Parameters (Path)”| Parameter | Type | Description | Required |
|---|---|---|---|
schoolId | string | Identifier of the school to which the class to be deleted is associated. | Yes |
classroomId | string | Identifier of the class to be deleted. | Yes |
URL Parameters (Query)
Section titled “URL Parameters (Query)”| Parameter | Type | Description | Required |
|---|---|---|---|
hasConfirmation | string | Security key to confirm class deletion. E.g., true or false. | Yes |
Security
Section titled “Security”To access this endpoint, it is necessary to send a valid access token through the authorization header (Authorization) of the request. Additionally, the API is protected by other security measures to safeguard user data.