Aller au contenu

Confirmar a leitura de um post ("Li e estou ciente")

POST/api/content/{id}/acknowledgement

Auth
Jeton requis
Clé d’API:
content:write
X-CommunityId
X-CommunityId Envoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.

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.

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring (uuid)

En-têtes

NomTypeDescription
X-CommunityIdfacultatifstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Corps de la requête application/json

La spécification ne déclare pas les champs de ce corps (un envoi multipart, par exemple). Consultez le guide du thème.

Réponses

StatutDescription
201Confirmação registrada (200 quando já existia).
401Token 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`).
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
409O post não pede confirmação (`notRequired`) ou não está publicado (`notLive`).
500Erro interno do servidor.

Exemple 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 '{}'