Skip to content

Enroll Student in Course Package

Endpoint used to enroll a specific student in a course package in Toolzz LXP.

Terminal window
curl --request POST \
--url 'https://kong.api.toolzz.com.br/api/plans/{plan_hash}' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"email": "student@example.com",
"nome": "Student Name",
"schools": [1, 2],
"status": "active",
"expires_at": "2025-12-31"
}'

ParameterTypeDescriptionRequired
AuthorizationStringAccess token (“Bearer” must be before the token)Yes
ParameterTypeDescriptionRequired
plan_hashstringIdentifier of the target package.Yes
ParameterTypeDescriptionRequired
emailstringEmail address of the student to be enrolled in the course package.Yes
nomestringName of the student to be enrolled in the course package.Yes
schoolsnumber[]List containing one or more school identifiers to which the student will be enrolled.Yes
statusstringEnrollment status in the package. active: Student is active in the package. expired: Student’s enrollment has expired.No
expires_atstringExpiration date of the student’s course package.No

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.