Confirmar a leitura de um post ("Li e estou ciente")
POST/api/content/{id}/acknowledgement
- Auth
- Requiere token
- Clave de API:
- content:write
- X-CommunityId
X-CommunityIdEnvía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.
Quem tem acesso ao post (as mesmas regras de `GET /api/content/{id}`) registra que leu e está ciente. Vale para a versão atual do pedido (`acknowledgement.version` do post): se a equipe pedir nova confirmação, é preciso confirmar de novo. Repetir não cria outra: devolve a confirmação que já existe (200; a primeira é 201). A data fica registrada e a equipe a vê (a faixa do post avisa isso).
Erros: post que não pede confirmação, 409 `postAck.notRequired`; post que não está publicado (rascunho, agendado ou na moderação), 409 `postAck.notLive`; sem acesso, 403; de outra comunidade, 404.
Parámetros
| Nombre | Dónde | Tipo | Descripción |
|---|---|---|---|
idobligatorio | path | string (uuid) |
Headers
| Nombre | Tipo | Descripción |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Cuerpo de la solicitud application/json
La especificación no declara los campos de este cuerpo (una subida multipart, por ejemplo). Consulta la guía del tema.
Respuestas
| Código | Descripción |
|---|---|
201 | Confirmação registrada (200 quando já existia). |
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 | O post não pede confirmação (`notRequired`) ou não está publicado (`notLive`). |
500 | Erro interno do servidor. |
Ejemplo con curl
curl -X POST "https://api.memberfy.net/api/content/<id>/acknowledgement" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'