POST
/
api
/
classes
/
{turma_id}
/
attach
Matricule alunos em uma turma
curl --request POST \
  --url https://kong.api.toolzz.com.br/api/classes/{turma_id}/attach \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "users": [
    {}
  ],
  "birth_date": "<string>",
  "cpf": "<string>",
  "registration_start_date": "<string>",
  "registration_end_date": "<string>",
  "enrollment_renewal": true,
  "id": 123
}'
{
  "data": [
    {
      "user_id": 123,
      "user_name": "<string>",
      "school_id": 123,
      "class_id": "<string>",
      "class_name": "<string>",
      "birth_date": "<string>",
      "cpf": "<string>",
      "registration_start_date": "<string>",
      "registration_end_date": "<string>",
      "enrollment_renewal": true,
      "id": {}
    }
  ]
}

​
Parâmetros

​
turma_id
string
required
Número identificador da turma na qual o aluno, ou os alunos, serão matriculados.
​
users
array
required
Lista de usuários a serem matriculados e registrados. Caso o usuário já exista, é possível vinculá-lo via ID, utilizando a chave “id” com o respectivo valor.
​
birth_date
string
Data de nascimento do usuário no formato YYYY-MM-DD.
​
cpf
string
Número do CPF do usuário, contendo exatamente 11 dígitos numéricos.
​
registration_start_date
string
Data de início da matrícula do usuário, no formato YYYY-MM-DD.
​
registration_end_date
string
Data de término da matrícula do usuário, no formato YYYY-MM-DD. Deve ser igual ou posterior à data atual.
​
enrollment_renewal
boolean
Flag que indica se a matrícula será renovada.
​
id
int
Identificador ou código da turma para validação. Pode ser numérico ou alfanumérico.
Antes de utilizar este endpoint, certifique-se de possuir os seguintes parâmetros disponíveis:
  • IDTurma: Código da turma na qual você deseja matricular o(s) aluno(s). Deve ser passado na URL.
  • users: Uma lista (array) de objetos contendo informações dos alunos a serem matriculados na turma ou apenas uma lista com os e-mails dos alunos já cadastrados na plataforma.
  • name: obrigatório para alunos não registrados: Nome do aluno a ser matriculado.
  • email: obrigatório para alunos não registrados: Endereço de e-mail do aluno a ser matriculado.
  • id: opcional, pode ser utilizado para usuários já registrados: ID do aluno registrado na instituição.

​
Descrição da Resposta

Abaixo está um exemplo da resposta retornada por este endpoint.
​
data
array
Lista de associações entre usuários e a turma.

​
Segurança

Para acessar este endpoint, é necessário enviar um token de acesso válido através do 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.