POST
/
api
/
users
curl --request POST \
  --url https://kong.api.toolzz.com.br/api/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "<string>",
  "name": "<string>",
  "schools": {},
  "cpf": "<string>",
  "phone": "<string>",
  "birth_date": "<string>",
  "password": "<string>",
  "permission": 123
}'
{
  "data": {
    "ra": "<string>",
    "img_perfil": "<string>",
    "nome_completo": "<string>",
    "data_nascimento": "<string>",
    "cpf": "<string>",
    "rg": "<string>",
    "telefone": "<string>",
    "ocupacao": "<string>",
    "genero": "<string>",
    "descricao": "<string>",
    "escola_id": 123,
    "permissao": "<string>",
    "ultima_atividade": "<string>",
    "trial": 123,
    "status_id": 123,
    "name": "<string>",
    "email": "<string>",
    "terms": "<string>",
    "privilegio_id": "<string>",
    "uuid": "<string>",
    "updated_at": "<string>",
    "created_at": "<string>",
    "id": 123
  }
}

​
Parâmetros

​
email
string
required

E-mail do novo usuário.

​
name
string
required

Nome do novo usuário.

​
schools
array[string]
required

ID da escola ou escolas, na qual deseja cadastrar este novo usuário.

​
cpf
string

CPF do novo usuário.

​
phone
string

Telefone do novo usuário.

​
birth_date
date

Data de nascimento do novo usuário.

​
password
string

Senha do novo usuário.

​
permission
int

Permissão do novo usuário. Valores permitidos: 2, 3, 4, 5.

Antes de utilizar este endpoint, certifique-se de possuir os seguintes parâmetros disponíveis:
  • E-mail obrigatório: O endereço de e-mail do novo estudante a ser adicionado.
  • Nome obrigatório: O nome completo do estudante que está sendo incluído.
  • Escolas obrigatório: Caso pertinente, é possível vincular o estudante a uma ou mais escolas.

​
Descrição da Resposta

Abaixo está um exemplo da resposta retornada por este endpoint.

​
data
object

Detalhes do perfil do usuário.

​
Segurança

Para acessar este endpoint, é necessário enviar um token de acesso válido no cabeçalho de autorização (Authorization) da requisição. Além disso, a API é protegida por outras medidas de segurança para garantir a proteção dos dados dos usuários.