Unenroll Students from a Class

Endpoint used to indicate a class and send one or more student objects to remove them from the class in Toolzz LMS.

Request Example

curl --request POST \
  --url 'https://kong.api.toolzz.com.br/api/classes/{class_id}/detach' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "users": [
      {
        "name": "Student Name",
        "email": "student@example.com"
      }
    ]
  }'

Response Example

{
  "success": true,
  "message": "Students unenrolled successfully"
}

---

Request description

Access Token

Parameter	Type	Description	Required
Authorization	String	Access token (“Bearer” must be before the token)	Yes

URL Parameters (Path)

Parameter	Type	Description	Required
class_id	string	Identifier of the class from which the student(s) will be unenrolled.	Yes

Body Parameters

Parameter	Type	Description	Required
users	array	List of users to be removed from the class. Alternatively, a list with the emails of already registered students on the platform.	Yes
users.name	string	Name of the student to be removed.	Yes
users.email	string	Email address of the student to be removed.	Yes
id	string	Identifier of the student to be removed from the class.	No
institution_code	string	Subdomain of the desired institution.	No

---

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.