POST
/
api
/
classes
/
{turma_id}
/
detach
Desmatricule alunos de uma turma
curl --request POST \
  --url https://kong.api.toolzz.com.br/api/classes/{turma_id}/detach \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "users": [
    {}
  ],
  "id": "<string>",
  "institution_code": "<string>"
}'

​
Parâmetros

​
turma_id
string
required
Número identificador da turma da qual o aluno ou alunos serão desmatriculados.
​
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.
​
id
string
Identificador do aluno que será removido da turma.
​
institution_code
string
Subdomínio da instituição desejada.
Antes de utilizar este endpoint, certifique-se de possuir os seguintes parâmetros disponíveis:
  • IDTurma: Código da turma da qual você deseja desmatricular o aluno. Deve ser passado na URL.
  • users: Uma lista de objetos contendo informações dos alunos a serem removidos da turma ou, alternativamente, apenas uma lista com os e-mails dos alunos já cadastrados na plataforma.
  • name: obrigatório: Nome do aluno a ser removido.
  • email: obrigatório: Endereço de e-mail do aluno a ser removido.

​
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.