> ## Documentation Index > Fetch the complete documentation index at: https://docs.weve.cx/llms.txt > Use this file to discover all available pages before exploring further. # Revogar matrícula > Idempotente; o motivo vai para o ledger. ## OpenAPI ````yaml POST /v1/clubs/{clubId}/enrollments/{enrollmentId}/revoke openapi: 3.0.3 info: title: weve API description: > Contrato entre a API Go e o dashboard. **Este arquivo é a fonte de verdade**: os tipos e a interface de servidor em Go, e o client TypeScript, são todos gerados daqui (`make openapi`). Handler que divergir da interface não compila. A superfície interna (`/internal/*`) fica de fora de propósito: é acesso de máquina, protegido por segredo dedicado, e não é contrato de cliente. version: 0.2.0 servers: - url: https://api.weve.cx description: produção - url: http://localhost:8080 description: desenvolvimento security: [] tags: - name: health - name: session - name: account - name: clubs - name: members - name: webhooks - name: sales-platforms - name: catalog - name: content - name: classroom - name: students - name: auth paths: /v1/clubs/{clubId}/enrollments/{enrollmentId}/revoke: parameters: - $ref: '#/components/parameters/OrgId' - $ref: '#/components/parameters/EnrollmentId' post: tags: - students summary: Revoga uma matrícula description: | Idempotente. O motivo vai para o ledger, com quem revogou. Serve para qualquer origem, inclusive compra — o reembolso feito fora da plataforma é um caso. Exige permissão de administração do club. operationId: revokeEnrollment requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/EnrollmentRevoke' responses: '200': description: Matrícula revogada (ou já estava) content: application/json: schema: $ref: '#/components/schemas/EnrollmentResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '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 EnrollmentId: name: enrollmentId in: path required: true schema: type: string format: uuid schemas: EnrollmentRevoke: type: object properties: reason: type: string maxLength: 500 EnrollmentResponse: type: object required: - data properties: data: $ref: '#/components/schemas/Enrollment' Enrollment: type: object required: - id - delivery_id - delivery_name - source - active - starts_at - created_at properties: id: type: string format: uuid delivery_id: type: string format: uuid delivery_name: type: string source: $ref: '#/components/schemas/EnrollmentSource' active: type: boolean description: Não revogada e dentro do prazo. starts_at: type: string format: date-time expires_at: type: string format: date-time description: Ausente é vitalício. revoked_at: type: string format: date-time revoke_reason: type: string cohort_id: type: string format: uuid description: A turma em que a matrícula entrou, quando entrou em alguma. cohort_name: type: string created_at: type: string format: date-time ErrorEnvelope: type: object description: >- Envelope único de erro da API. O `code` é o contrato com o cliente — a `message` é diagnóstico, e pode mudar. required: - error properties: error: type: object required: - code properties: code: type: string message: type: string EnrollmentSource: type: string enum: - purchase - subscription - manual - invitation - import - open_access - registration_link 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' TooManyRequests: description: Teto por IP atingido headers: Retry-After: schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' InternalError: description: >- Falha inesperada. O corpo nunca traz o erro real — ele fica no log e no rastreamento. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' securitySchemes: userSession: type: http scheme: bearer description: | Token OPACO de sessão de quem administra, emitido por `/v1/auth/admin/sign-in` e verificado contra a nossa tabela — o mesmo desenho do `studentSession`, para a outra identidade. É o esquema de quem ADMINISTRA — o dashboard. O aluno do classroom usa o `studentSession`; uma rota consumida pelos dois declara os dois esquemas, e o middleware aceita qualquer um deles. As duas credenciais são opacas e chegam pelo mesmo cabeçalho: quem as separa é a tabela em que cada uma existe. O dashboard o guarda em cookie httpOnly, que o BFF troca pelo `Authorization` a cada chamada. ```` ## Related topics - [Revogar a turma](/api-reference/catalog/cohorts-revoke.md) - [Revogar um grupo](/api-reference/students/revoke-many.md) - [Estender matrícula](/api-reference/students/extend.md) - [Criar turma](/api-reference/catalog/cohorts-create.md) - [Ler aluno](/api-reference/students/get.md)