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

# Definir etapas

> As etapas ativas na ordem final; a que sai é arquivada, nunca apagada.



## OpenAPI

````yaml PUT /v1/clubs/{clubId}/mentorships/{mentorshipId}/stages
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.weve.cx
    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
paths:
  /v1/clubs/{clubId}/mentorships/{mentorshipId}/stages:
    parameters:
      - $ref: '#/components/parameters/OrgId'
      - $ref: '#/components/parameters/MentorshipId'
    put:
      tags:
        - mentorships
      summary: Define as etapas do quadro
      description: |
        As etapas ATIVAS na ordem final, numa chamada: item com `id` renomeia
        (e desarquiva, se estava arquivada), item sem `id` cria, e a etapa ativa
        que não veio é ARQUIVADA — nunca apagada, porque o histórico de
        movimentação aponta para ela.

        Arquivar etapa com gente dentro é 409 `stage_not_empty`: mova as pessoas
        antes. Etapa de outra mentoria é 422. As etapas são o quadro de quem
        mentora e não decidem acesso nenhum.
      operationId: setMentorshipStages
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MentorshipStagesUpdate'
      responses:
        '200':
          description: A mentoria
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MentorshipDetailResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '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
    MentorshipId:
      name: mentorshipId
      in: path
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    MentorshipStagesUpdate:
      type: object
      required:
        - stages
      properties:
        stages:
          description: As etapas ATIVAS, na ordem final.
          type: array
          maxItems: 20
          items:
            $ref: '#/components/schemas/MentorshipStageInput'
    MentorshipDetailResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/MentorshipDetail'
    MentorshipStageInput:
      type: object
      required:
        - name
      properties:
        id:
          type: string
          format: uuid
          description: Ausente cria a etapa.
        name:
          type: string
          minLength: 1
          maxLength: 60
    MentorshipDetail:
      type: object
      required:
        - mentorship
        - stages
        - deliveries
      properties:
        mentorship:
          $ref: '#/components/schemas/Mentorship'
        stages:
          description: Todas as etapas, na ordem, as arquivadas no fim.
          type: array
          items:
            $ref: '#/components/schemas/MentorshipStage'
        deliveries:
          type: array
          items:
            $ref: '#/components/schemas/MentorshipDelivery'
    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
    Mentorship:
      type: object
      required:
        - id
        - public_id
        - name
        - visibility
        - session_minutes
        - buffer_minutes
        - slot_step_minutes
        - min_notice_minutes
        - booking_horizon_days
        - cancel_notice_minutes
        - quota_kind
        - archived
        - mentors
        - created_at
      properties:
        id:
          type: string
          format: uuid
          description: Também é o id do entregável — o que se põe numa entrega.
        public_id:
          type: string
          description: A chave da URL da mentoria no classroom.
        name:
          type: string
        description:
          type: string
        visibility:
          $ref: '#/components/schemas/MentorshipVisibility'
        session_minutes:
          type: integer
          description: A duração da sessão individual que o aluno reserva.
        buffer_minutes:
          type: integer
          description: >-
            O respiro depois de cada sessão, em que a pessoa não pode ser
            reservada.
        slot_step_minutes:
          type: integer
          description: >-
            De quanto em quanto tempo os horários são oferecidos dentro de uma
            janela.
        min_notice_minutes:
          type: integer
          description: A antecedência mínima para reservar.
        booking_horizon_days:
          type: integer
          description: Até quantos dias à frente o aluno vê a agenda.
        cancel_notice_minutes:
          type: integer
          description: Desmarcar com menos antecedência que isto consome o crédito.
        quota_kind:
          $ref: '#/components/schemas/MentorshipQuotaKind'
        quota:
          type: integer
          description: Ausente na ilimitada.
        published_at:
          type: string
          format: date-time
          description: Ausente é não publicada — só a equipe a vê.
        archived:
          type: boolean
        mentors:
          type: array
          items:
            $ref: '#/components/schemas/MentorSummary'
        created_at:
          type: string
          format: date-time
    MentorshipStage:
      type: object
      required:
        - id
        - name
        - position
        - archived
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        position:
          type: integer
        archived:
          type: boolean
    MentorshipDelivery:
      type: object
      required:
        - delivery_id
        - name
        - scope
        - archived
      description: Uma entrega que abre a mentoria, e a cota que ela dá.
      properties:
        delivery_id:
          type: string
          format: uuid
        name:
          type: string
        scope:
          $ref: '#/components/schemas/DeliveryScope'
        archived:
          type: boolean
        quota_kind:
          $ref: '#/components/schemas/MentorshipQuotaKind'
        quota:
          type: integer
          description: |
            `quota_kind` e `quota` só vêm quando a entrega tem cota própria;
            ausentes, vale a da mentoria.
    MentorshipVisibility:
      type: string
      enum:
        - members
        - entitled
      x-enum-varnames:
        - MentorshipVisibilityMembers
        - MentorshipVisibilityEntitled
      description: >
        Descoberta, não acesso. `members` mostra a mentoria trancada a todo
        aluno

        do club — a vitrine; `entitled` só a quem tem direito ou histórico.
    MentorshipQuotaKind:
      type: string
      enum:
        - total
        - monthly
        - unlimited
      x-enum-varnames:
        - QuotaTotal
        - QuotaMonthly
        - QuotaUnlimited
      description: |
        Como a cota de CADA matrícula conta. `total`: `quota` sessões durante o
        acesso. `monthly`: `quota` por ciclo mensal, contado do início da
        matrícula (quem começou dia 31 renova no último dia dos meses curtos).
        `unlimited`: sem teto.
    MentorSummary:
      type: object
      required:
        - user_id
        - name
      properties:
        user_id:
          type: string
          format: uuid
        name:
          type: string
    DeliveryScope:
      type: string
      enum:
        - selected
        - all
  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'
    Conflict:
      description: >-
        Conflito com o estado atual. O `code` diz qual; a descrição da operação
        lista os possíveis.
      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'
    TooManyRequests:
      description: Teto por IP atingido
      headers:
        Retry-After:
          schema:
            type: integer
      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.

````

## Related topics

- [Definir quem atende](/api-reference/mentorships/mentors-set.md)
- [Definir o que a entrega abre](/api-reference/catalog/deliveries-deliverables.md)
- [Definir arquivos do mentorado](/api-reference/mentorships/participant-files-set.md)
- [Histórico de etapas](/api-reference/mentorships/stage-events.md)
- [Designar mentor ou mover de etapa](/api-reference/mentorships/participant-update.md)