Skip to content

Delete Units

Endpoint used to delete a school unit from your institution 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.

Terminal window
curl --request DELETE \
--url 'https://{your-institution-domain}/api/v1/schools/{schoolId}?hasConfirmation=true' \
--header 'Authorization: Bearer <token>'
{
"success": true,
"message": "School deleted successfully"
}

ParameterTypeDescriptionRequired
AuthorizationStringAccess token (“Bearer” must be before the token)Yes
ParameterTypeDescriptionRequired
schoolIdstringIdentifier of the school to be deleted.Yes
ParameterTypeDescriptionRequired
hasConfirmationstringSecurity key to confirm unit deletion. E.g., true or false.Yes

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.