Criar usuário em várias escolas

Cadastre novos alunos no Toolzz em uma ou mais escolas da sua instituição

POST /api/users

Criar usuário em várias escolas

cURL

curl --request POST \
  --url https://kong.api.toolzz.com.br/api/users \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "name": "<string>",
  "schools": [
    123
  ],
  "permission": 123,
  "cpf": "<string>",
  "phone": "<string>",
  "birth_date": "<string>",
  "password": "<string>"
}
'

200

{
  "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 · number[] · required

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

permission · int · required

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

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.

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.

Show properties

ra · string

Número de registro (pode ser nulo).

img_perfil · string

Nome do arquivo da imagem de perfil.

nome_completo · string

Nome completo do usuário.

data_nascimento · string

Data de nascimento (pode ser nula).

cpf · string

CPF (Cadastro de Pessoa Física) (pode ser nulo).

rg · string

RG (Registro Geral) (pode ser nulo).

telefone · string

Telefone de contato (pode ser nulo).

ocupacao · string

Ocupação do usuário (pode ser nula).

genero · string

Gênero (pode ser nulo).

descricao · string

Descrição adicional (pode ser nula).

escola_id · number

Identificador único da escola associada.

permissao · string

Nível de permissão do usuário.

ultima_atividade · string

Data e hora da última atividade.

trial · number

Indica se o usuário está em período de teste (0 = Não, 1 = Sim).

status_id · number

Identificador de status do usuário.

name · string

Nome do usuário.

email · string

Endereço de e-mail do usuário.

terms · string

Indica se o usuário aceitou os termos.

privilegio_id · string

Identificador do nível de privilégio.

uuid · string

Identificador Universal Único (UUID) do usuário.

updated_at · string

Data e hora da última atualização do perfil.

created_at · string

Data e hora da criação do perfil.

id · number

Identificador único 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.