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

# Pedir ação em lote

> Tag ou acesso para até 5000 alunos: a resposta é 202 com a ação na fila.

A ação anda em segundo plano, em lotes. Acompanhe o andamento com
[Andamento de ação em lote](/api-reference/students/bulk-actions-get) até `status`
ser `done` ou `failed`.


## OpenAPI

````yaml POST /v1/clubs/{clubId}/bulk-actions
openapi: 3.0.3
info:
  title: weve API
  description: >
    Contrato entre a API Go e o dashboard. **Este arquivo é a fonte de
    verdade**:

    os tipos e a interface de servidor em Go, e o client TypeScript, são todos

    gerados daqui (`make openapi`). Handler que divergir da interface não
    compila.


    A superfície interna (`/internal/*`) fica de fora de propósito: é acesso de

    máquina, protegido por segredo dedicado, e não é contrato de cliente.
  version: 0.2.0
servers:
  - url: https://api.useweve.com
    description: produção
  - url: http://localhost:8080
    description: desenvolvimento
security: []
tags:
  - name: health
  - name: session
  - name: account
  - name: clubs
  - name: members
  - name: webhooks
  - name: outgoing-webhooks
  - name: sales-platforms
  - name: catalog
  - name: content
  - name: classroom
  - name: community
  - name: mentorships
  - name: agents
  - name: lives
  - name: students
  - name: auth
  - name: campaigns
  - name: workflows
  - name: email
  - name: exports
  - name: certificates
  - name: terms
  - name: mcp
  - name: gamification
  - name: support
  - name: help
paths:
  /v1/clubs/{clubId}/bulk-actions:
    parameters:
      - $ref: '#/components/parameters/OrgId'
    post:
      tags:
        - students
      summary: Pede uma ação em lote
      description: |
        A ação sobre o que foi marcado numa lista do dashboard, feita em
        segundo plano: a resposta é 202 com a ação já na fila, e o progresso
        se lê em `GET .../bulk-actions/{actionId}`.

        - `students_tag` / `students_untag`: põe ou tira `tag_id`. Cada aluno
          segue a regra da marcação individual — só quem muda grava o evento
          que abre automações e webhooks.
        - `students_grant`: dá `delivery_id`, com a mesma regra de turma da
          concessão individual (`cohort_id` ausente é a turma matriculando
          agora; nulo, nenhuma), resolvida no pedido.
        - `students_cohort`: põe na turma `cohort_id`. Quem não tem a
          entrega dela a ganha já na turma (com o prazo e o bônus dela); quem
          tem é MOVIDO, como em `POST .../enrollments/{id}/move` — o prazo é
          recalculado pela turma e o bônus acompanha. Quem já está nela não
          muda.
        - `students_expiry`: redefine a validade de `delivery_id` nas
          matrículas vivas de cada aluno (fora assinatura, cuja validade é a
          da cobrança), pelo `expiry_mode`. Quem não tem a entrega é
          ignorado. Cada mudança entra no ledger como extensão ou
          encurtamento.

        Até 5000 alunos. Id de outro club e conta anonimizada contam em
        `skipped`. A ação anda em lotes, e cada lote vale sozinho: uma falha no
        meio não desfaz o que já foi feito.

        Exige permissão de administração do club.
      operationId: createBulkAction
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkActionCreate'
      responses:
        '202':
          description: Na fila
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkActionResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - userSession: []
components:
  parameters:
    OrgId:
      name: clubId
      in: path
      required: true
      description: >
        Id público da organização — o mesmo que `GET /v1/me` devolve em

        `organization_id`.


        Na URL o recurso se chama **club**; no contrato e no domínio,
        organization.

        A divergência é deliberada: `clubs` é a palavra do produto, e a URL é o
        que

        as pessoas leem.


        É o identificador do provedor de autenticação, e é assim de propósito:

        o cliente precisa nomear a organização ao pedir o token, e o token é o

        que prova o escopo. Um id só nosso obrigaria a traduzir um no outro

        antes de ter um token — e a tradução exigiria uma chamada escopada, que

        é justamente a que ainda não dá para fazer.


        O uuid interno da organização não aparece no contrato: ele é o que as

        chaves estrangeiras do domínio referenciam, e continua sendo nosso.
      schema:
        type: string
        format: uuid
  schemas:
    BulkActionCreate:
      type: object
      required:
        - kind
      description: |
        Quem a ação alcança vem em `target_ids` OU em `target_query` — um dos
        dois, nunca os dois.
      properties:
        kind:
          $ref: '#/components/schemas/BulkActionKind'
        target_query:
          $ref: '#/components/schemas/StudentSelectionQuery'
        target_ids:
          type: array
          minItems: 1
          maxItems: 5000
          items:
            type: string
            format: uuid
        tag_id:
          type: string
          format: uuid
          description: A tag de `students_tag` e `students_untag`.
        delivery_id:
          type: string
          format: uuid
          description: A entrega de `students_grant`.
        cohort_id:
          type: string
          format: uuid
          nullable: true
          description: |
            Em `students_grant`, a mesma regra da concessão individual. Em
            `students_cohort`, obrigatório: a turma de destino.
        expires_at:
          type: string
          format: date-time
          description: |
            Em `students_grant`, o fim do acesso; ausente é o da turma, ou
            vitalício. Em `students_expiry` com `expiry_mode` `date`, a data
            nova (no futuro).
        expiry_mode:
          type: string
          enum:
            - date
            - add_days
            - from_today
            - lifetime
          description: |
            Em `students_expiry`: `date` usa `expires_at`; `add_days` soma
            `days` à validade de cada matrícula (a vitalícia continua
            vitalícia); `from_today` é hoje mais `days`, a mesma data para
            todos; `lifetime` tira a data.
        days:
          type: integer
          minimum: 1
          maximum: 3650
          description: Em `students_expiry`, os dias de `add_days` e `from_today`.
    BulkActionResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/BulkAction'
    BulkActionKind:
      type: string
      enum:
        - students_tag
        - students_untag
        - students_grant
        - students_cohort
        - students_expiry
    StudentSelectionQuery:
      type: object
      description: |
        "Todos do filtro": os mesmos filtros de `GET .../students`, resolvidos
        pela API NO PEDIDO — a ação alcança quem estava no recorte quando foi
        pedida. Contas removidas e as de quem administra o club ficam de fora.
        Mais de 5000 alunos no recorte responde 422 `selection_too_large`.
      properties:
        search:
          type: string
          maxLength: 200
        segment:
          type: string
          enum:
            - all
            - at_risk
            - new
            - completed
        last_seen:
          type: string
          enum:
            - any
            - last_7_days
            - last_30_days
            - stale
        tag_id:
          type: string
          format: uuid
    BulkAction:
      type: object
      required:
        - id
        - kind
        - status
        - total
        - done
        - changed
        - skipped
        - created_at
      properties:
        id:
          type: string
          format: uuid
        kind:
          $ref: '#/components/schemas/BulkActionKind'
        status:
          type: string
          enum:
            - pending
            - running
            - done
            - failed
        total:
          type: integer
          description: Quantos ids o pedido trouxe.
        done:
          type: integer
          description: Quantos já foram tratados.
        changed:
          type: integer
          description: Quantos mudaram de fato (ganharam a tag, ou o acesso).
        skipped:
          type: integer
          description: Ids que não são alunos ativos deste club.
        error:
          type: string
          description: O motivo, quando `failed`.
        created_at:
          type: string
          format: date-time
        finished_at:
          type: string
          format: date-time
    ErrorEnvelope:
      type: object
      description: >-
        Envelope único de erro da API. O `code` é o contrato com o cliente — a
        `message` é diagnóstico, e pode mudar.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
          properties:
            code:
              type: string
            message:
              type: string
  responses:
    BadRequest:
      description: Requisição malformada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Unauthorized:
      description: Sessão ausente, expirada ou revogada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: >
        A sessão é válida, mas não age nesta organização. É a mesma resposta
        para

        uma organização que não existe — distinguir as duas deixaria enumerar

        organizações alheias.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    NotFound:
      description: Recurso não encontrado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    UnprocessableEntity:
      description: Campos obrigatórios ausentes ou inválidos
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    InternalError:
      description: >-
        Falha inesperada. O corpo nunca traz o erro real — ele fica no log e no
        rastreamento.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    userSession:
      type: http
      scheme: bearer
      description: |
        Token OPACO de sessão de quem administra, emitido por
        `/v1/auth/admin/sign-in` e verificado contra a nossa tabela — o mesmo
        desenho do `studentSession`, para a outra identidade.

        É o esquema de quem ADMINISTRA — o dashboard. O aluno do classroom usa o
        `studentSession`; uma rota consumida pelos dois declara os dois
        esquemas, e o middleware aceita qualquer um deles. As duas credenciais
        são opacas e chegam pelo mesmo cabeçalho: quem as separa é a tabela em
        que cada uma existe.

        O dashboard o guarda em cookie httpOnly, que o BFF troca pelo
        `Authorization` a cada chamada.

````