Cria uma pesquisa (rascunho)
POST/api/surveys
- Auth
- Jeton requis
- Clé d’API:
- surveys:write
- X-CommunityId
X-CommunityIdEnvoyez 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.
Owner e admin. Precisa do `spaceId` de um espaço de pesquisas da comunidade. Nasce rascunho, invisível para todos, inclusive pelo link. Com `template` e sem `sections`, recebe as seções e perguntas do modelo no idioma da comunidade. O `publicToken` é gerado na criação; o link só responde com `publicLinkEnabled` e depois de aberta.
En-têtes
| Nom | Type | Description |
|---|---|---|
X-CommunityIdfacultatif | string (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
| Nom | Type | Description |
|---|---|---|
spaceIdfacultatif | string (uuid) | **Obrigatório na criação.** Um espaço do módulo `surveys` da comunidade do header (outro módulo, outra comunidade ou apagado: 422 em `spaceId`). Num espaço "Uma pesquisa" (`moduleConfig.mode = single`) que já tem uma, 409. Na edição (só no rascunho), move a pesquisa para outro espaço de pesquisas, com as mesmas regras. |
titlefacultatif | string | max 200 |
descriptionfacultatif | string | max 5000 |
templatefacultatif | nps | csat | event | course | enps | blank | Só na criação: sem `sections`, a pesquisa nasce com as do modelo, no idioma da comunidade. |
anonymityfacultatif | IDENTIFIED | ANONYMOUS | |
publicLinkEnabledfacultatif | boolean | |
startsAtfacultatif | string (date-time) | Início da coleta (opcional). Abrir com ele no futuro agenda a pesquisa. |
closesAtfacultatif | string (date-time) | Fim da coleta (opcional), depois de `startsAt`. |
responseModefacultatif | optional | required | immediate | |
sectionsfacultatif | object[] | |
sections[].idfacultatif | string (uuid) | |
sections[].positionfacultatif | integer | |
sections[].titleobligatoire | string | max 200 |
sections[].descriptionfacultatif | string | |
sections[].questionsfacultatif | object[] | |
sections[].questions[].idfacultatif | string (uuid) | |
sections[].questions[].sectionIdfacultatif | string (uuid) | |
sections[].questions[].positionfacultatif | integer | |
sections[].questions[].typeobligatoire | SINGLE_CHOICE | MULTIPLE_CHOICE | SCALE | NPS | TEXT | |
sections[].questions[].titleobligatoire | string | max 500 |
sections[].questions[].helpfacultatif | string | max 1000 |
sections[].questions[].requiredfacultatif | boolean | |
sections[].questions[].optionsfacultatif | object[] | |
sections[].questions[].minfacultatif | integer | |
sections[].questions[].maxfacultatif | integer | |
sections[].questions[].minLabelfacultatif | string | |
sections[].questions[].maxLabelfacultatif | string | |
sections[].questions[].displayfacultatif | numbers | stars | short | long | |
groupByPrimaryGroupfacultatif | boolean | Só anônima e só no rascunho (identificada: 422 `groupingAnonymousOnly`; mudar para identificada desliga). Aceito e guardado, mas sem efeito até o mapa de calor anônimo chegar. |
recurrencefacultatif | object | Só no rascunho (aberta ou agendada: 422 `recurrenceDraftOnly`; numa rodada: 422 `recurrenceRoundCannotRepeat`). Um objeto liga a repetição (ou muda a agenda) e a primeira rodada abre na próxima data depois de agora (ou de `startsAt`); a pesquisa recorrente continua editável e cada mudança vale só para as próximas rodadas. `null` desliga: sem rodadas, volta a ser rascunho comum; com rodadas, encerra a repetição. Encerrada: 422 `recurrenceEnded`. |
Réponses
| Statut | Description |
|---|---|
201 | Criada. |
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. |
409 | O espaço é "Uma pesquisa" e já tem a sua (`errors[0].param = spaceId`). |
422 | Sem `spaceId` ou espaço que não é de pesquisas da comunidade (`errors[0].param = spaceId`); árvore inválida (cada problema com o caminho em `errors[].param`, ex.: `sections[1].questions[0].options`), mais de 20 seções ou 100 perguntas, modelo desconhecido. |
500 | Erro interno do servidor. |
Exemple curl
curl -X POST "https://api.memberfy.net/api/surveys" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'