Abre a pesquisa
POST/api/surveys/{id}/open
- Auth
- Token erforderlich
- API-Schlüssel:
- surveys:write
- X-CommunityId
X-CommunityIdSende die X-CommunityId der Community, in der die Operation stattfindet.
Owner e admin. Congela em destinatários quem tem acesso ao espaço da pesquisa hoje e passa a aceitar respostas. Precisa de pelo menos uma pergunta e de alguém com acesso ao espaço, do link público ligado, ou dos dois (sem os dois, 422). O modo não muda mais. Cada destinatário recebe **um** e-mail de convite (botão "Responder", que abre o formulário no domínio da comunidade, e o modo identificada/anônima), enviado depois, pelo serviço de avisos: 10 minutos depois, só a quem tem a categoria "Pesquisas" ligada, no máximo 3 avisos por pessoa por dia na comunidade, nunca a quem abriu; editar a pesquisa não reenvia. `notifyByEmail: false` abre sem mandar convite (nunca mais manda). O link do convite é o mesmo para todos (sem token por pessoa), então numa anônima nada liga o e-mail à resposta. A resposta traz `emailNotice`. **Agendar:** com `startsAt` no futuro, a pesquisa não abre agora: fica `scheduled` (mensagem "Pesquisa agendada"), nada é congelado nem enviado, e às `startsAt` (varredura de minuto) ela abre exatamente como aqui: público congelado naquela hora, convite pelo serviço de avisos 10 minutos depois, com a escolha de `notifyByEmail` feita agora. Nesse caso `emailNotice` traz também `opensAt` e `sendsAfter` (a partir de quando o convite sai) e `recipientCount` nulo. Até abrir, edita como rascunho; `startsAt: null` no PATCH cancela. Se na hora não der para abrir (sem perguntas, sem público e sem link, prazo vencido), volta a rascunho. Agendada de novo: 422 `alreadyScheduled`.
Parameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | path | string (uuid) |
Header
| Name | Typ | Beschreibung |
|---|---|---|
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
| Name | Typ | Beschreibung |
|---|---|---|
notifyByEmailoptional | boolean | "Avisar por e-mail". Padrão ligado. Só vale na **primeira** publicação do item por owner, admin ou moderador (conteúdo de membro nunca avisa): o aviso sai 10 minutos depois, para quem tem acesso ao espaço e ao item e tem a categoria ligada, menos quem publicou, no máximo 3 avisos por pessoa por dia na comunidade, fora da cota de campanhas. Desligado, o item fica marcado e nunca avisa depois. Editar, despublicar e publicar de novo não reenviam. Data retroativa e importação não avisam. |
Antworten
| Status | Beschreibung |
|---|---|
200 | Aberta. |
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 | Já aberta ou agendada, sem perguntas, sem público e sem link, prazo no passado, prazo antes do início ou público acima de 50.000. |
500 | Erro interno do servidor. |
curl-Beispiel
curl -X POST "https://api.memberfy.net/api/surveys/<id>/open" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'