PUT
/
api
/
v1
/
schools
/
{schoolId}
/
classrooms
/
{classroomId}
Editar Turmas
curl --request PUT \
  --url https://trialprod.app.toolzz.com.br/api/v1/schools/{schoolId}/classrooms/{classroomId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "<string>",
  "code": "<string>",
  "type": {},
  "group": [
    {}
  ],
  "subgroups": [
    {}
  ],
  "specialties": [
    {}
  ],
  "contents": [
    {}
  ]
}'
{
  "success": true,
  "data": {
    "id": 123,
    "schoolId": "<string>",
    "title": "<string>",
    "code": "<string>",
    "image": "<string>",
    "course": "<string>",
    "group": [
      {
        "id": 123,
        "name": "<string>"
      }
    ],
    "subgroups": [
      {
        "id": 123,
        "name": "<string>"
      }
    ],
    "specialties": [
      {
        "id": 123,
        "name": "<string>"
      }
    ],
    "trails": [
      {}
    ],
    "contents": [
      {}
    ],
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

Parâmetros

schoolId
string
required
O identificador da escola à qual a turma a ser editada está associada.
classroomId
string
O identificador da turma a ser editada.
title
string
Título da turma.
code
string
Código da turma.
type
enum
Tipo da turma a ser editada. A turma do tipo filtro é a turma padrão da plataforma, relacionando-se com os conteúdos exclusivos que possuem os mesmos filtros. FILTER ou EXCLUSIVE_CONTENT
group
array
ID de um ou mais grupos da instituição a serem vinculados à turma.
subgroups
array
ID de um ou mais subgrupos da instituição a serem vinculados à turma.
specialties
array
ID de uma ou mais especialidades da instituição a serem vinculadas à turma.
contents
array
Conteúdos associados ao item.
Este endpoint funcionará corretamente apenas se o domínio da sua instituição for informado manualmente na URL, caso contrário, o endpoint poderá falhar ou retornar um erro de validação.
Antes de utilizar este endpoint, certifique-se de possuir os seguintes parâmetros disponíveis:
O ID da unidade é necessário para identificar a unidade à qual a turma será editada.
O ID dos filtros é necessário para identificar os filtros (grupo, subgrupo e especialidade) a serem vinculados à turma.

Descrição da Resposta

Abaixo está um exemplo da resposta retornada por este endpoint.
success
boolean
Indica se a requisição foi bem-sucedida.
data
object
Detalhes da 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.