Aller au contenu
memberfy
FR

Edita a pesquisa

PATCH/api/surveys/{id}

Auth
Jeton requis
Clé d’API:
surveys:write
X-CommunityId
X-CommunityId Envoyez 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. No rascunho, tudo (`spaceId` move a pesquisa para outro espaço de pesquisas); `sections` substitui a árvore inteira numa transação (até 20 seções e 100 perguntas). Aberta: só `title`, `description`, `closesAt` e `publicLinkEnabled` (qualquer outro campo, 422). Encerrada: 422.

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring (uuid)

En-têtes

NomTypeDescription
If-Unmodified-SincefacultatifstringOpcional: a versão lida (`updatedAt` do `GET`), como data HTTP, se não vier `updatedAt` no corpo. Outra gravação depois dela responde 409.
X-CommunityIdfacultatifstring (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

NomTypeDescription
spaceIdfacultatifstring (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.
titlefacultatifstringmax 200
descriptionfacultatifstringmax 5000
templatefacultatifnps | csat | event | course | enps | blankSó na criação: sem `sections`, a pesquisa nasce com as do modelo, no idioma da comunidade.
anonymityfacultatifIDENTIFIED | ANONYMOUS
publicLinkEnabledfacultatifboolean
startsAtfacultatifstring (date-time)Início da coleta (opcional). Abrir com ele no futuro agenda a pesquisa.
closesAtfacultatifstring (date-time)Fim da coleta (opcional), depois de `startsAt`.
responseModefacultatifoptional | required | immediate
sectionsfacultatifobject[]
sections[].idfacultatifstring (uuid)
sections[].positionfacultatifinteger
sections[].titleobligatoirestringmax 200
sections[].descriptionfacultatifstring
sections[].questionsfacultatifobject[]
sections[].questions[].idfacultatifstring (uuid)
sections[].questions[].sectionIdfacultatifstring (uuid)
sections[].questions[].positionfacultatifinteger
sections[].questions[].typeobligatoireSINGLE_CHOICE | MULTIPLE_CHOICE | SCALE | NPS | TEXT
sections[].questions[].titleobligatoirestringmax 500
sections[].questions[].helpfacultatifstringmax 1000
sections[].questions[].requiredfacultatifboolean
sections[].questions[].optionsfacultatifobject[]
sections[].questions[].minfacultatifinteger
sections[].questions[].maxfacultatifinteger
sections[].questions[].minLabelfacultatifstring
sections[].questions[].maxLabelfacultatifstring
sections[].questions[].displayfacultatifnumbers | stars | short | long
groupByPrimaryGroupfacultatifbooleanSó 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.
recurrencefacultatifobjectSó 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

StatutDescription
200A pesquisa atualizada.
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.
409Outra gravação veio antes da versão enviada (`updatedAt` no corpo ou `If-Unmodified-Since`); `data.updatedAt` é a versão atual: recarregue e repita. Cada gravação avisa os editores abertos (`item.saved`, ver `POST /api/realtime/ticket`).
422Árvore inválida, limite passado, campo travado depois de aberta, ou encerrada.
500Erro interno do servidor.

Exemple curl

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