Fecha o aviso de uma pesquisa no app
POST/api/surveys/{id}/notice/dismiss
- Auth
- Requires a token
- API key:
- surveys:write
- X-CommunityId
X-CommunityIdSend the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.
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.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string (uuid) |
Headers
| Name | Type | Description |
|---|---|---|
X-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Request body application/json
The specification does not declare the fields of this body (a multipart upload, for example). See the topic guide.
Responses
| Status | Description |
|---|---|
200 | Aviso fechado. |
400 | Requisição inválida — falha de validação. |
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. |
422 | Pesquisa `immediate` ainda não respondida. |
500 | Erro interno do servidor. |
curl example
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 '{}'