> ## 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. # Alterar curso > Publica, agenda, despublica, arquiva. ## OpenAPI ````yaml PATCH /v1/clubs/{clubId}/courses/{courseId} 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}/courses/{courseId}: parameters: - $ref: '#/components/parameters/OrgId' - $ref: '#/components/parameters/CourseId' patch: tags: - content summary: Altera um curso description: | Só o que vier muda. `published_at` publica (data no passado), agenda (no futuro) ou despublica (nulo explícito). `archived` tira o curso do classroom sem apagar nada. `slug` troca o nome curto — e só ele: mudar o `title` não mexe num identificador que alguém já guardou. Exige permissão de administração do club. operationId: updateCourse requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CourseUpdate' responses: '200': description: Curso alterado content: application/json: schema: $ref: '#/components/schemas/CourseDetailResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': description: Já existe curso com este `slug` no club (`slug_taken`). content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '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 CourseId: name: courseId in: path required: true schema: type: string format: uuid schemas: CourseUpdate: type: object properties: title: type: string minLength: 1 maxLength: 200 format: $ref: '#/components/schemas/CourseFormat' description: | Trocar o formato muda só onde o conteúdo aparece e como a tela o chama; o que está dentro continua igual — um ebook que vira curso mantém a aula, os blocos e a agenda. slug: description: | O nome curto do curso, único no club. Só muda quando vem explícito: renomear o curso NÃO o regera, porque ele é identificador — quem integra pela API guarda o dele. A URL do aluno é o `public_id`. type: string minLength: 1 maxLength: 120 subtitle: type: string maxLength: 200 nullable: true instructor_name: description: Quem ensina. Nulo (ou vazio) volta a mostrar o nome do club. type: string maxLength: 120 nullable: true description: type: string maxLength: 5000 nullable: true cover_media_id: description: A capa, da biblioteca do club. Nulo tira a capa. type: string format: uuid nullable: true background_media_id: description: O fundo da página, da biblioteca do club. Nulo tira o fundo. type: string format: uuid nullable: true purchase_url: description: Endereço `http` ou `https`. Nulo (ou vazio) tira o botão de compra. type: string maxLength: 2000 nullable: true visibility: $ref: '#/components/schemas/CourseVisibility' show_modules: type: boolean comments_enabled: description: | A conversa embaixo da aula. Vale nos dois níveis e eles compõem: desligar aqui cala o curso inteiro sem editar aula por aula. type: boolean release: $ref: '#/components/schemas/Release' published_at: type: string format: date-time nullable: true description: Nulo explícito despublica. archived: type: boolean CourseDetailResponse: type: object required: - data properties: data: $ref: '#/components/schemas/CourseDetail' 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 CourseFormat: type: string enum: - course - ebook - masterclass default: course description: | Como o conteúdo se APRESENTA — a aba em que ele aparece no catálogo e a palavra que a tela escreve. Não é um tipo de domínio: um ebook é um curso de uma aula, com a mesma árvore, os mesmos blocos, a mesma agenda e o mesmo entregável, e NENHUMA regra de acesso, de estrutura ou de liberação olha para este campo. `course` é o catálogo com módulos e aulas, `ebook` é a leitura (um PDF), `masterclass` é a aula única em vídeo — gravação de live inclusive, que só difere na procedência. Curso criado sem formato é `course`. CourseVisibility: type: string enum: - members - entitled - unlisted description: | Descoberta, não acesso. `members` lista para todo aluno do club; `entitled` só para quem já tem; `unlisted` só para quem já tem por matrícula (entrega aberta não basta) — e quem tem o link vê a página como vitrine, mesmo sem direito. Release: type: object required: - kind description: | A agenda de liberação, como EXPRESSÃO: quando a aula (ou o módulo) abre para quem já tem direito a ela. Nunca amplia direito — só segura o que a matrícula já deu. Cada condição responde com uma DATA, não com sim ou não, e é por isso que elas compõem sem ambiguidade: `all` é a maior das datas, `any` é a menor. Condição que depende de algo que o aluno ainda não fez não tem data: dentro de `all` ela segura tudo, dentro de `any` ela é só um caminho que ainda não abriu. As folhas são todas MONÓTONAS — uma vez verdadeiras, verdadeiras para sempre: - `immediate`: sem condição. - `days_after_start`: `days` dias depois de o acesso começar (a matrícula mais antiga que abre o curso, ou o início da turma). - `on_date`: na data `at`. - `after_previous`: depois de concluir a aula anterior na ordem do curso. Na primeira aula, libera. - `after_lesson`: depois de concluir a aula `lesson_id`, do mesmo curso. - `after_module`: depois de concluir todas as aulas de `module_id`. - `after_count`: depois de concluir `count` aulas do curso. `days` atrasa o que o nó decidiu ("7 dias depois de concluir o módulo 1") e vale em qualquer nó, menos em `immediate`. Quem tem direito é pergunta de matrícula, não de agenda: não há condição de turma, de etiqueta nem de perfil aqui, de propósito — elas podem deixar de valer, e acesso que oscila é acesso que ninguém sabe explicar. A aula referenciada que sai do curso (arquivada, despublicada) deixa de segurar: esperar por uma conclusão que não pode mais acontecer trancaria o curso para sempre. properties: kind: type: string enum: - all - any - immediate - on_date - days_after_start - after_previous - after_lesson - after_module - after_count children: description: As condições de `all` e `any`. type: array items: $ref: '#/components/schemas/Release' days: description: Atraso, em dias, sobre o que o nó decidiu. type: integer minimum: 0 maximum: 3650 at: description: A data de `on_date`. type: string format: date-time lesson_id: description: A aula de `after_lesson`. type: string format: uuid module_id: description: O módulo de `after_module`. type: string format: uuid count: description: Quantas aulas, em `after_count`. type: integer minimum: 1 label: description: | O nome que quem administra deu a este nó ("Grupo 1", "Turma de março"). É só da tela do admin: não muda a avaliação e não vai para o classroom. type: string maxLength: 60 CourseDetail: allOf: - $ref: '#/components/schemas/Course' - type: object required: - modules - student_count properties: student_count: description: | Quantos alunos têm acesso AGORA — a mesma conta do `CourseSummary`. A página do curso a escreve embaixo do título ("412 alunos liberados"). type: integer modules: type: array items: $ref: '#/components/schemas/Module' Course: type: object required: - id - title - slug - public_id - format - visibility - show_modules - archived - release - comments_enabled - created_at properties: id: type: string format: uuid description: Também é o id do entregável — o que se põe numa entrega. title: type: string slug: type: string public_id: type: string description: A chave da URL do classroom. format: $ref: '#/components/schemas/CourseFormat' subtitle: description: A linha que explica o curso, embaixo do título. type: string instructor_name: description: | Quem ensina, como o aluno lê no card e na página do curso. Texto livre, e não uma pessoa da equipe: o instrutor de um curso comprado pronto não tem conta no club. Ausente, o classroom escreve o nome do club. type: string description: type: string cover: $ref: '#/components/schemas/Media' background: $ref: '#/components/schemas/Media' description: | O fundo da página do curso no classroom, atrás do cabeçalho. Da biblioteca do club, como a capa. purchase_url: description: | Para onde vai o "Comprar" que o aluno SEM acesso vê. Só leva a uma página de venda: quem dá o acesso continua sendo a matrícula. type: string visibility: $ref: '#/components/schemas/CourseVisibility' show_modules: type: boolean comments_enabled: description: | A conversa embaixo da aula. Vale nos dois níveis e eles compõem: desligar aqui cala o curso inteiro sem editar aula por aula. type: boolean release: $ref: '#/components/schemas/Release' description: | A agenda do curso, que compõe com a do módulo e a da aula: a aula abre quando as três abrirem. É onde mora "o curso abre 30 dias depois da compra" — `published_at` é a data para todo mundo, esta é contada da matrícula de cada aluno. published_at: type: string format: date-time description: Ausente é rascunho; no futuro é agendado. archived: type: boolean created_at: type: string format: date-time Module: type: object required: - id - course_id - title - position - show_when_empty - archived - release - restricted - restricted_to - lessons properties: id: type: string format: uuid course_id: type: string format: uuid title: type: string position: type: integer show_when_empty: type: boolean cover: $ref: '#/components/schemas/Media' description: A capa que abre a seção do módulo no currículo do aluno. archived: description: > Módulo arquivado some do classroom com as aulas dentro, e continua na resposta do admin para poder voltar. type: boolean release: $ref: '#/components/schemas/Release' restricted: description: | Se o módulo é só de quem tem uma das `restricted_to`. Restrito e sem entrega nenhuma (a última que o abria foi apagada) é FECHADO para todos — nunca aberto por omissão. type: boolean restricted_to: description: | As entregas que abrem este módulo. Vazio (e `restricted` falso) é o de sempre: todos com acesso ao curso o veem. Com entregas, só quem tem uma delas (ou uma entrega de "tudo do club") vê o módulo e as aulas dele — para os outros ele não existe, nem conta no progresso. É acesso, e não agenda: a turma o dá pelo bônus. type: array items: type: string format: uuid lessons: description: | As aulas em ordem, em SUMÁRIO: a árvore desenha a linha de cada aula, e um curso de duas mil aulas com o conteúdo inteiro de cada uma passava de 4 MB — em toda leitura e em toda resposta de arrastar. O conteúdo completo é `getLesson`. type: array items: $ref: '#/components/schemas/LessonOutline' 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 do arquivo — o `preview_url` abre na aba. No arquivo hospedado, baixa com o nome original; no vídeo hospedado, é o MP4 em 720p. Referência de fora não tem download. type: string expires_at: description: | A gravação de live ou de encontro sem a Hospedagem de vídeo sai nesta data — baixe antes (`download_url`) ou contrate a Hospedagem, e ela fica. Ausente é mídia que não vence. type: string format: date-time 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 LessonOutline: description: A aula na árvore do curso — o que a linha desenha. type: object required: - id - module_id - title - public_id - type - position - archived - comments_enabled - downloadable - has_video - created_at properties: id: type: string format: uuid module_id: type: string format: uuid title: type: string public_id: type: string type: $ref: '#/components/schemas/LessonType' position: type: integer archived: type: boolean comments_enabled: type: boolean downloadable: type: boolean has_video: description: | Se a aula tem bloco de vídeo ou de incorporação. A tela avisa a aula publicada sem nenhum dos dois. type: boolean published_at: type: string format: date-time duration_seconds: type: integer thumbnail_url: description: | A miniatura da linha, com endereço de entrega (que pode vencer): a da `thumbnail` da aula, ou, sem ela, a da mídia que a aula toca. type: string created_at: type: string format: date-time 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ó. `safevideo` é o vídeo guardado no SafeVideo, que a extensão de mesmo nome traz: o player é o deles, e a entrega ao aluno sai com a marca d'água dele. type: string enum: - bunny_stream - r2 - youtube - vimeo - external - safevideo 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 LessonType: type: string enum: - video - text - audio - file 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' 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. ````