Cria uma anotação na aula
POST/api/courses/lesson/{lessonId}/notes
- Auth
- Requires a token
- API key:
- courses:write
- X-CommunityId
X-CommunityIdSend the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.
Nota privada presa ao minuto do vídeo (`positionSeconds`, o segundo atual do player) ou sem minuto (aula sem vídeo: omita ou mande `null`). Texto de 1 a 2.000 caracteres. Exige matrícula e a aula liberada para o aluno (403 sem matrícula, 409 com a aula ainda bloqueada); a equipe de conteúdo passa sem matrícula. Até 500 notas por aula e pessoa (409).
Parameters
| Name | In | Type | Description |
|---|---|---|---|
lessonIdrequired | path | string (uuid) |
Headers
| Name | Type | Description |
|---|---|---|
X-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Request body application/json
| Name | Type | Description |
|---|---|---|
textrequired | string | Texto simples, até 2.000 caracteres (espaços nas pontas são removidos). · min 1, max 2000 |
positionSecondsoptional | integer | Segundo atual do player. Omitido ou `null`: nota sem minuto. · ≥ 0, ≤ 86400 |
Responses
| Status | Description |
|---|---|
201 | A anotação criada. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`). |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
409 | Conflito com o estado atual do recurso. |
500 | Erro interno do servidor. |
curl example
curl -X POST "https://api.memberfy.net/api/courses/lesson/<lessonId>/notes" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"text":"string"}'