Enroll Student in Course Package
Endpoint used to enroll a specific student in a course package in Toolzz LXP.
Request Example
Section titled “Request Example”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" }'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 |
|---|---|---|---|
plan_hash | string | Identifier of the target package. | Yes |
Body Parameters
Section titled “Body Parameters”| Parameter | Type | Description | Required |
|---|---|---|---|
email | string | Email address of the student to be enrolled in the course package. | Yes |
nome | string | Name of the student to be enrolled in the course package. | Yes |
schools | number[] | List containing one or more school identifiers to which the student will be enrolled. | Yes |
status | string | Enrollment status in the package. active: Student is active in the package. expired: Student’s enrollment has expired. | No |
expires_at | string | Expiration date of the student’s course package. | No |
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.