Skip to content
memberfy
US

Cria uma pesquisa (rascunho)

POST/api/surveys

Auth
Requires a token
API key:
surveys:write
X-CommunityId
X-CommunityId Send 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.

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.

Headers

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

Request body application/json

NameTypeDescription
spaceIdoptionalstring (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.
titleoptionalstringmax 200
descriptionoptionalstringmax 5000
templateoptionalnps | csat | event | course | enps | blankSó na criação: sem `sections`, a pesquisa nasce com as do modelo, no idioma da comunidade.
anonymityoptionalIDENTIFIED | ANONYMOUS
publicLinkEnabledoptionalboolean
startsAtoptionalstring (date-time)Início da coleta (opcional). Abrir com ele no futuro agenda a pesquisa.
closesAtoptionalstring (date-time)Fim da coleta (opcional), depois de `startsAt`.
responseModeoptionaloptional | required | immediate
sectionsoptionalobject[]
sections[].idoptionalstring (uuid)
sections[].positionoptionalinteger
sections[].titlerequiredstringmax 200
sections[].descriptionoptionalstring
sections[].questionsoptionalobject[]
sections[].questions[].idoptionalstring (uuid)
sections[].questions[].sectionIdoptionalstring (uuid)
sections[].questions[].positionoptionalinteger
sections[].questions[].typerequiredSINGLE_CHOICE | MULTIPLE_CHOICE | SCALE | NPS | TEXT
sections[].questions[].titlerequiredstringmax 500
sections[].questions[].helpoptionalstringmax 1000
sections[].questions[].requiredoptionalboolean
sections[].questions[].optionsoptionalobject[]
sections[].questions[].minoptionalinteger
sections[].questions[].maxoptionalinteger
sections[].questions[].minLabeloptionalstring
sections[].questions[].maxLabeloptionalstring
sections[].questions[].displayoptionalnumbers | stars | short | long
groupByPrimaryGroupoptionalbooleanSó 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.
recurrenceoptionalobjectSó 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`.

Responses

StatusDescription
201Criada.
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.
409O espaço é "Uma pesquisa" e já tem a sua (`errors[0].param = spaceId`).
422Sem `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.
500Erro interno do servidor.

curl example

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