> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cakto.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Visão geral

> Conteúdo, alunos, certificados e comentários da área de membros (Cakto Members V3) pela API.

#### Escopo

```bash theme={null}
    read members        # consultar
    write members       # criar, editar, matricular, excluir
```

A área de membros é a entrega **Cakto Members V3** de um produto: cada produto com essa entrega
tem uma área, e é nela que ficam o conteúdo e os alunos. Estas rotas fazem pela API o que a tela
**Área de membros** do painel faz, com as mesmas regras.

## Como o conteúdo se organiza

```
Área ─┬─ Seção (course)  ─── Módulo ─── Aula ─── Materiais
      ├─ Seção (ebook)   ─── E-book
      └─ Seção (upsell)  ─── vitrine de outro produto seu
```

* **Comece pela [árvore de conteúdo](https://docs.cakto.com.br/api-reference/members/content-tree.md)**: seções, módulos e aulas
  da área numa chamada só, com `id` e posição. É o jeito mais barato de entender a área antes de
  editar.
* Item novo entra **no fim** do pai. A ordem muda pelas rotas de reordenar, que recebem **todos** os
  ids do pai na ordem nova.
* Excluir uma seção ou um módulo exclui o que está dentro e reposiciona os irmãos.

## Alunos

| Para | Use |
| - | - |
| Dar acesso a quem já comprou um produto seu, ou a uma lista de e-mails | [Matricular alunos](https://docs.cakto.com.br/api-reference/members/enrollments-import.md) |
| Convidar alguém, que aceita pelo e-mail | [Convidar aluno](https://docs.cakto.com.br/api-reference/members/invitations-create.md) |
| Suspender sem perder o histórico | [Bloquear](https://docs.cakto.com.br/api-reference/members/enrollments-block.md) e [Desbloquear](https://docs.cakto.com.br/api-reference/members/enrollments-unblock.md) |
| Tirar o acesso | [Remover aluno](https://docs.cakto.com.br/api-reference/members/enrollments-delete.md) |
| Ver o progresso | [Progresso do aluno](https://docs.cakto.com.br/api-reference/members/enrollments-report.md) |

A matrícula do próprio produtor na área não é bloqueada nem removida (`400`).

> [!WARNING]
>
> Matricular quem ainda não tem conta e convidar **enviam e-mail ao aluno**. Remover e bloquear
> tiram o acesso na hora. Pelo [CaktoMCP](https://docs.cakto.com.br/mcp/visao-geral.md), a IA mostra o que vai mudar e só
> executa depois da sua confirmação.

## O que fica no painel

Enviar arquivo: logo e banner da área, capa de seção, módulo e aula, PDF de e-book, material de aula
e vídeo. A API é só JSON. A aula aponta para um vídeo que já está na sua biblioteca
([Listar vídeos](https://docs.cakto.com.br/api-reference/members/videos-list.md), campo `video_id`) ou para um link do YouTube
(`external_video_url`).

## Erros que valem para todas as rotas

| Status | Quando |
| - | - |
| `403` | A chave não tem o escopo `members`, ou é só de leitura e a chamada escreve |
| `404` | O id não existe ou não é da sua conta |
| `409` | A área está sendo copiada: a escrita volta quando a cópia terminar |
| `415` | O corpo não é JSON |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.