Aller au contenu

Edita uma enquete

PUT/api/polls/{id}

Auth
Jeton requis
Clé d’API:
polls: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, admin e moderador (e o SuperAdmin). `options` é a lista inteira, na ordem: `{ id, text }` mantém (e corrige o texto de) uma opção, `{ text }` acrescenta, e a opção que não vier é removida. Antes do primeiro voto tudo é editável. Depois do primeiro voto as opções ficam travadas como foram votadas: acrescentar, remover, mudar o texto ou a ordem dá 409 `optionsLocked` (mandar a lista igual, por exemplo junto com `closesAt`, passa); mudar `allowMultiple`, 409 `allowMultipleLocked`. `closesAt` muda enquanto a enquete está aberta (futuro, ou `null` para remover o prazo). Encerrada sem votos, só o texto e a ordem das opções mudam (o resto, 409). A pergunta continua editável pelo post.

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring (uuid)

En-têtes

NomTypeDescription
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
optionsfacultatifobject[]
options[].idfacultatifstring (uuid)
options[].textobligatoirestringmax 100
allowMultiplefacultatifboolean
closesAtfacultatifstring (date-time)

Réponses

StatutDescription
200Enquete 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.
409Mudança bloqueada: há votos ou a enquete está encerrada.
500Erro interno do servidor.

Exemple curl

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