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

# Matricular alunos

> Dá acesso à área por lista de e-mails (`items`) ou aos compradores de um produto seu (`source_product_id`), exatamente uma das duas.

#### Escopo

```bash theme={null}
    write members
```


## OpenAPI

````yaml POST /public_api/members/areas/{member_area_id}/enrollments/import/
openapi: 3.0.3
info:
  title: Cakto API
  version: 1.0.0
  description: Documentação da API pública do Cakto.
servers:
  - url: https://api.cakto.com.br
    description: Cakto API
security: []
paths:
  /public_api/members/areas/{member_area_id}/enrollments/import/:
    post:
      tags:
        - members
      summary: Matricular alunos
      description: >-
        Dá acesso à área por lista de e-mails (`items`) ou aos compradores de um
        produto seu (`source_product_id`), exatamente uma das duas. Quem já tem
        conta ganha a matrícula na hora; quem não tem recebe um convite por
        e-mail. Até 200 linhas o resultado vem na resposta (200); acima disso a
        importação vai para a fila (202) e o andamento sai em "Consultar
        importação".
      operationId: members_areas_enrollments_import_create
      parameters:
        - in: path
          name: member_area_id
          schema:
            type: string
            format: uuid
          description: ID da área de membros.
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicMembersEnrollmentImportCreate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicMembersEnrollmentImport'
          description: ''
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicMembersEnrollmentImport'
          description: ''
        '401':
          description: Request não autenticado devido à ausência ou invalidez do token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
              examples:
                Token ausente ou inválido:
                  $ref: '#/components/examples/UnauthenticatedErrorExample'
        '404':
          description: Não existe ou não é da sua conta.
      security:
        - OAuth Token: []
components:
  schemas:
    PublicMembersEnrollmentImportCreate:
      type: object
      description: 'A importação do painel sem a planilha (`file`): a API é só JSON.'
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/MemberAreaEnrollmentImportItem'
          description: Alunos por e-mail, com `starts_at`/`expires_at` opcionais.
        source_product_id:
          type: string
          description: Matricula quem comprou este produto seu.
        access_plan:
          type: string
          format: uuid
          nullable: true
          description: Plano de acesso; sem ele vale o plano padrão.
    PublicMembersEnrollmentImport:
      type: object
      description: >-
        Só para o schema: o `summary` da importação é um objeto de contagens,
        não texto.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          description: Identificador único da importação no sistema
        status:
          allOf:
            - $ref: '#/components/schemas/PublicMembersEnrollmentImportStatusEnum'
          readOnly: true
          description: |-
            Status atual do processamento da importação

            * `processing` - Processando
            * `completed` - Concluído
            * `failed` - Falhou
            * `deleted` - Excluído
        source:
          allOf:
            - $ref: '#/components/schemas/PublicMembersEnrollmentImportSourceEnum'
          readOnly: true
          title: Origem
          description: |-
            Origem dos membros importados

            * `csv` - Arquivo CSV
            * `json` - Lista JSON
            * `product` - Produto Cakto
        access_plan:
          allOf:
            - $ref: '#/components/schemas/MemberAreaAccessPlans'
          readOnly: true
        summary:
          allOf:
            - $ref: '#/components/schemas/MembersEnrollmentImportSummary'
          readOnly: true
        results:
          readOnly: true
          title: Resultado por Linha
          description: Resultado individual de cada linha processada na importação
        created_at:
          type: string
          format: date-time
          readOnly: true
          title: Criado em
          description: Data de criação da importação
        finished_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
          title: Finalizado em
          description: Data e hora do fim do processamento da importação
      required:
        - access_plan
        - created_at
        - finished_at
        - id
        - results
        - source
        - status
        - summary
    UnauthenticatedError:
      type: object
      properties:
        detail:
          type: string
    MemberAreaEnrollmentImportItem:
      type: object
      properties:
        email:
          type: string
          nullable: true
        starts_at:
          type: string
          nullable: true
        expires_at:
          type: string
          nullable: true
    PublicMembersEnrollmentImportStatusEnum:
      enum:
        - processing
        - completed
        - failed
        - deleted
      type: string
      description: |-
        * `processing` - Processando
        * `completed` - Concluído
        * `failed` - Falhou
        * `deleted` - Excluído
    PublicMembersEnrollmentImportSourceEnum:
      enum:
        - csv
        - json
        - product
      type: string
      description: |-
        * `csv` - Arquivo CSV
        * `json` - Lista JSON
        * `product` - Produto Cakto
    MemberAreaAccessPlans:
      type: object
      properties:
        name:
          type: string
          readOnly: true
          title: Nome
          description: Nome do plano de acesso
        duration_days:
          type: integer
          readOnly: true
          nullable: true
          title: Duração em dias
          description: Duração do plano de acesso em dias, nulo para plano vitalício
      required:
        - duration_days
        - name
    MembersEnrollmentImportSummary:
      type: object
      properties:
        total:
          type: integer
        criados:
          type: integer
          description: Matrículas criadas.
        convites:
          type: integer
          description: Convites enviados a quem não tem conta.
        ja_existe:
          type: integer
          description: Já tinham matrícula ativa.
        erros:
          type: integer
          description: Linhas recusadas; o motivo está em `results`.
      required:
        - convites
        - criados
        - erros
        - ja_existe
        - total
  examples:
    UnauthenticatedErrorExample:
      summary: Token ausente ou inválido
      description: Token ausente ou inválido
      value:
        detail: As credenciais de autenticação não foram fornecidas.
  securitySchemes:
    OAuth Token:
      type: http
      scheme: bearer
      in: header
      name: Authorization
      description: >-
        Token de autenticação do tipo `Bearer {access_token}`, onde
        `{access_token}` é o token obtido no fluxo de
        [autenticação](/authentication).

````

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