Para congelar ou descongelar o acesso de alunos em toda a escola, utilize:

PATCH /api/v1/students/access

Você deve enviar os seguintes dados na requisição:

Campo

Tipo

Descrição

Obrigatório

students_ids

array

Os ids dos alunos. Máximo de 300 por vez.

sim

is_frozen

boolean

Define se o acesso do aluno em toda a escola está congelado ou não.

sim

freeze_message

string

Mensagem que o aluno verá na tela quando tentar acessar e seu acesso estiver congelado.

não

$client = new Guzzle\Client;

$response = $client->request('PATCH', 'https://app.alpaclass.com/api/v1/students/access', [
  'headers' => [
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
    'Authorization' => 'Bearer seu_token_de_api'
  ],
  'body' => [
    'students_ids' => [3, 23, 44], // máximo 300 alunos por vez
    'is_frozen' => true,
    'freeze_message' => 'Seu acesso está congelado. Procure nossa equipe de suporte.',
  ]
])->getBody()->getContents();

Você pode pegar os ids dos cursos em "Listagem de Conteúdos" via API.

Lembre-se: o limite de alunos por requisição é 300. Se tem mais que isso, faça várias requisições de 300 em 300 alunos.