Skip to main content
POST
Matricular alunos

Escopo

Authorizations

Authorization
string
header
required

Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.

Path Parameters

member_area_id
string<uuid>
required

ID da área de membros.

Body

application/json

A importação do painel sem a planilha (file): a API é só JSON.

items
object[]

Alunos por e-mail, com starts_at/expires_at opcionais.

source_product_id
string

Matricula quem comprou este produto seu.

access_plan
string<uuid> | null

Plano de acesso; sem ele vale o plano padrão.

Response

Só para o schema: o summary da importação é um objeto de contagens, não texto.

id
string<uuid>
required
read-only

Identificador único da importação no sistema

status
enum<string>
required

Status atual do processamento da importação

  • processing - Processando
  • completed - Concluído
  • failed - Falhou
  • deleted - Excluído
Available options:
processing,
completed,
failed,
deleted
source
enum<string>
required

Origem dos membros importados

  • csv - Arquivo CSV
  • json - Lista JSON
  • product - Produto Cakto
Available options:
csv,
json,
product
access_plan
object
required
summary
object
required
results
any
required
read-only

Resultado individual de cada linha processada na importação

created_at
string<date-time>
required
read-only

Data de criação da importação

finished_at
string<date-time> | null
required
read-only

Data e hora do fim do processamento da importação