Pular para o conteúdo

Fecha o aviso de uma pesquisa no app

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

Auth
Exige token
Chave de API:
surveys:write
X-CommunityId
X-CommunityId Envie o X-CommunityId da comunidade em que a operação acontece.

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.

Parâmetros

NomeOndeTipoDescrição
idobrigatóriopathstring (uuid)

Headers

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

Corpo da requisição application/json

A especificação não declara os campos deste corpo (upload multipart, por exemplo). Consulte o guia do assunto.

Respostas

CódigoDescrição
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.

Exemplo com 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 '{}'