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

# Reordena os destaques

> Os destaques ativos na ordem final, numa chamada.



## OpenAPI

````yaml PUT /v1/clubs/{clubId}/classroom-banner-order
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
  - name: exports
  - name: certificates
paths:
  /v1/clubs/{clubId}/classroom-banner-order:
    parameters:
      - $ref: '#/components/parameters/OrgId'
    put:
      tags:
        - classroom
      summary: Reordena os destaques
      description: |
        Os destaques ATIVOS na ordem final, numa chamada. Lista que não bate com
        a do servidor — alguém criou ou arquivou um destaque enquanto esta tela
        arrastava — é 409 `structure_stale`, e nada muda.

        Exige administrar o club.
      operationId: reorderClassroomBanners
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClassroomBannerOrder'
      responses:
        '200':
          description: Os destaques na ordem nova
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassroomBannerList'
        '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
  schemas:
    ClassroomBannerOrder:
      type: object
      required:
        - banner_ids
      additionalProperties: false
      properties:
        banner_ids:
          description: Os destaques ATIVOS, na ordem final.
          type: array
          items:
            type: string
            format: uuid
    ClassroomBannerList:
      type: object
      required:
        - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ClassroomBanner'
    ClassroomBanner:
      description: |
        Um destaque da faixa de abertura do Início, como quem edita o vê.
      type: object
      required:
        - id
        - title
        - position
        - archived
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
        kicker:
          description: A linha pequena acima do título — "Novo curso", "Quinta, 20h".
          type: string
        title:
          type: string
        body:
          type: string
        cta_label:
          description: O rótulo do botão. Ausente é destaque sem botão.
          type: string
        cover:
          $ref: '#/components/schemas/Media'
        video:
          $ref: '#/components/schemas/Media'
          description: |
            O vídeo de fundo, que roda mudo e em laço atrás do texto. A `cover`
            continua sendo o que aparece enquanto ele carrega.
        target:
          $ref: '#/components/schemas/ClassroomBannerTarget'
        target_label:
          description: |
            O nome do que o destaque abre — o título do curso, da aula ou da
            live —, para a lista do admin não precisar buscá-lo.
          type: string
        starts_at:
          description: Quando ele passa a aparecer. Ausente é desde já.
          type: string
          format: date-time
        ends_at:
          description: |
            Quando ele some sozinho. É o que faz o destaque da live da quinta
            sair do ar sem ninguém precisar lembrar dele na sexta.
          type: string
          format: date-time
        position:
          type: integer
        archived:
          type: boolean
        created_at:
          type: string
          format: date-time
        updated_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
    Media:
      type: object
      required:
        - id
        - kind
        - title
        - provider
        - status
        - visibility
        - archived
        - created_at
      properties:
        id:
          type: string
          format: uuid
        kind:
          $ref: '#/components/schemas/MediaKind'
        title:
          type: string
        file_name:
          type: string
        mime:
          type: string
        size_bytes:
          type: integer
          format: int64
        provider:
          $ref: '#/components/schemas/MediaProvider'
        external_id:
          description: |
            O id no provedor de FORA (o vídeo do YouTube, a URL colada). Para o
            que hospedamos, o id não vai na resposta: o que a tela precisa é o
            `preview_url` assinado.
          type: string
        status:
          $ref: '#/components/schemas/MediaStatus'
        visibility:
          $ref: '#/components/schemas/MediaVisibility'
        error:
          type: string
        duration_seconds:
          type: integer
        width:
          type: integer
        height:
          type: integer
        preview_url:
          description: |
            Endereço assinado e de prazo curto, para a tela do admin ver o que é
            este arquivo. Não é guardado em lugar nenhum — expira.
          type: string
        thumbnail_url:
          description: A miniatura, assinada pelo mesmo prazo curto.
          type: string
        folder_id:
          type: string
          format: uuid
        archived:
          type: boolean
        created_at:
          type: string
          format: date-time
        type:
          $ref: '#/components/schemas/MediaScreenType'
        download_url:
          description: |
            Endereço assinado e de prazo curto que BAIXA o arquivo, com o nome
            original — o `preview_url` abre na aba. Só para arquivo hospedado:
            vídeo e referência de fora não têm download.
          type: string
        favorite:
          description: |
            Se QUEM PEDE favoritou. Vem na lista, na leitura de uma e nas
            edições da biblioteca; ausente nas outras respostas.
          type: boolean
        usage_count:
          description: |
            Em quantos lugares a mídia é usada — o "usado em 3 lugares" da tela.
            A lista é `GET /media/{mediaId}/usage`. Vem na lista, na leitura de
            uma e nas edições da biblioteca.
          type: integer
    ClassroomBannerTarget:
      description: |
        Para onde o destaque leva. Exatamente UM dos campos — um destaque que
        apontasse para duas coisas não teria botão que se pudesse escrever.
      type: object
      additionalProperties: false
      properties:
        course_id:
          type: string
          format: uuid
        lesson_id:
          type: string
          format: uuid
        live_id:
          type: string
          format: uuid
        url:
          description: Um endereço de fora, para quando o destino não é nosso.
          type: string
          format: uri
    MediaKind:
      description: Rótulo de tela — o ícone e o filtro. Nada de acesso lê isto.
      type: string
      enum:
        - video
        - audio
        - image
        - document
    MediaProvider:
      description: |
        Onde o bit mora. `bunny_stream` é o vídeo que hospedamos e `r2` o
        arquivo; `youtube`, `vimeo` e `external` são referências a algo de fora,
        que a biblioteca guarda para a aula ter um caminho só.
      type: string
      enum:
        - bunny_stream
        - r2
        - youtube
        - vimeo
        - external
    MediaStatus:
      description: |
        `uploading` enquanto o arquivo não chegou, `processing` enquanto o
        provedor transcodifica, `ready` quando dá para entregar, `failed`
        quando o provedor desistiu (e aí `error` diz por quê).
      type: string
      enum:
        - uploading
        - processing
        - ready
        - failed
    MediaVisibility:
      description: |
        `private` é o padrão, e continua sendo depois de qualquer dúvida:
        publicar é escolha explícita.

        A diferença é de BUCKET, não de um sinalizador na hora de entregar —
        objeto privado não tem endereço público, então nenhum erro de código
        consegue publicá-lo. Privado é entregue por endereço assinado e de
        prazo curto; público, por um endereço estável que o CDN cacheia.

        Público existe para o que precisa ser visto por quem ainda não comprou
        e sobreviver a um cache: a capa do curso na vitrine, a marca do club, o
        trailer. Uma URL assinada não serve para isso — ela muda a cada
        resposta, então o CDN nunca acerta, a prévia de link do WhatsApp busca
        a imagem dias depois e a capa dentro de um e-mail vence.
      type: string
      enum:
        - private
        - public
    MediaScreenType:
      description: |
        O tipo como a TELA o mostra: o `kind`, com `document` separado em `pdf`
        e `file` (o zip, a planilha, o resto), e `embed` para a referência de
        fora (`youtube`, `vimeo`, `external`), qualquer que seja o `kind`. É
        derivado do provedor, do `kind`, do tipo do arquivo e da extensão, e é
        o mesmo que o filtro `types` usa.
      type: string
      enum:
        - video
        - image
        - audio
        - pdf
        - file
        - embed
  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

- [Destaques do Início](/api-reference/classroom/banners-list.md)
- [Cria um destaque](/api-reference/classroom/banners-create.md)
- [Reordenar espaços](/api-reference/community/spaces-order.md)
- [Edita, agenda ou arquiva um destaque](/api-reference/classroom/banners-update.md)
- [Reordenar metas](/api-reference/mentorships/goal-order.md)
