Confirmar a leitura de um post ("Li e estou ciente")
POST/api/content/{id}/acknowledgement
- Auth
- Richiede un token
- Chiave API:
- content:write
- X-CommunityId
X-CommunityIdInvia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.
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.
Parametri
| Nome | Dove | Tipo | Descrizione |
|---|---|---|---|
idobbligatorio | path | string (uuid) |
Header
| Nome | Tipo | Descrizione |
|---|---|---|
X-CommunityIdfacoltativo | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corpo della richiesta application/json
La specifica non dichiara i campi di questo corpo (un upload multipart, per esempio). Consulta la guida dell’argomento.
Risposte
| Codice | Descrizione |
|---|---|
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. |
Esempio 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 '{}'