Aller au contenu

Fecha o aviso de uma pesquisa no app

POST/api/surveys/{id}/notice/dismiss

Auth
Jeton requis
Clé d’API:
surveys: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.

Qualquer papel da comunidade, para o próprio perfil. Fecha de vez o aviso da pesquisa no app: ela continua em `GET /api/surveys/pending` e no espaço, com `noticeDismissed: true`, mas o aviso não volta. Repetir não muda nada. Rascunho ou apagada é 404; fora do público com o link público desligado, 403. Pesquisa `immediate` aberta, que a pessoa (do público congelado) ainda não respondeu: 422 `noticeRequired`, o aviso só sai respondendo ou quando ela encerra. `optional` e `required` fecham normalmente.

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
200Aviso fechado.
400Requisição inválida — falha de validação.
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.
422Pesquisa `immediate` ainda não respondida.
500Erro interno do servidor.

Exemple curl

curl -X POST "https://api.memberfy.net/api/surveys/<id>/notice/dismiss" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'