# weve

> Documentação pública da API weve.

- [Visão geral](https://docs.useweve.com/index.md): API REST da weve: JSON em todas as respostas, um envelope único de erro e um contrato OpenAPI que gera esta documentação.
- [Primeira chamada](https://docs.useweve.com/quickstart.md): Do health à primeira leitura autenticada, em menos de um minuto.
- [Erros](https://docs.useweve.com/essentials/errors.md): Um envelope único, um código estável por situação.
- [Liberação de conteúdo](https://docs.useweve.com/essentials/release.md): A agenda que segura uma aula até a data — ou até o aluno chegar lá.
- [Biblioteca de mídia](https://docs.useweve.com/essentials/media.md): Onde o arquivo do club mora, quem o usa, e como ele chega ao aluno.
- [Weve DRM](https://docs.useweve.com/essentials/watermark.md): Marca d'água com o nome e o documento de quem baixou o material.
- [Mentorias](https://docs.useweve.com/essentials/mentorships.md): Agenda, crédito e prontuário de quem acompanha alguém de perto.
- [Agentes](https://docs.useweve.com/essentials/agents.md): O assistente que o club cria, alimenta com o próprio material e oferece aos alunos.
- [Lives](https://docs.useweve.com/essentials/lives.md): A transmissão marcada que o club faz para quem tem acesso — na sala nossa ou fora dela.
- [Paginação](https://docs.useweve.com/essentials/pagination.md): limit e page nas listagens.
- [Limites de uso](https://docs.useweve.com/essentials/rate-limits.md): Teto por club — ou por IP — nas operações de escrita.
- [Campanhas e automações](https://docs.useweve.com/essentials/campaigns-and-workflows.md): O e-mail que o club manda aos alunos: disparos únicos e réguas que reagem ao que o aluno faz.
- [Webhook genérico](https://docs.useweve.com/essentials/generic-webhook.md): O envelope para plataformas sem integração nativa: gateways, áreas de membros, Zapier, Make, n8n.
- [Webhooks de saída](https://docs.useweve.com/essentials/webhooks.md): Os eventos que o club manda para o seu sistema: aluno, acesso, compra, assinatura e progresso.
- [Conectar agentes (MCP)](https://docs.useweve.com/essentials/mcp.md): Claude, ChatGPT, Cursor e outros agentes operando um club pelo Model Context Protocol.
- [Estado da API](https://docs.useweve.com/api-reference/health.md): Healthcheck da API e das dependências.
- [Criar conta](https://docs.useweve.com/api-reference/account/sign-up.md): Abre a conta de quem administra. Não emite sessão — a conta só vale depois do link da caixa de entrada, e não pertence a club nenhum: o club vem depois.
- [Confirmar e-mail](https://docs.useweve.com/api-reference/account/verify-email.md): Gasta o token do link, passa a conta a valer e já abre a sessão.
- [Confirmar celular](https://docs.useweve.com/api-reference/account/verify-phone.md): Gasta o código que o cadastro mandou pelo WhatsApp e marca o celular como confirmado. Não abre sessão.
- [Reenviar código do celular](https://docs.useweve.com/api-reference/account/verify-phone-resend.md): Manda um código novo pelo WhatsApp ao celular guardado na conta. Sempre 202.
- [Entrar](https://docs.useweve.com/api-reference/account/sign-in.md): Abre a sessão do dashboard e devolve o token opaco. E-mail desconhecido, senha errada, conta sem senha e e-mail não confirmado respondem igual.
- [Pedir código de entrada](https://docs.useweve.com/api-reference/account/login-code.md): Manda um código de seis dígitos que entra no lugar da senha — pelo WhatsApp, quando o celular e o e-mail estão confirmados, ou por e-mail. Sempre 202, exista ou não a conta.
- [Entrar com o código](https://docs.useweve.com/api-reference/account/login-code-exchange.md): Gasta o código, confirma o e-mail e abre a sessão do dashboard.
- [Quem sou eu](https://docs.useweve.com/api-reference/me.md): A pessoa da sessão do dashboard e os clubs a que ela pertence — o degrau antes das rotas escopadas.
- [Mudar o nome](https://docs.useweve.com/api-reference/account/update-me.md): O nome que quem administra leva no dashboard de todos os clubs.
- [Trocar a senha](https://docs.useweve.com/api-reference/account/change-password.md): A troca de dentro da sessão: pede a senha atual e encerra as outras sessões.
- [Trocar o celular](https://docs.useweve.com/api-reference/account/update-phone.md): O celular que recebe o código de entrada pelo WhatsApp: trocar pede a senha e uma nova confirmação.
- [Esqueci a senha](https://docs.useweve.com/api-reference/account/forgot-password.md): Manda o link de redefinição. Sempre 202, exista ou não a conta — e é a porta de quem tem conta sem senha.
- [Redefinir senha](https://docs.useweve.com/api-reference/account/reset-password.md): Gasta o token, grava a senha nova, confirma o e-mail e derruba todas as sessões.
- [Sair](https://docs.useweve.com/api-reference/account/sign-out.md): Encerra esta sessão, e só ela.
- [Criar conta de aluno](https://docs.useweve.com/api-reference/auth/sign-up.md): Abre a conta no classroom do club. Não emite sessão — a conta só vale depois do link da caixa de entrada.
- [Confirmar e-mail](https://docs.useweve.com/api-reference/auth/verify-email.md): Gasta o token de uso único e abre a sessão. Resgate no clique, nunca ao montar a tela.
- [Entrar no classroom](https://docs.useweve.com/api-reference/auth/sign-in.md): Abre a sessão do aluno e devolve o token opaco. E-mail desconhecido, senha errada e e-mail não confirmado respondem igual.
- [Pedir código de entrada](https://docs.useweve.com/api-reference/auth/login-code.md): Manda por e-mail um código de seis dígitos que entra no lugar da senha. Sempre 202, exista ou não a conta no club.
- [Entrar com o código](https://docs.useweve.com/api-reference/auth/login-code-exchange.md): Gasta o código, confirma o e-mail e abre a sessão do aluno.
- [Sessão do aluno](https://docs.useweve.com/api-reference/auth/session.md): Quem é o aluno da sessão apresentada, e como encerrá-la. O `/v1/me` do classroom.
- [Trocar código por sessão](https://docs.useweve.com/api-reference/auth/session-exchange.md): A outra ponta do acesso pelo dashboard: o classroom troca o código de uso único por uma sessão de aluno.
- [Pedir redefinição](https://docs.useweve.com/api-reference/auth/forgot-password.md): Manda o link de senha nova. Sempre 202, exista ou não a conta.
- [Redefinir senha](https://docs.useweve.com/api-reference/auth/reset-password.md): Grava a senha nova e derruba todas as sessões do aluno.
- [Encerrar sessão](https://docs.useweve.com/api-reference/auth/sign-out.md): Encerra só a sessão apresentada.
- [Vitrine do link de cadastro](https://docs.useweve.com/api-reference/auth/registration-link.md): O que a página de cadastro mostra antes do formulário.
- [Cadastro por link](https://docs.useweve.com/api-reference/auth/register-by-link.md): Cria a conta e abre as entregas do link.
- [Criar club](https://docs.useweve.com/api-reference/clubs/create.md): Cria o club com quem chamou como `owner`. O endereço no classroom é derivado do nome.
- [Club da sessão](https://docs.useweve.com/api-reference/clubs/get.md): O escopo do domínio. Uma sessão só responde pelo club em que foi emitida.
- [Painel](https://docs.useweve.com/api-reference/clubs/overview.md): Os números da tela inicial do admin: ritmo, conclusão, primeira resposta, pendências, agenda, semana e onde os alunos param.
- [Engajamento](https://docs.useweve.com/api-reference/clubs/engagement.md): Quem estudou no período, a sequência de dias de estudo, os posts na comunidade, quem sumiu e onde cada curso para.
- [Funil de um curso](https://docs.useweve.com/api-reference/clubs/course-funnel.md): Dos alunos com acesso ao curso, quantos concluíram cada módulo, cada aula e receberam o certificado.
- [Plano e uso do club](https://docs.useweve.com/api-reference/clubs/billing.md): O que o club assina, o ciclo corrente e o uso de cada recurso.
- [O que o club pode usar](https://docs.useweve.com/api-reference/clubs/entitlements.md): Por recurso, se o club pode usá-lo agora: disponível, fora do plano ou no limite.
- [Trocar o plano](https://docs.useweve.com/api-reference/clubs/billing-plan.md): Sobe na hora, cobrando a diferença; desce na virada do ciclo pago.
- [Portal de cobrança](https://docs.useweve.com/api-reference/clubs/billing-portal.md): Abre a sessão do portal da Stripe: cartão, faturas e dados fiscais.
- [Contratar um adicional](https://docs.useweve.com/api-reference/clubs/billing-addon-set.md): Contrata o adicional — em teste grátis na primeira vez, quando ele tem teste; senão cobrando na hora, no cartão cadastrado no portal.
- [Remover um adicional](https://docs.useweve.com/api-reference/clubs/billing-addon-remove.md): Sai na virada do que já foi pago; até lá segue funcionando.
- [Aviso da Stripe](https://docs.useweve.com/api-reference/clubs/stripe-webhook.md): Recebe da Stripe a troca de plano feita no portal de cobrança.
- [Aviso da Notaas](https://docs.useweve.com/api-reference/clubs/notaas-webhook.md): Recebe o desfecho da nota fiscal: emitida, recusada ou cancelada.
- [Nome e endereço do club](https://docs.useweve.com/api-reference/clubs/update.md): Renomeia o club e define o subdomínio em que o classroom atende. Com `slug` o endereço é exato; com `name`, derivado.
- [Membros](https://docs.useweve.com/api-reference/clubs/members.md): Quem pertence ao club, com o papel de cada um. Qualquer membro lê.
- [Tirar da equipe](https://docs.useweve.com/api-reference/clubs/remove-member.md): Tira alguém do time do club — ou, com o próprio id, sai dele. O dono não sai nem é tirado.
- [Convidar](https://docs.useweve.com/api-reference/clubs/invite.md): Manda um link para o e-mail entrar no club como `admin` ou `member`. Sempre 202.
- [Convites do club](https://docs.useweve.com/api-reference/clubs/invitations.md): Os convites que ainda esperam resposta. Cada um ocupa uma vaga da equipe.
- [Cancelar convite](https://docs.useweve.com/api-reference/clubs/cancel-invitation.md): O link deixa de valer e a vaga da equipe volta a ficar livre.
- [Aceitar convite](https://docs.useweve.com/api-reference/clubs/accept-invitation.md): Gasta o token do link e associa quem chamou ao club do convite.
- [Convites pendentes](https://docs.useweve.com/api-reference/clubs/pending-invitations.md): Os convites ainda válidos para o e-mail da sessão.
- [Aceitar convite pendente](https://docs.useweve.com/api-reference/clubs/accept-pending-invitation.md): Aceita, sem o link, um convite endereçado ao e-mail da sessão.
- [Club de um endereço](https://docs.useweve.com/api-reference/clubs/by-slug.md): Nome e slug do club que atende num subdomínio. Anônima: é o que as telas de entrada do classroom leem antes de existir sessão.
- [Club do endereço inteiro](https://docs.useweve.com/api-reference/clubs/by-host.md): A mesma vitrine da rota por slug, alcançada pelo host como o browser o vê — domínio próprio ou `<slug>.weve.club`. Anônima, e o classroom deixa de saber qual é o caso.
- [Disponibilidade de endereço](https://docs.useweve.com/api-reference/clubs/slug-availability.md): Se um endereço do classroom pode ser escolhido agora. É o que o onboarding consulta enquanto a pessoa digita; a criação confere de novo.
- [Configurações do club](https://docs.useweve.com/api-reference/clubs/settings-get.md): Os avisos que o club manda por e-mail. Sem configuração, valem os defaults.
- [Alterar configurações](https://docs.useweve.com/api-reference/clubs/settings-update.md): Só o que vier muda. Desligar um aviso cala também o que já estava na fila.
- [Extensões do club](https://docs.useweve.com/api-reference/clubs/extensions-list.md): O catálogo de extensões, com o que o club ligou.
- [Ligar uma extensão](https://docs.useweve.com/api-reference/clubs/extensions-enable.md): Liga uma extensão no club. Não é cobrada nem medida.
- [Desligar uma extensão](https://docs.useweve.com/api-reference/clubs/extensions-disable.md): Desliga uma extensão. O que ela já trouxe continua funcionando.
- [Acesso ao classroom](https://docs.useweve.com/api-reference/clubs/classroom-session.md): Abre o acesso de quem administra ao classroom do club — devolve um código de uso único que o classroom troca por sessão.
- [Domínio próprio do club](https://docs.useweve.com/api-reference/clubs/domain-get.md): O endereço cadastrado, o estado derivado dele e os registros que precisam estar publicados no DNS do club.
- [Definir o domínio próprio](https://docs.useweve.com/api-reference/clubs/domain-set.md): Registra o endereço na borda que serve o classroom e devolve o que publicar no DNS. Um por club: mandar outro troca o que estava lá.
- [Conferir o domínio agora](https://docs.useweve.com/api-reference/clubs/domain-check.md): O botão "já configurei" da tela: antecipa a conferência que o laço faria de hora em hora.
- [Remover o domínio próprio](https://docs.useweve.com/api-reference/clubs/domain-delete.md): O club volta a atender só no `<slug>.weve.club`, e o endereço fica livre para quem quiser cadastrá-lo depois.
- [Receber evento de plataforma](https://docs.useweve.com/api-reference/webhooks/receive.md): A URL que se cola no painel da Hotmart, da Kiwify, da Eduzz, do Guru ou de um webhook genérico — grava o evento e responde antes de processar.
- [Ligar plataforma](https://docs.useweve.com/api-reference/webhooks/connections-create.md): Cria a conexão e devolve, uma única vez, a URL para colar no painel da plataforma.
- [Listar conexões](https://docs.useweve.com/api-reference/webhooks/connections-list.md): As contas do club nas plataformas de venda, sem token nem segredo.
- [Desligar conexão](https://docs.useweve.com/api-reference/webhooks/connections-disable.md): A URL passa a responder 404; o histórico fica.
- [Histórico de eventos](https://docs.useweve.com/api-reference/webhooks/events-list.md): O que as plataformas mandaram e o que o processamento concluiu de cada evento.
- [Ler um evento](https://docs.useweve.com/api-reference/webhooks/events-get.md): O evento com o corpo cru, para entender por que ficou parado ou falhou.
- [Reprocessar evento](https://docs.useweve.com/api-reference/webhooks/events-reprocess.md): Devolve o evento à fila. Seguro em qualquer estado: aplicar é idempotente.
- [Listar endpoints](https://docs.useweve.com/api-reference/webhook-endpoints/list.md): Os endereços que recebem os eventos do club, com o estado, o disjuntor e a fila de cada um.
- [Cadastrar endpoint](https://docs.useweve.com/api-reference/webhook-endpoints/create.md): Cadastra o endereço e devolve, uma única vez, o segredo que assina as entregas.
- [Ler um endpoint](https://docs.useweve.com/api-reference/webhook-endpoints/get.md): O endpoint, com o estado e o disjuntor. O segredo não sai.
- [Alterar endpoint](https://docs.useweve.com/api-reference/webhook-endpoints/update.md): Endereço, descrição, eventos e estado: ligar, pausar ou desligar.
- [Remover endpoint](https://docs.useweve.com/api-reference/webhook-endpoints/delete.md): Apaga o endpoint, o segredo e o histórico. Para só parar de mandar, desligue.
- [Trocar segredo](https://docs.useweve.com/api-reference/webhook-endpoints/rotate-secret.md): Sorteia um segredo novo; o anterior continua assinando por 24 horas.
- [Enviar teste](https://docs.useweve.com/api-reference/webhook-endpoints/test.md): Uma entrega webhook.test pelo mesmo caminho dos eventos de verdade.
- [Recuperar entregas](https://docs.useweve.com/api-reference/webhook-endpoints/recover.md): Depois de consertar o outro lado, reenvia o que falhou ou foi cancelado desde uma data.
- [Listar entregas](https://docs.useweve.com/api-reference/webhook-endpoints/deliveries-list.md): O histórico de entregas de um endpoint, mais recente primeiro.
- [Ler uma entrega](https://docs.useweve.com/api-reference/webhook-endpoints/deliveries-get.md): O corpo exato enviado e cada tentativa, com o que o destino respondeu.
- [Reenviar entrega](https://docs.useweve.com/api-reference/webhook-endpoints/deliveries-retry.md): Tenta agora, com o mesmo corpo e o mesmo webhook-id: uma tentativa a mais na entrega fechada, a próxima antecipada na pendente.
- [Tipos de exportação](https://docs.useweve.com/api-reference/exports/kinds.md): O catálogo do que dá para exportar: colunas de cada arquivo e os filtros que cada tipo aceita.
- [Listar exportações](https://docs.useweve.com/api-reference/exports/list.md): Os pedidos de exportação do club, com o andamento, quem pediu e quantas vezes o arquivo foi baixado.
- [Pedir uma exportação](https://docs.useweve.com/api-reference/exports/create.md): Põe o arquivo na fila: alunos, matrículas, progresso por curso ou tudo num .zip.
- [Consultar uma exportação](https://docs.useweve.com/api-reference/exports/get.md): O andamento de uma exportação: linhas geradas, situação e até quando o arquivo pode ser baixado.
- [Baixar o arquivo](https://docs.useweve.com/api-reference/exports/download.md): Redireciona para o arquivo por um endereço assinado de cinco minutos, e registra quem baixou.
- [Ver o certificado do curso](https://docs.useweve.com/api-reference/certificates/course-get.md): O que o curso imprime no certificado, a carga horária sugerida e quantos já foram emitidos.
- [Configurar o certificado do curso](https://docs.useweve.com/api-reference/certificates/course-set.md): Liga o certificado do curso e define título, texto, carga horária e assinatura.
- [Listar certificados](https://docs.useweve.com/api-reference/certificates/list.md): Os certificados emitidos pelo club, com recorte por curso, por aluno e por estado.
- [Ver um certificado](https://docs.useweve.com/api-reference/certificates/get.md): Um certificado emitido, com o instantâneo do que ele afirma.
- [Revogar um certificado](https://docs.useweve.com/api-reference/certificates/revoke.md): Marca o certificado como revogado, com motivo e autor.
- [Desfazer a revogação](https://docs.useweve.com/api-reference/certificates/restore.md): Volta o certificado a valer, limpando o motivo.
- [Reemitir um certificado](https://docs.useweve.com/api-reference/certificates/reissue.md): Recopia o que o certificado imprime a partir do que é verdade agora, mantendo o código.
- [Baixar o PDF de um certificado](https://docs.useweve.com/api-reference/certificates/download.md): O mesmo arquivo que o aluno recebe.
- [Verificar um certificado](https://docs.useweve.com/api-reference/certificates/verify.md): A rota anônima que responde se um certificado é verdadeiro.
- [Baixar o PDF por código](https://docs.useweve.com/api-reference/certificates/verify-download.md): O documento, para quem tem o código.
- [Ler a gamificação](https://docs.useweve.com/api-reference/gamification/get.md): Se está ligada, quanto vale cada ação e a escada de níveis.
- [Ajustar a gamificação](https://docs.useweve.com/api-reference/gamification/update.md): Liga, desliga, mostra o ranking e muda o valor das ações.
- [Trocar os níveis](https://docs.useweve.com/api-reference/gamification/levels.md): A escada inteira, começando no zero.
- [Ranking do clube](https://docs.useweve.com/api-reference/gamification/ranking.md): Quem mais pontuou na semana, no mês ou desde sempre.
- [Pontos de um aluno](https://docs.useweve.com/api-reference/gamification/student-points.md): O total, o nível e o extrato.
- [Ajustar pontos de um aluno](https://docs.useweve.com/api-reference/gamification/adjust.md): Dá ou tira pontos, com o motivo que o aluno lê.
- [Pontos de quem estuda](https://docs.useweve.com/api-reference/gamification/classroom-get.md): Nível, conquistas, como ganhar e o extrato recente.
- [Aparecer no ranking](https://docs.useweve.com/api-reference/gamification/classroom-update.md): O aluno escolhe se aparece no ranking dos colegas.
- [Ranking de quem estuda](https://docs.useweve.com/api-reference/gamification/classroom-ranking.md): Os cinquenta primeiros e a posição de quem pergunta.
- [Listar termos](https://docs.useweve.com/api-reference/terms/list.md): Os quatro termos do club, escritos ou não, com quantos alunos aceitaram a versão em vigor.
- [Ler um termo](https://docs.useweve.com/api-reference/terms/get.md): O texto em vigor e o histórico de versões, com os aceites de cada uma.
- [Escrever ou publicar um termo](https://docs.useweve.com/api-reference/terms/save.md): Mudar o título ou o texto publica uma versão nova, e todo aluno precisa aceitar de novo.
- [Termos do aluno](https://docs.useweve.com/api-reference/terms/classroom-list.md): Os termos ativos, com o que o aluno aceitou e o que está pendente.
- [Aceitar um termo](https://docs.useweve.com/api-reference/terms/classroom-accept.md): Registra o aceite da versão que o aluno leu.
- [Ler um pedido de conexão](https://docs.useweve.com/api-reference/mcp/authorization-get.md): O que o agente pediu, para a tela de consentimento.
- [Aprovar uma conexão](https://docs.useweve.com/api-reference/mcp/authorization-approve.md): Concede ao agente acesso a um club, com os escopos escolhidos.
- [Recusar uma conexão](https://docs.useweve.com/api-reference/mcp/authorization-deny.md): Fecha o pedido sem conceder nada.
- [Listar conexões e chaves](https://docs.useweve.com/api-reference/mcp/access-grants-list.md): Os agentes com acesso ao club.
- [Revogar conexão ou chave](https://docs.useweve.com/api-reference/mcp/access-grants-revoke.md): Corta o acesso do agente na chamada seguinte.
- [Criar chave de API](https://docs.useweve.com/api-reference/mcp/api-keys-create.md): Uma chave para o agente que não faz o fluxo OAuth.
- [student.created e student.updated](https://docs.useweve.com/api-reference/webhook-events/student.md): A conta de aluno nasceu no club, ou quem administra corrigiu o nome ou o e-mail.
- [student.removed](https://docs.useweve.com/api-reference/webhook-events/student-removed.md): O aluno foi removido do club. Só o id sai: é o sinal para apagá-lo do seu lado também.
- [access.*](https://docs.useweve.com/api-reference/webhook-events/access.md): Uma mudança no acesso de um aluno a uma entrega: ganhou, perdeu, mudou o prazo, voltou ou trocou de turma.
- [purchase.paid e purchase.refunded](https://docs.useweve.com/api-reference/webhook-events/purchase.md): Uma compra de produto mapeado foi aprovada, ou foi reembolsada ou contestada.
- [subscription.past_due e subscription.canceled](https://docs.useweve.com/api-reference/webhook-events/subscription.md): A cobrança de uma assinatura atrasou, ou a assinatura foi cancelada.
- [lesson.completed](https://docs.useweve.com/api-reference/webhook-events/lesson-completed.md): Um aluno concluiu uma aula pela primeira vez.
- [course.completed](https://docs.useweve.com/api-reference/webhook-events/course-completed.md): Um aluno concluiu todas as aulas publicadas de um curso.
- [certificate.issued](https://docs.useweve.com/api-reference/webhook-events/certificate-issued.md): O certificado de conclusão de um curso foi emitido para um aluno.
- [student.tagged e student.untagged](https://docs.useweve.com/api-reference/webhook-events/student-tagged.md): O aluno ganhou ou perdeu uma tag — pela equipe ou por um passo de automação.
- [student.level_reached](https://docs.useweve.com/api-reference/webhook-events/student-level-reached.md): O aluno chegou a um nível da gamificação do clube.
- [webhook.test](https://docs.useweve.com/api-reference/webhook-events/test.md): A mensagem do botão de teste. Não vem de fato nenhum: basta responder 2xx.
- [Criar produto](https://docs.useweve.com/api-reference/catalog/products-create.md): O que a plataforma vende. Sem entregas indicadas, uma nasce junto com o nome do produto.
- [Listar produtos](https://docs.useweve.com/api-reference/catalog/products-list.md): Cada produto com os ids externos e as entregas que abre.
- [Mapear id de plataforma](https://docs.useweve.com/api-reference/catalog/products-external-id.md): Liga um id externo ao produto e reprocessa as compras que chegaram antes.
- [Desfazer mapeamento](https://docs.useweve.com/api-reference/catalog/products-external-id-remove.md): Remove um id de plataforma do produto; compras registradas ficam.
- [Criar entrega](https://docs.useweve.com/api-reference/catalog/deliveries-create.md): Para bundle e entrega aberta; no caso comum a entrega nasce junto com o produto.
- [Listar entregas](https://docs.useweve.com/api-reference/catalog/deliveries-list.md): O que o club abre para quem tem direito.
- [Definir o que a entrega abre](https://docs.useweve.com/api-reference/catalog/deliveries-deliverables.md): Substitui o conjunto; scope all abre tudo do club.
- [Alterar produto](https://docs.useweve.com/api-reference/catalog/products-update.md): Nome, cobrança e arquivamento.
- [Definir o que o produto libera](https://docs.useweve.com/api-reference/catalog/products-deliveries.md): Troca as entregas e coleções que as compras novas do produto abrem.
- [Alterar entrega](https://docs.useweve.com/api-reference/catalog/deliveries-update.md): Nome, prazo, janela aberta e arquivamento.
- [Turmas de uma entrega](https://docs.useweve.com/api-reference/catalog/cohorts-list.md): Lista as turmas, com quantas pessoas estão em cada uma e o bônus.
- [Criar turma](https://docs.useweve.com/api-reference/catalog/cohorts-create.md): Uma turma agrupa as matrículas de uma entrega, com janela própria. A compra paga dentro da janela de matrícula entra nela.
- [Alterar turma](https://docs.useweve.com/api-reference/catalog/cohorts-update.md): Vale só para as próximas matrículas; quem já está na turma fica como estava até o reapply.
- [Reaplicar turma](https://docs.useweve.com/api-reference/catalog/cohorts-reapply.md): A ação explícita que alcança quem já está na turma: recalcula janelas, concede e revoga bônus, com ledger.
- [Quem está na turma](https://docs.useweve.com/api-reference/catalog/cohorts-students.md): A lista da turma com nome e e-mail, para exportar e avisar.
- [Estender a turma](https://docs.useweve.com/api-reference/catalog/cohorts-extend.md): Nova data de fim para todas as matrículas ativas da turma. Só alonga.
- [Revogar a turma](https://docs.useweve.com/api-reference/catalog/cohorts-revoke.md): Revoga toda matrícula da turma que ainda valia, com motivo no ledger.
- [Criar curso](https://docs.useweve.com/api-reference/content/courses-create.md): Nasce rascunho, com o primeiro módulo, e como entregável.
- [Listar cursos](https://docs.useweve.com/api-reference/content/courses-list.md): Os cursos do club, inclusive rascunhos e arquivados.
- [Ler curso](https://docs.useweve.com/api-reference/content/courses-get.md): A estrutura inteira: módulos e aulas em ordem.
- [Alterar curso](https://docs.useweve.com/api-reference/content/courses-update.md): Publica, agenda, despublica, arquiva.
- [Reordenar o curso](https://docs.useweve.com/api-reference/content/course-structure.md): A árvore inteira numa chamada: ordem dos módulos, ordem das aulas, e a aula que muda de módulo.
- [Listar entregas](https://docs.useweve.com/api-reference/content/submissions-list.md): A fila de correção das entregas dos alunos, com a contagem por estado.
- [Buscar entrega](https://docs.useweve.com/api-reference/content/submissions-get.md): Uma entrega com o texto, os arquivos e as instruções do bloco.
- [Corrigir entrega](https://docs.useweve.com/api-reference/content/submissions-review.md): Aprova ou pede ajuste, com um comentário para o aluno.
- [Listar repositórios](https://docs.useweve.com/api-reference/content/repositories-list.md): A aba Repositórios da tela de Conteúdo.
- [Criar repositório](https://docs.useweve.com/api-reference/content/repositories-create.md): Nasce rascunho, vazio e já como entregável.
- [Ler repositório](https://docs.useweve.com/api-reference/content/repositories-get.md): Com os arquivos, na ordem.
- [Alterar repositório](https://docs.useweve.com/api-reference/content/repositories-update.md): Título, descrição, capa, publicação e arquivamento.
- [Trocar os arquivos](https://docs.useweve.com/api-reference/content/repositories-items.md): A lista inteira, na ordem final.
- [A biblioteca do club](https://docs.useweve.com/api-reference/media/list.md): Qualquer membro lê; escrever exige administração.
- [Registra uma mídia](https://docs.useweve.com/api-reference/media/create.md): Três caminhos, e a resposta diz qual foi:
- [Confirma o envio de um arquivo](https://docs.useweve.com/api-reference/media/complete.md): O browser chama isto depois de terminar o envio direto. Quem confirma, porém, é o BUCKET: a API pergunta a ele se o objeto existe e qual o tamanho, e grava o que ele responder. "Enviado" não é a palavra de quem enviou.
- [Uma mídia](https://docs.useweve.com/api-reference/media/get.md)
- [Renomeia, move ou arquiva](https://docs.useweve.com/api-reference/media/update.md): Arquivar tira a mídia do seletor da biblioteca, e ela CONTINUA sendo entregue onde já está em uso: aula não quebra porque alguém organizou a biblioteca.
- [Exclui a mídia](https://docs.useweve.com/api-reference/media/delete.md): Só com ZERO usos: se alguma aula, anexo, capa ou logo aponta para ela, a resposta é 409 `media_in_use` com a lista de onde — que é a informação de que a pessoa precisa para decidir. Para tirar da biblioteca sem apagar o arquivo, arquive.
- [Onde a mídia é usada](https://docs.useweve.com/api-reference/media/usage.md): A resposta que uma tabela polimórfica de anexos existiria para dar — e que aqui sai de chaves estrangeiras de verdade, uma por dono.
- [A transcrição do vídeo](https://docs.useweve.com/api-reference/media/transcript.md): O que foi dito no vídeo, com o tempo de cada palavra. Vídeo sem transcrição responde 404 — é o estado normal de quem nunca a pediu.
- [Transcreve o vídeo, ou tenta de novo](https://docs.useweve.com/api-reference/media/transcribe.md): Põe o vídeo na fila de transcrição — e, se ele já tiver falhado, zera as tentativas e recomeça do zero, com um trabalho novo no provedor.
- [Armazenamento do club](https://docs.useweve.com/api-reference/media/storage.md)
- [Favorita uma mídia](https://docs.useweve.com/api-reference/media/favorite.md): O favorito é de QUEM PEDE, não do club: é o atalho de quem trabalha com a biblioteca, e a estrela de um colega não aparece na sua tela. Favoritar de novo não muda nada.
- [Tira uma mídia dos favoritos](https://docs.useweve.com/api-reference/media/unfavorite.md)
- [Substitui o arquivo](https://docs.useweve.com/api-reference/media/replace.md): Troca o arquivo SEM trocar a mídia: a aula, a capa e o anexo que apontam para ela continuam apontando, e passam a entregar o arquivo novo.
- [Duplica uma mídia](https://docs.useweve.com/api-reference/media/duplicate.md): Uma mídia nova, na mesma pasta, com " (cópia)" no nome. O arquivo é COPIADO dentro do armazenamento — os bytes não passam por aqui —, então editar ou apagar uma das duas não mexe na outra. A referência de fora (YouTube, Vimeo, endereço) é só uma linha nova.
- [Renomeia ou move várias mídias](https://docs.useweve.com/api-reference/media/batch-update.md): As ações em lote da tela — mover a seleção, renomear em série — numa transação: ou todas mudam, ou nenhuma. Cada item diz o que muda nele; `folder_id: null` leva para fora de pasta, e ausente não mexe.
- [Exclui várias mídias](https://docs.useweve.com/api-reference/media/batch-delete.md): A exclusão em lote NÃO é tudo-ou-nada, ao contrário do lote de edição: a regra de cada mídia é a da exclusão de uma — só com zero usos —, e uma mídia em uso não deve impedir a faxina das outras. A resposta separa o que foi excluído do que ficou, e diz onde cada uma que ficou está em uso.
- [Busca no banco de imagens](https://docs.useweve.com/api-reference/media/stock-search.md): Fotos do Pexels, para escolher antes de trazer para a biblioteca. Sem `q`, as fotos em destaque. A chave do Pexels fica aqui; o que a tela recebe são endereços públicos das miniaturas.
- [Traz fotos do banco de imagens](https://docs.useweve.com/api-reference/media/stock-import.md): Cada foto vira uma mídia PRONTA na biblioteca: a API busca a foto no Pexels pelo id — nunca por um endereço que o cliente mande —, baixa a versão grande e a guarda no armazenamento do club, privada como qualquer envio. Até 12 por vez.
- [Pastas da biblioteca](https://docs.useweve.com/api-reference/media/folders-list.md): A árvore inteira do club, achatada: cada pasta traz o `parent_id`, e quem desenha monta a hierarquia. São dezenas de pastas, e a tela precisa de todas para o painel lateral.
- [Cria uma pasta](https://docs.useweve.com/api-reference/media/folders-create.md): `parent_id` ausente cria na raiz. O nome é único dentro da mesma pasta (409 `folder_name_taken`), e o aninhamento tem teto — ver `invalid_folder`.
- [Renomeia ou move uma pasta](https://docs.useweve.com/api-reference/media/folders-update.md): Mover para dentro da própria subárvore é 422 `invalid_folder` — seria um ciclo, e a pasta sumiria da árvore. O nome continua único dentro da pasta de destino (409 `folder_name_taken`).
- [Apaga uma pasta](https://docs.useweve.com/api-reference/media/folders-delete.md): As pastas de dentro e as mídias sobem um nível, na mesma transação: conteúdo não some porque alguém arrumou a biblioteca.
- [Aviso do provedor de vídeo](https://docs.useweve.com/api-reference/media/webhook.md): A Bunny avisa quando termina de processar um vídeo. A rota é ANÔNIMA de propósito — quem chama é uma máquina de terceiro, que não tem sessão — e por isso não declara `security`; quem a protege é o segredo no caminho.
- [Criar módulo](https://docs.useweve.com/api-reference/content/modules-create.md): No fim do curso.
- [Alterar módulo](https://docs.useweve.com/api-reference/content/modules-update.md): Título, capa, agenda e se aparece vazio.
- [Duplicar módulo](https://docs.useweve.com/api-reference/content/modules-duplicate.md): Logo depois do original, com as aulas como rascunho.
- [Criar aula](https://docs.useweve.com/api-reference/content/lessons-create.md): No fim do módulo, com a liberação.
- [Ler aula](https://docs.useweve.com/api-reference/content/lessons-get.md): A aula completa, com blocos e materiais.
- [Alterar aula](https://docs.useweve.com/api-reference/content/lessons-update.md): Só o que vier muda; nulo explícito apaga.
- [Duplicar aula](https://docs.useweve.com/api-reference/content/lessons-duplicate.md): Logo depois da original, como rascunho.
- [Alterar aulas em lote](https://docs.useweve.com/api-reference/content/course-lessons-update.md): Publica, despublica ou arquiva a seleção numa transação.
- [Aulas do club](https://docs.useweve.com/api-reference/content/lessons-list.md): As aulas de todos os cursos, com o curso e o módulo pelo nome.
- [O Início do aluno](https://docs.useweve.com/api-reference/classroom/home.md): Destaques, retomada, novidades e ritmo da semana, numa chamada só.
- [As seções do menu do aluno](https://docs.useweve.com/api-reference/classroom/sections.md): Se agentes, lives, mentorias e comunidade têm algo para este aluno.
- [Preferências do aluno](https://docs.useweve.com/api-reference/classroom/preferences-get.md): O que quem estuda escolheu para si neste club.
- [Muda as preferências](https://docs.useweve.com/api-reference/classroom/preferences-update.md): Só o que vier no corpo muda.
- [Editar o próprio perfil](https://docs.useweve.com/api-reference/classroom/profile-update.md): A bio, a foto e os endereços que a turma vê.
- [Mudar o nome da conta](https://docs.useweve.com/api-reference/classroom/account-update.md): O nome que a conta do aluno leva em tudo.
- [Trocar a senha](https://docs.useweve.com/api-reference/classroom/password-change.md): A troca de senha de dentro da conta, que encerra as outras sessões.
- [Reservar o envio da foto](https://docs.useweve.com/api-reference/classroom/avatar-create.md): O PUT assinado da foto de perfil, como a imagem de um comentário.
- [Confirmar a foto enviada](https://docs.useweve.com/api-reference/classroom/avatar-complete.md): Quem diz que o arquivo chegou é o bucket.
- [Destaques do Início](https://docs.useweve.com/api-reference/classroom/banners-list.md): A faixa de abertura da área do aluno, na ordem, incluindo o que está agendado.
- [Aceitar um link de cadastro](https://docs.useweve.com/api-reference/classroom/registration-link-claim.md): Com a conta já aberta, as entregas do link se abrem num toque.
- [Cria um destaque](https://docs.useweve.com/api-reference/classroom/banners-create.md): Nasce no fim da fila e visível desde já.
- [Edita, agenda ou arquiva um destaque](https://docs.useweve.com/api-reference/classroom/banners-update.md): O destino é trocado como um bloco; arquivar não apaga o texto.
- [Reordena os destaques](https://docs.useweve.com/api-reference/classroom/banners-order.md): Os destaques ativos na ordem final, numa chamada.
- [Cursos do aluno](https://docs.useweve.com/api-reference/classroom/courses-list.md): Publicados e visíveis para este aluno, com acesso e progresso.
- [Página do curso](https://docs.useweve.com/api-reference/classroom/courses-get.md): Módulos e aulas, com o que pode abrir agora e quando.
- [Assistir aula](https://docs.useweve.com/api-reference/classroom/lessons-get.md): Corpo, vídeo e navegação; exige direito e liberação.
- [Marcar progresso](https://docs.useweve.com/api-reference/classroom/lessons-progress.md): Onde parou e se concluiu.
- [Conferir uma resposta do quiz](https://docs.useweve.com/api-reference/classroom/lessons-quiz-check.md): O retorno de uma pergunta na hora, sem gravar nada.
- [Enviar tentativa do quiz](https://docs.useweve.com/api-reference/classroom/lessons-quiz-attempt.md): Corrige no servidor, grava e conclui a aula quando cumpre o que a travava.
- [Enviar entrega](https://docs.useweve.com/api-reference/classroom/lessons-assignment-submit.md): Envia ou reenvia a entrega do aluno num bloco da aula.
- [Reservar o envio de um arquivo de entrega](https://docs.useweve.com/api-reference/classroom/assignment-files-create.md): O PUT assinado do arquivo, que só entra na entrega quando ela é enviada.
- [Confirmar o arquivo de entrega](https://docs.useweve.com/api-reference/classroom/assignment-files-complete.md): O bucket diz que o arquivo chegou; o teto é o da biblioteca.
- [Ler a transcrição](https://docs.useweve.com/api-reference/classroom/lessons-transcript.md): O que foi dito no vídeo da aula, em trechos com o seu minuto.
- [Copiloto da aula](https://docs.useweve.com/api-reference/classroom/lessons-copilot.md): O resumo da aula em pontos-chave, com o minuto do vídeo, e as tarefas para pôr em prática.
- [Marcar tarefa do Copiloto](https://docs.useweve.com/api-reference/classroom/lessons-copilot-task.md): Marca ou desmarca uma tarefa da aula como feita.
- [Listar as notas](https://docs.useweve.com/api-reference/classroom/lessons-notes-list.md): As notas do aluno na aula, na ordem do vídeo.
- [Escrever uma nota](https://docs.useweve.com/api-reference/classroom/lessons-notes-create.md): Uma nota privada, com o minuto do vídeo.
- [Apagar uma nota](https://docs.useweve.com/api-reference/classroom/lessons-notes-delete.md): Só quem escreveu apaga.
- [Salvar aula](https://docs.useweve.com/api-reference/classroom/lessons-save.md): Guarda a aula para voltar depois.
- [Tirar das salvas](https://docs.useweve.com/api-reference/classroom/lessons-unsave.md): Idempotente.
- [Aulas salvas](https://docs.useweve.com/api-reference/classroom/saved-lessons-list.md): As aulas que o aluno salvou e ainda pode abrir.
- [Notas do aluno](https://docs.useweve.com/api-reference/classroom/notes-list.md): Todas as notas do aluno, de todas as aulas que ele ainda pode abrir.
- [Comentários do aluno](https://docs.useweve.com/api-reference/classroom/my-comments-list.md): O que o aluno escreveu nas conversas das aulas.
- [Perguntar](https://docs.useweve.com/api-reference/classroom/lessons-ask-get.md): estado:O agente que responde sobre a aula, os tetos e a conversa de agora.
- [Perguntar sobre a aula](https://docs.useweve.com/api-reference/classroom/lessons-ask.md): A pergunta ao agente do curso, com a aula como foco e a resposta em streaming.
- [Repositórios do aluno](https://docs.useweve.com/api-reference/classroom/repositories-list.md): Os que a pessoa tem e estão no ar.
- [Abrir repositório](https://docs.useweve.com/api-reference/classroom/repositories-get.md): Os arquivos, com a entrega assinada.
- [Baixar arquivo do repositório](https://docs.useweve.com/api-reference/classroom/repository-file.md): A mesma entrega do material da aula, com a marca d'água.
- [Baixa um material carimbado](https://docs.useweve.com/api-reference/classroom/lesson-file.md): O arquivo de uma aula com o nome e o documento do aluno impressos em todas as páginas — a marca d'água do Weve DRM.
- [Turmas do aluno](https://docs.useweve.com/api-reference/classroom/cohorts-list.md): As turmas em que o aluno está, com os colegas pelo nome.
- [Os certificados do aluno](https://docs.useweve.com/api-reference/classroom/certificates-list.md): A estante do aluno, do mais novo para o mais antigo.
- [Baixar o próprio certificado](https://docs.useweve.com/api-reference/classroom/certificate-file.md): O PDF do certificado do aluno que está pedindo.
- [Comentários da aula](https://docs.useweve.com/api-reference/comments/lesson-list.md): A conversa embaixo da aula, com a prévia das respostas.
- [Comentar na aula](https://docs.useweve.com/api-reference/comments/lesson-create.md): Comentário novo ou resposta, com menção e imagem.
- [Respostas de um comentário](https://docs.useweve.com/api-reference/comments/replies.md): A conversa completa de uma raiz, paginada.
- [Editar o próprio comentário](https://docs.useweve.com/api-reference/comments/update.md): Só de quem escreveu; o comentário passa a mostrar que foi editado.
- [Remover o próprio comentário](https://docs.useweve.com/api-reference/comments/delete.md): Redige o corpo e mantém a conversa de pé.
- [Reagir](https://docs.useweve.com/api-reference/comments/reaction-add.md): Idempotente; a mesma pessoa pode reagir com emojis diferentes.
- [Desfazer reação](https://docs.useweve.com/api-reference/comments/reaction-remove.md): Tira uma reação sua.
- [Enviar imagem de comentário](https://docs.useweve.com/api-reference/comments/image-create.md): Reserva o envio direto e assinado da imagem.
- [Confirmar a imagem](https://docs.useweve.com/api-reference/comments/image-complete.md): Quem confirma é o bucket: tamanho, tipo e impressão digital.
- [Caixa de entrada](https://docs.useweve.com/api-reference/comments/notifications-list.md): O sino, para as duas identidades.
- [Marcar avisos como lidos](https://docs.useweve.com/api-reference/comments/notifications-read.md): Sem ids, marca tudo — e cala o e-mail do que já foi visto.
- [Caixa de comentários do club](https://docs.useweve.com/api-reference/comments/managed-list.md): Tudo que foi escrito, com a fila do que espera resposta e o que a equipe salvou.
- [Responder como instrutora](https://docs.useweve.com/api-reference/comments/managed-create.md): O comentário sai com o selo de quem administra.
- [Responder com o assistente](https://docs.useweve.com/api-reference/comments/managed-assistant-reply.md): O assistente escreve a resposta embaixo da aula — com o material do curso, ou nada.
- [Histórico de edição](https://docs.useweve.com/api-reference/comments/managed-revisions.md): O que o comentário dizia antes de cada edição.
- [Ocultar, fixar ou salvar](https://docs.useweve.com/api-reference/comments/managed-update.md): Fixar é para a turma, salvar é para a equipe; reescrever o texto de outra pessoa, nunca.
- [Remover um comentário](https://docs.useweve.com/api-reference/comments/managed-delete.md): Redige o corpo e apaga a imagem anexada.
- [Listar conversas](https://docs.useweve.com/api-reference/comments/threads-list.md): O Inbox: uma linha por conversa, com o estado que a caixa filtra — aberta, não lida, em moderação, salva ou resolvida.
- [Abrir uma conversa](https://docs.useweve.com/api-reference/comments/threads-get.md): A raiz e todas as respostas, com o que está oculto, retido e marcado como spam. Aceita o id de uma resposta.
- [Marcar como lida ou resolvida](https://docs.useweve.com/api-reference/comments/threads-update.md): A leitura é da equipe inteira, e a conversa resolvida reabre sozinha quando o aluno escreve de novo.
- [Aprovar ou rejeitar](https://docs.useweve.com/api-reference/comments/threads-moderate.md): Com a moderação do club ligada, o comentário de aluno nasce retido até alguém da equipe decidir.
- [Comunidade do aluno](https://docs.useweve.com/api-reference/community/classroom-get.md): Os espaços que a pessoa enxerga, com a vitrine dos privados.
- [Feed](https://docs.useweve.com/api-reference/community/feed.md): Os posts dos espaços ao alcance, por atividade ou por data.
- [Quem participa do espaço](https://docs.useweve.com/api-reference/community/space-members.md): Os alunos que alcançam o espaço e não saíram dele.
- [Voltar a participar do espaço](https://docs.useweve.com/api-reference/community/space-join.md): Participar é a escolha de quem já tem acesso.
- [Sair do espaço](https://docs.useweve.com/api-reference/community/space-leave.md): Some do feed de todos os posts; abrir direto continua funcionando.
- [Preferências do grupo](https://docs.useweve.com/api-reference/community/space-preferences.md): Silenciar o grupo ou pedir o resumo semanal por e-mail.
- [Marcar o grupo como lido](https://docs.useweve.com/api-reference/community/space-read.md): Apaga o ponto de novidade. A tela chama ao abrir o grupo.
- [Perfil de um membro](https://docs.useweve.com/api-reference/community/member-get.md): Quem a pessoa é para a turma, com o que ela somou na comunidade.
- [Denunciar um post](https://docs.useweve.com/api-reference/community/post-report.md): A queixa chega à moderação do club; o post não sai do ar por ela.
- [Publicar](https://docs.useweve.com/api-reference/community/post-create.md): Markdown cru; no espaço de avisos só a equipe publica.
- [Ler um post](https://docs.useweve.com/api-reference/community/post-get.md): O mesmo resolvedor do feed decide se o post existe para quem pergunta.
- [Editar o próprio post](https://docs.useweve.com/api-reference/community/post-update.md): Nas primeiras 24 horas, com a versão anterior no histórico.
- [Remover o próprio post](https://docs.useweve.com/api-reference/community/post-delete.md): Redige; o post fica enquanto tiver conversa viva.
- [Baixa um arquivo do post, carimbado](https://docs.useweve.com/api-reference/community/post-file.md): A rota da aula (`/classroom/lessons/{publicId}/files/{mediaId}`), com o post no lugar dela: o PDF anexado a um post sai com o nome e o documento de quem baixou quando o club tem a marca ligada.
- [Reagir ao post](https://docs.useweve.com/api-reference/community/post-reaction-add.md): Idempotente, com a lista fechada das reações.
- [Desfazer reação ao post](https://docs.useweve.com/api-reference/community/post-reaction-remove.md): Permitido mesmo silenciado.
- [Conversa do post](https://docs.useweve.com/api-reference/community/post-comments-list.md): A mesma forma da conversa da aula.
- [Comentar no post](https://docs.useweve.com/api-reference/community/post-comments-create.md): Post trancado ou removido não recebe conversa.
- [Reservar imagem de post](https://docs.useweve.com/api-reference/community/image-create.md): Envio direto ao armazenamento, anexável só por quem enviou.
- [Confirmar imagem de post](https://docs.useweve.com/api-reference/community/image-complete.md): Quem confirma é o bucket.
- [Comunidade do club](https://docs.useweve.com/api-reference/community/managed-get.md): A casa inteira, com os espaços arquivados no fim.
- [Criar a comunidade](https://docs.useweve.com/api-reference/community/managed-create.md): Uma por club; nasce sem publicar.
- [Editar ou publicar a comunidade](https://docs.useweve.com/api-reference/community/managed-update.md): Nulo em published_at despublica.
- [Criar espaço](https://docs.useweve.com/api-reference/community/spaces-create.md): Privado é um entregável próprio.
- [Editar ou arquivar espaço](https://docs.useweve.com/api-reference/community/spaces-update.md): Arquivar tira do classroom e mantém os posts.
- [Reordenar espaços](https://docs.useweve.com/api-reference/community/spaces-order.md): Os ativos na ordem final, numa chamada.
- [Posts para moderar](https://docs.useweve.com/api-reference/community/managed-posts-list.md): Todos os espaços, com os ocultos e a busca por trecho.
- [Publicar como a equipe](https://docs.useweve.com/api-reference/community/managed-post-create.md): Com o selo, em qualquer espaço — inclusive o de avisos.
- [Um post, para moderar](https://docs.useweve.com/api-reference/community/managed-post-get.md): Com o que está oculto e em espaço arquivado.
- [Moderar um post](https://docs.useweve.com/api-reference/community/managed-post-update.md): Fixar, trancar, ocultar e mover de espaço.
- [Remover um post](https://docs.useweve.com/api-reference/community/managed-post-delete.md): Redige título e corpo e mantém a linha.
- [Histórico do post](https://docs.useweve.com/api-reference/community/managed-post-revisions.md): As versões anteriores, da mais nova para a mais antiga.
- [Conversa do post, para moderar](https://docs.useweve.com/api-reference/community/managed-post-comments-list.md): Com os comentários ocultos.
- [Comentar como a equipe](https://docs.useweve.com/api-reference/community/managed-post-comments-create.md): Vale também em post trancado.
- [Listar mentorias](https://docs.useweve.com/api-reference/mentorships/list.md): Todas para quem administra; as que atende, para quem só mentora.
- [Criar mentoria](https://docs.useweve.com/api-reference/mentorships/create.md): A mentoria é um entregável, e a cota é a que cada matrícula traz.
- [Ler mentoria](https://docs.useweve.com/api-reference/mentorships/get.md): Com as etapas do quadro e as entregas que a abrem.
- [Editar mentoria](https://docs.useweve.com/api-reference/mentorships/update.md): Publicar, arquivar e mudar a cota — que vale para o saldo de todos a partir de agora.
- [Definir quem atende](https://docs.useweve.com/api-reference/mentorships/mentors-set.md): A lista inteira; quem sai solta a designação dos mentorados.
- [Definir etapas](https://docs.useweve.com/api-reference/mentorships/stages-set.md): As etapas ativas na ordem final; a que sai é arquivada, nunca apagada.
- [Cota da entrega](https://docs.useweve.com/api-reference/mentorships/quota-set.md): A cota que cada matrícula desta entrega traz, no lugar da cota da mentoria.
- [Remover cota da entrega](https://docs.useweve.com/api-reference/mentorships/quota-delete.md): A entrega volta a dar a cota da mentoria.
- [Quadro de mentorados](https://docs.useweve.com/api-reference/mentorships/participants-list.md): Quem tem direito agora e quem já passou pela mentoria, sem ninguém precisar entrar.
- [Prontuário](https://docs.useweve.com/api-reference/mentorships/participant-get.md): O acesso, o crédito por fonte, o que está em aberto e a próxima sessão.
- [Designar mentor ou mover de etapa](https://docs.useweve.com/api-reference/mentorships/participant-update.md): A designação avisa quem foi designado; a etapa fica no histórico.
- [Histórico de etapas](https://docs.useweve.com/api-reference/mentorships/stage-events.md): Quem moveu quem, de onde para onde.
- [Conceder sessões avulsas](https://docs.useweve.com/api-reference/mentorships/credit-grant-create.md): Gastas depois das matrículas, e só por quem tem acesso.
- [Revogar concessão](https://docs.useweve.com/api-reference/mentorships/credit-grant-revoke.md): O que não foi usado deixa de valer; o usado continua contado.
- [Anotações da equipe](https://docs.useweve.com/api-reference/mentorships/notes-list.md): Da equipe, sempre: o aluno lê o resumo da sessão, não isto.
- [Anotar](https://docs.useweve.com/api-reference/mentorships/notes-create.md): Ligada, se quiser, a uma sessão de que a pessoa participou.
- [Editar anotação](https://docs.useweve.com/api-reference/mentorships/note-update.md): Só quem escreveu.
- [Apagar anotação](https://docs.useweve.com/api-reference/mentorships/note-delete.md): Quem escreveu, ou quem administra.
- [Plano do mentorado](https://docs.useweve.com/api-reference/mentorships/plan-get.md): As metas com as tarefas de cada uma, e as tarefas soltas.
- [Criar meta ou aplicar playbook](https://docs.useweve.com/api-reference/mentorships/goal-create.md): Aplicar um playbook copia as tarefas dele para a meta.
- [Reordenar metas](https://docs.useweve.com/api-reference/mentorships/goal-order.md): Todas as metas, na ordem final.
- [Editar meta](https://docs.useweve.com/api-reference/mentorships/goal-update.md): O status é decisão de quem mentora.
- [Remover meta](https://docs.useweve.com/api-reference/mentorships/goal-delete.md): As tarefas dela ficam, soltas.
- [Criar tarefa](https://docs.useweve.com/api-reference/mentorships/task-create.md): No fim da meta, ou das soltas; o aluno recebe aviso.
- [Reordenar tarefas](https://docs.useweve.com/api-reference/mentorships/task-order.md): As tarefas de uma meta, ou as soltas, na ordem final.
- [Editar tarefa](https://docs.useweve.com/api-reference/mentorships/task-update.md): Mudar de meta põe a tarefa no fim da meta nova.
- [Remover tarefa](https://docs.useweve.com/api-reference/mentorships/task-delete.md)
- [Recomendações](https://docs.useweve.com/api-reference/mentorships/recommendations-list.md): Com o que a pessoa já fez e se ela tem o curso.
- [Recomendar conteúdo](https://docs.useweve.com/api-reference/mentorships/recommendation-create.md): Um curso ou uma aula; recomendar não abre nada.
- [Remover recomendação](https://docs.useweve.com/api-reference/mentorships/recommendation-delete.md)
- [Arquivos do mentorado](https://docs.useweve.com/api-reference/mentorships/participant-files-list.md): Assinados na hora da resposta.
- [Definir arquivos do mentorado](https://docs.useweve.com/api-reference/mentorships/participant-files-set.md): Biblioteca é apontada; arquivo enviado para a mentoria tem um dono só.
- [Sessões do mentorado](https://docs.useweve.com/api-reference/mentorships/participant-sessions.md): A agenda e o histórico de uma pessoa.
- [Agenda de sessões](https://docs.useweve.com/api-reference/mentorships/sessions-list.md): As sessões do club numa faixa; quem só mentora vê as que conduz.
- [Abrir ou marcar sessão](https://docs.useweve.com/api-reference/mentorships/session-create.md): A sessão em grupo, ou a individual em nome de um aluno.
- [Ler sessão](https://docs.useweve.com/api-reference/mentorships/session-get.md): Com quem participa e os arquivos.
- [Remarcar, resumir ou cancelar](https://docs.useweve.com/api-reference/mentorships/session-update.md): A remarcação passa pela agenda de quem conduz e de cada aluno.
- [Arquivos da sessão](https://docs.useweve.com/api-reference/mentorships/session-files-set.md): A gravação e o material, para quem participou.
- [Inscrever aluno](https://docs.useweve.com/api-reference/mentorships/attendee-add.md): Na sessão em grupo, com as regras da inscrição do próprio aluno.
- [Marcar falta ou desinscrever](https://docs.useweve.com/api-reference/mentorships/attendee-update.md): A falta consome o crédito; desinscrever pela equipe, não.
- [Avaliações](https://docs.useweve.com/api-reference/mentorships/ratings-list.md): As avaliações das sessões e a média de cada critério.
- [Listar playbooks](https://docs.useweve.com/api-reference/mentorships/playbooks-list.md): Os modelos de meta do club.
- [Criar playbook](https://docs.useweve.com/api-reference/mentorships/playbook-create.md): O nome e as tarefas, com prazo relativo.
- [Ler playbook](https://docs.useweve.com/api-reference/mentorships/playbook-get.md)
- [Editar playbook](https://docs.useweve.com/api-reference/mentorships/playbook-update.md): As metas que já saíram dele não mudam.
- [Tarefas do playbook](https://docs.useweve.com/api-reference/mentorships/playbook-tasks-set.md): A lista inteira, na ordem.
- [Quem mentora](https://docs.useweve.com/api-reference/mentorships/mentors-list.md): Com as mentorias que cada pessoa atende.
- [Tornar mentor ou editar perfil](https://docs.useweve.com/api-reference/mentorships/mentor-upsert.md): Mentorar é uma linha, não um papel.
- [Tirar de mentor](https://docs.useweve.com/api-reference/mentorships/mentor-delete.md): Recusado com sessão por vir conduzida pela pessoa.
- [Agenda do mentor](https://docs.useweve.com/api-reference/mentorships/availability-get.md): A semana na hora local e as exceções por vir.
- [Semana do mentor](https://docs.useweve.com/api-reference/mentorships/availability-rules-set.md): Janelas na hora local do fuso do perfil.
- [Bloquear ou abrir horário](https://docs.useweve.com/api-reference/mentorships/availability-exception-create.md): Férias, um compromisso, o sábado de plantão.
- [Remover exceção](https://docs.useweve.com/api-reference/mentorships/availability-exception-delete.md)
- [Horários livres do mentor](https://docs.useweve.com/api-reference/mentorships/mentor-slots.md): Os horários que o aluno veria, sem a antecedência mínima.
- [Enviar arquivo da mentoria](https://docs.useweve.com/api-reference/mentorships/file-create.md): Privado, fora da biblioteca, apagado com o dono.
- [Confirmar arquivo](https://docs.useweve.com/api-reference/mentorships/file-complete.md): Quem confirma é o armazenamento.
- [Mentorias do aluno](https://docs.useweve.com/api-reference/mentorships/classroom-list.md): As que ele tem, as em vitrine e as de que tem histórico.
- [Mentoria do aluno](https://docs.useweve.com/api-reference/mentorships/classroom-get.md): O saldo, o mentor, a próxima sessão e o que falta fazer.
- [Horários livres](https://docs.useweve.com/api-reference/mentorships/classroom-slots.md): Calculados na hora a partir da semana de cada mentor.
- [Reservar](https://docs.useweve.com/api-reference/mentorships/classroom-booking-create.md): Um horário da agenda, ou uma vaga numa sessão em grupo.
- [Minhas sessões](https://docs.useweve.com/api-reference/mentorships/classroom-sessions-list.md): A agenda e o histórico do aluno.
- [Sessões em grupo](https://docs.useweve.com/api-reference/mentorships/classroom-group-sessions.md): As futuras, com a vaga contada na hora.
- [Sessão do aluno](https://docs.useweve.com/api-reference/mentorships/classroom-session-get.md): Com o resumo e os arquivos.
- [Escrever a pauta](https://docs.useweve.com/api-reference/mentorships/classroom-session-update.md): Até a sessão começar.
- [Desmarcar](https://docs.useweve.com/api-reference/mentorships/classroom-session-cancel.md): Dentro do prazo de aviso, o crédito continua consumido.
- [Avaliar sessão](https://docs.useweve.com/api-reference/mentorships/classroom-session-rate.md): Uma vez, depois do fim, por quem esteve lá.
- [Metas e tarefas do aluno](https://docs.useweve.com/api-reference/mentorships/classroom-plan.md): A mesma lista que quem mentora lê.
- [Concluir tarefa](https://docs.useweve.com/api-reference/mentorships/classroom-task-update.md): Com um comentário opcional para quem mentora.
- [Conteúdo recomendado](https://docs.useweve.com/api-reference/mentorships/classroom-recommendations.md): Só o que está no ar.
- [Arquivos do aluno](https://docs.useweve.com/api-reference/mentorships/classroom-files-list.md): Os que a equipe deixou para a pessoa.
- [Baixar arquivo](https://docs.useweve.com/api-reference/mentorships/classroom-file-download.md): Carimbado, quando o club tem a marca d'água ligada.
- [Entrar na sala do encontro (equipe)](https://docs.useweve.com/api-reference/mentorships/session-join.md): A credencial de quem conduz o encontro na sala.
- [Entrar na sala do encontro](https://docs.useweve.com/api-reference/mentorships/classroom-session-join.md): A credencial do aluno inscrito no encontro.
- [Listar agentes](https://docs.useweve.com/api-reference/agents/list.md): Os agentes do club, do mais novo ao mais velho.
- [Criar agente](https://docs.useweve.com/api-reference/agents/create.md): Nasce rascunho, e o id é o do entregável.
- [Agente](https://docs.useweve.com/api-reference/agents/get.md): Um agente, com a imagem e a contagem de material.
- [Editar agente](https://docs.useweve.com/api-reference/agents/update.md): Instruções, teto, publicação e arquivamento.
- [Material do agente](https://docs.useweve.com/api-reference/agents/knowledge-get.md): Cada escolha com o estado da leitura.
- [Definir o material](https://docs.useweve.com/api-reference/agents/knowledge-set.md): A lista inteira, na ordem; cada item é um arquivo ou um curso.
- [Origens do material](https://docs.useweve.com/api-reference/agents/knowledge-sources.md): O que a lista de material resume: uma linha por arquivo e por aula.
- [Ler de novo uma origem](https://docs.useweve.com/api-reference/agents/knowledge-sources-reindex.md): Devolve à fila a origem que falhou.
- [Testar a busca no material](https://docs.useweve.com/api-reference/agents/knowledge-search.md): O que o agente encontraria para uma pergunta, sem chamar o modelo.
- [Conversas dos alunos](https://docs.useweve.com/api-reference/agents/conversations-list.md): As conversas com o agente, de todos ou de um aluno.
- [Conversa de um aluno](https://docs.useweve.com/api-reference/agents/conversations-get.md): As mensagens, com as citações do material.
- [Uso de IA do club](https://docs.useweve.com/api-reference/agents/ai-usage.md): O orçamento do mês e o gasto por finalidade e por agente.
- [Ver o assistente do curso](https://docs.useweve.com/api-reference/agents/course-assistant-get.md): Quem responde no Perguntar das aulas e nos comentários de um curso.
- [Configurar o assistente do curso](https://docs.useweve.com/api-reference/agents/course-assistant-set.md): Liga, desliga e dá nome e tom de voz ao assistente das aulas.
- [Copiloto das aulas do curso](https://docs.useweve.com/api-reference/agents/course-copilot-list.md): A prévia da equipe: o resumo e as tarefas de cada aula publicada.
- [Ocultar o Copiloto de uma aula](https://docs.useweve.com/api-reference/agents/course-copilot-update.md): Tira ou devolve o Copiloto de uma aula à vista do aluno.
- [Refazer o Copiloto de uma aula](https://docs.useweve.com/api-reference/agents/course-copilot-regenerate.md): Gera de novo o resumo e as tarefas de uma aula.
- [Agentes do aluno](https://docs.useweve.com/api-reference/agents/classroom-list.md): Os que ele usa, os em vitrine e os de que tem histórico.
- [Agente do aluno](https://docs.useweve.com/api-reference/agents/classroom-get.md): Com o teto de perguntas de agora.
- [Perguntar ao agente](https://docs.useweve.com/api-reference/agents/classroom-message-send.md): A resposta chega em streaming, e não depende da conexão.
- [Conversas do aluno](https://docs.useweve.com/api-reference/agents/classroom-conversations-list.md): As conversas do aluno com um agente.
- [Conversa do aluno](https://docs.useweve.com/api-reference/agents/classroom-conversations-get.md): As últimas mensagens de uma conversa.
- [Renomear conversa](https://docs.useweve.com/api-reference/agents/classroom-conversations-rename.md): Troca o título tirado da primeira pergunta.
- [Apagar conversa](https://docs.useweve.com/api-reference/agents/classroom-conversations-delete.md): A conversa sai; o que ela custou, não.
- [Enviar imagem da pergunta](https://docs.useweve.com/api-reference/agents/classroom-image-create.md): Reserva o envio direto ao armazenamento.
- [Confirmar imagem da pergunta](https://docs.useweve.com/api-reference/agents/classroom-image-complete.md): O bucket confere tipo e tamanho.
- [Listar canais](https://docs.useweve.com/api-reference/lives/live-channels-list.md): Os canais de live do club.
- [Criar canal](https://docs.useweve.com/api-reference/lives/live-channels-create.md): O entregável das lives: vale para toda live marcada nele.
- [Um canal](https://docs.useweve.com/api-reference/lives/live-channels-get.md): Um canal de lives.
- [Editar canal](https://docs.useweve.com/api-reference/lives/live-channels-update.md): Edita, publica ou arquiva um canal.
- [Agenda de lives](https://docs.useweve.com/api-reference/lives/list.md): As lives do club pela hora de começo.
- [Marcar live](https://docs.useweve.com/api-reference/lives/create.md): Marca uma live num canal.
- [Uma live](https://docs.useweve.com/api-reference/lives/get.md): A live, com o palco e as gravações.
- [Editar live](https://docs.useweve.com/api-reference/lives/update.md): Edita, remarca, publica ou cancela.
- [Quem apresenta](https://docs.useweve.com/api-reference/lives/hosts.md): Define quem apresenta a live.
- [Entrar para apresentar](https://docs.useweve.com/api-reference/lives/join.md): A credencial do bastidor e da sala.
- [Começar a transmissão](https://docs.useweve.com/api-reference/lives/start.md): Coloca a live no ar.
- [Encerrar a live](https://docs.useweve.com/api-reference/lives/end.md): Fecha a sala e termina a gravação.
- [Gravação](https://docs.useweve.com/api-reference/lives/recording.md): Liga ou desliga a gravação durante a transmissão.
- [Chamar ao palco](https://docs.useweve.com/api-reference/lives/speakers-add.md): Dá câmera e microfone a um aluno.
- [Tirar do palco](https://docs.useweve.com/api-reference/lives/speakers-remove.md): Tira a câmera e o microfone de um aluno.
- [Chat da live (equipe)](https://docs.useweve.com/api-reference/lives/messages-list.md): As mensagens, com as ocultas e quem escreveu.
- [Escrever como quem apresenta](https://docs.useweve.com/api-reference/lives/messages-create.md): Uma mensagem no chat, com o selo da equipe.
- [Ocultar mensagem](https://docs.useweve.com/api-reference/lives/messages-update.md): Oculta ou mostra uma mensagem do chat.
- [Quem assistiu](https://docs.useweve.com/api-reference/lives/attendance.md): A presença por aluno.
- [Lives do aluno](https://docs.useweve.com/api-reference/lives/classroom-list.md): O que vai acontecer e o que já aconteceu.
- [Uma live do aluno](https://docs.useweve.com/api-reference/lives/classroom-get.md): O estado, o horário e o replay.
- [Entrar na live](https://docs.useweve.com/api-reference/lives/classroom-join.md): Como assistir: a sala, o embed ou o link.
- [Chat da live](https://docs.useweve.com/api-reference/lives/classroom-messages-list.md): As mensagens para quem chega no meio.
- [Escrever no chat](https://docs.useweve.com/api-reference/lives/classroom-messages-create.md): Uma mensagem do aluno no chat.
- [Levantar a mão](https://docs.useweve.com/api-reference/lives/classroom-hand.md): Pede o palco a quem apresenta.
- [Lembrete da live](https://docs.useweve.com/api-reference/lives/classroom-reminder.md): Liga ou desliga, para uma live só, os avisos por e-mail que o aluno recebe.
- [Aviso da sala](https://docs.useweve.com/api-reference/lives/webhook.md): O que a sala de vídeo avisa à API.
- [Listar alunos](https://docs.useweve.com/api-reference/students/list.md): Nome e e-mail; exige administrar o club.
- [Convidar aluno](https://docs.useweve.com/api-reference/students/invite.md): Cria a conta sem senha, abre as entregas e manda o link de acesso.
- [Ler aluno](https://docs.useweve.com/api-reference/students/get.md): Matrículas e o histórico de acesso.
- [Cursos de um aluno](https://docs.useweve.com/api-reference/students/courses.md): O que ele estuda, quanto concluiu e onde parou.
- [Linha do tempo de um aluno](https://docs.useweve.com/api-reference/students/activity.md): Compra, acesso, aula, comentário, certificado, live e mentoria numa lista só.
- [Quizzes de um aluno](https://docs.useweve.com/api-reference/students/quizzes.md): Cada quiz que a pessoa tentou, com a melhor nota, a última e se já passou.
- [Mentorias de um aluno](https://docs.useweve.com/api-reference/students/mentorships.md): As mentorias em que a pessoa está, com etapa, sessões e metas abertas.
- [Conversas de um aluno com os agentes](https://docs.useweve.com/api-reference/students/agent-conversations.md): As conversas da pessoa com todos os agentes do club.
- [E-mails de um aluno](https://docs.useweve.com/api-reference/students/emails.md): Cada e-mail de campanha, automação ou aviso de live mandado para a pessoa, com o que aconteceu com ele.
- [Automações de um aluno](https://docs.useweve.com/api-reference/students/automations.md): Cada passagem da pessoa por uma automação: onde está ou como terminou.
- [Dias de estudo de um aluno](https://docs.useweve.com/api-reference/students/study-days.md): Quantas aulas a pessoa tocou em cada dia das últimas semanas.
- [Tags de aluno](https://docs.useweve.com/api-reference/students/tags-list.md): Todas as tags do club, com quantos alunos cada uma marca.
- [Criar tag](https://docs.useweve.com/api-reference/students/tags-create.md): Uma tag nova; o nome é único no club sem diferença de maiúscula.
- [Renomear tag](https://docs.useweve.com/api-reference/students/tags-update.md): Muda o nome da tag sem mexer em quem está marcado nem nas automações.
- [Apagar tag](https://docs.useweve.com/api-reference/students/tags-delete.md): Tira a tag de todos os alunos; recusa a tag usada por automação publicada.
- [Marcar aluno com tag](https://docs.useweve.com/api-reference/students/tag-add.md): Idempotente; a primeira marcação dispara as automações e os webhooks de tag.
- [Tirar tag do aluno](https://docs.useweve.com/api-reference/students/tag-remove.md): Idempotente; tirar de quem estava marcado dispara as automações e os webhooks de tag.
- [Corrigir aluno](https://docs.useweve.com/api-reference/students/update.md): Nome e e-mail. Trocar o e-mail desconfirma a conta e manda o link para a caixa nova.
- [Remover aluno](https://docs.useweve.com/api-reference/students/anonymize.md): Anonimiza a conta, derruba as sessões e revoga as matrículas. Não há volta.
- [Conceder entrega](https://docs.useweve.com/api-reference/students/grant.md): Dá acesso a um aluno, com prazo opcional.
- [Revogar matrícula](https://docs.useweve.com/api-reference/students/revoke.md): Idempotente; o motivo vai para o ledger.
- [Estender matrícula](https://docs.useweve.com/api-reference/students/extend.md): Novo prazo, ou vitalício; restaura uma revogada.
- [Estender um grupo](https://docs.useweve.com/api-reference/students/extend-many.md): Nova data de fim para as matrículas escolhidas. Só alonga.
- [Mudar de turma](https://docs.useweve.com/api-reference/students/move.md): Passa a matrícula para outra turma da mesma entrega, ou para nenhuma. O bônus segue.
- [Conceder em lote](https://docs.useweve.com/api-reference/students/grant-many.md): Dá uma entrega a um grupo de alunos, na turma que estiver matriculando ou na escolhida.
- [Importar alunos](https://docs.useweve.com/api-reference/students/import.md): Cria as contas que faltam, manda o link de acesso e abre as entregas.
- [Reenviar o link de acesso](https://docs.useweve.com/api-reference/students/access-link.md): Manda de novo o e-mail de 'defina a sua senha'.
- [Entrar como um aluno](https://docs.useweve.com/api-reference/students/classroom-session.md): Abre o classroom com a sessão de um aluno do club — a turma, a agenda e o progresso que ele vê.
- [Revogar um grupo](https://docs.useweve.com/api-reference/students/revoke-many.md): Revoga as matrículas escolhidas, com motivo no ledger.
- [Quem perde acesso em breve](https://docs.useweve.com/api-reference/students/expiring.md): As matrículas que vencem nos próximos dias, com aluno, entrega e turma.
- [Links de cadastro](https://docs.useweve.com/api-reference/registration-links/list.md): Os links do club, ligados e desligados.
- [Criar link de cadastro](https://docs.useweve.com/api-reference/registration-links/create.md): Um endereço público que cria a conta e abre as entregas configuradas.
- [Alterar link de cadastro](https://docs.useweve.com/api-reference/registration-links/update.md): Nome, entregas e ligado/desligado.
- [Trocar o código](https://docs.useweve.com/api-reference/registration-links/rotate.md): O código antigo deixa de valer na hora.
- [Apagar um link](https://docs.useweve.com/api-reference/registration-links/delete.md): Quem já entrou por ele continua com a conta e as matrículas.
- [Campanhas](https://docs.useweve.com/api-reference/campaigns/list.md): Mais recente primeiro, com o resumo do envio de cada uma.
- [Criar campanha](https://docs.useweve.com/api-reference/campaigns/create.md): Nasce em rascunho; só o nome é obrigatório, e o conteúdo completo só é exigido ao agendar.
- [Campanha](https://docs.useweve.com/api-reference/campaigns/get.md): O conteúdo, a audiência e os números do envio.
- [Alterar campanha](https://docs.useweve.com/api-reference/campaigns/update.md): Só em rascunho: a campanha que começou a sair não muda nunca.
- [Apagar campanha](https://docs.useweve.com/api-reference/campaigns/delete.md): Só a que não chegou a sair para ninguém; a que saiu é histórico.
- [Audiência](https://docs.useweve.com/api-reference/campaigns/audience.md): Quantos receberiam a campanha agora, pela mesma regra que congela a lista.
- [Pré-visualizar campanha](https://docs.useweve.com/api-reference/campaigns/preview.md): O conteúdo salvo, renderizado pelo mesmo código do envio.
- [Enviar teste](https://docs.useweve.com/api-reference/campaigns/test.md): Sempre para o e-mail da sessão, com [Teste] no assunto e fora das métricas.
- [Agendar campanha](https://docs.useweve.com/api-reference/campaigns/schedule.md): Confere o conteúdo inteiro; no horário a lista congela e o envio segue em lotes.
- [Desagendar campanha](https://docs.useweve.com/api-reference/campaigns/unschedule.md): Volta a agendada para rascunho, enquanto o horário não chegou.
- [Pausar campanha](https://docs.useweve.com/api-reference/campaigns/pause.md): Vale no lote seguinte: o que já está com o provedor termina.
- [Retomar campanha](https://docs.useweve.com/api-reference/campaigns/resume.md): Continua a mesma lista, sem reavaliar a audiência.
- [Cancelar campanha](https://docs.useweve.com/api-reference/campaigns/cancel.md): O que não saiu fica cancelado; não se desfaz.
- [Envios da campanha](https://docs.useweve.com/api-reference/campaigns/deliveries.md): Uma linha por destinatário da lista congelada, com o que aconteceu com cada e-mail.
- [Automações](https://docs.useweve.com/api-reference/workflows/list.md): As automações do club, em qualquer estado.
- [Criar automação](https://docs.useweve.com/api-reference/workflows/create.md): Nasce em rascunho, conferido só na estrutura; nada dispara antes de publicar.
- [Automação](https://docs.useweve.com/api-reference/workflows/get.md): O rascunho e a versão publicada, lado a lado.
- [Alterar automação](https://docs.useweve.com/api-reference/workflows/update.md): Mudar o rascunho não muda o que está rodando.
- [Apagar automação](https://docs.useweve.com/api-reference/workflows/delete.md): Só a nunca publicada; a publicada se arquiva.
- [Publicar automação](https://docs.useweve.com/api-reference/workflows/publish.md): Confere o rascunho inteiro e grava uma versão imutável para as execuções novas.
- [Pausar automação](https://docs.useweve.com/api-reference/workflows/pause.md): Para de abrir execuções, e as que estão em curso esperam.
- [Retomar automação](https://docs.useweve.com/api-reference/workflows/resume.md): As execuções continuam de onde pararam; os fatos da pausa não abrem execução.
- [Arquivar automação](https://docs.useweve.com/api-reference/workflows/archive.md): Encerra as execuções em curso e guarda a trilha e os números; não se desfaz.
- [Versões](https://docs.useweve.com/api-reference/workflows/versions.md): As versões publicadas, mais recente primeiro.
- [Números da automação](https://docs.useweve.com/api-reference/workflows/stats.md): Execuções por estado e por passo, somando todas as versões pelo id do passo.
- [Execuções](https://docs.useweve.com/api-reference/workflows/runs-list.md): Quem passou pela automação, e em que estado está.
- [Execução](https://docs.useweve.com/api-reference/workflows/runs-get.md): Uma execução, com a trilha passo a passo.
- [Encerrar execução](https://docs.useweve.com/api-reference/workflows/runs-cancel.md): Para onde está; um e-mail que já entrou na fila ainda sai.
- [Pré-visualizar e-mail do passo](https://docs.useweve.com/api-reference/workflows/email-preview.md): Do rascunho ou da versão publicada, com as variáveis do gatilho preenchidas por exemplos.
- [Enviar teste do passo](https://docs.useweve.com/api-reference/workflows/email-test.md): Como o teste da campanha: para o e-mail da sessão e fora das métricas.
- [Estado da inscrição](https://docs.useweve.com/api-reference/email/subscription.md): O que a tela de descadastro do classroom lê, pelo token do link, sem sessão.
- [Descadastrar](https://docs.useweve.com/api-reference/email/unsubscribe.md): O link do rodapé e o botão de um clique do Gmail e do Yahoo chegam aqui.
- [Voltar a receber](https://docs.useweve.com/api-reference/email/resubscribe.md): Desfaz só o descadastro da própria pessoa; reclamação e bounce continuam.
- [Aviso do provedor de e-mail](https://docs.useweve.com/api-reference/email/webhook.md): O webhook do Resend: entrega, bounce, reclamação, abertura e clique.
- [Listar as conversas com o suporte](https://docs.useweve.com/api-reference/support/list.md): As conversas do clube com a equipe da weve, e quantas têm resposta por ler.
- [Abrir uma conversa com o suporte](https://docs.useweve.com/api-reference/support/create.md): Abre um chamado com a primeira mensagem.
- [Ver uma conversa com o suporte](https://docs.useweve.com/api-reference/support/get.md): A conversa e as mensagens, da primeira à última.
- [Responder numa conversa com o suporte](https://docs.useweve.com/api-reference/support/reply.md): Escreve na conversa; escrever numa resolvida a reabre.
- [Marcar a conversa como lida](https://docs.useweve.com/api-reference/support/read.md): Registra que quem está na sessão leu a conversa.
- [Índice da central de ajuda](https://docs.useweve.com/api-reference/help/index.md): As coleções e os artigos publicados, na ordem da central.
- [Buscar na central de ajuda](https://docs.useweve.com/api-reference/help/search.md): Busca por palavra nos artigos publicados, sem acento e pelo começo da palavra.
- [Ler um artigo da central](https://docs.useweve.com/api-reference/help/article.md): O texto publicado de um artigo, em Markdown.

## OpenAPI Specs

- [openapi](/api-reference/openapi.yaml)