Create Users in Multiple Schools

Endpoint used to register new students in Toolzz LMS in one or more schools of your institution.

Request Example

curl --request POST \
  --url 'https://kong.api.toolzz.com.br/api/users' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "student@example.com",
    "name": "Student Name",
    "schools": [1, 2],
    "permission": 3,
    "cpf": "<string>",
    "phone": "<string>",
    "birth_date": "2000-01-01",
    "password": "<string>"
  }'

Response Example

{
  "data": {
    "ra": null,
    "img_perfil": "<string>",
    "nome_completo": "<string>",
    "data_nascimento": null,
    "cpf": null,
    "rg": null,
    "telefone": null,
    "ocupacao": null,
    "genero": null,
    "descricao": null,
    "escola_id": 1,
    "permissao": "<string>",
    "ultima_atividade": "<string>",
    "trial": 0,
    "status_id": 1,
    "name": "<string>",
    "email": "<string>",
    "terms": "<string>",
    "privilegio_id": "<string>",
    "uuid": "<string>",
    "updated_at": "<string>",
    "created_at": "<string>",
    "id": 1
  }
}

---

Request description

Access Token

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

Body Parameters

Parameter	Type	Description	Required
email	string	New user’s email address.	Yes
name	string	New user’s name.	Yes
schools	number[]	ID of the school or schools in which the new user will be registered.	Yes
permission	int	New user’s permission level. Allowed values: 2, 3, 4, 5.	Yes
cpf	string	New user’s CPF.	No
phone	string	New user’s phone number.	No
birth_date	date	New user’s date of birth.	No
password	string	New user’s password.	No

---

Response description

Key	Type	Description
data	object	Details of the user profile.
data.ra	string	Registration number (may be null).
data.img_perfil	string	Profile image filename.
data.nome_completo	string	User’s full name.
data.data_nascimento	string	Date of birth (may be null).
data.cpf	string	CPF (may be null).
data.rg	string	RG (may be null).
data.telefone	string	Contact phone (may be null).
data.ocupacao	string	User occupation (may be null).
data.genero	string	Gender (may be null).
data.descricao	string	Additional description (may be null).
data.escola_id	number	Unique identifier of the associated school.
data.permissao	string	User permission level.
data.ultima_atividade	string	Date and time of last activity.
data.trial	number	Indicates if the user is in a trial period (0: No, 1: Yes).
data.status_id	number	User status identifier.
data.name	string	User name.
data.email	string	User email address.
data.terms	string	Indicates if the user accepted the terms.
data.privilegio_id	string	Privilege level identifier.
data.uuid	string	Universal Unique Identifier (UUID) of the user.
data.updated_at	string	Date and time of the last profile update.
data.created_at	string	Date and time of profile creation.
data.id	number	Unique identifier of the user.

---

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.