Encerra a repetição
POST/api/surveys/{id}/recurrence/end
- Auth
- Requiere token
- Clave de API:
- surveys:write
- X-CommunityId
X-CommunityIdEnvía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.
Owner e admin. Para de vez; nenhuma rodada é apagada e a rodada aberta continua até fechar (ou até ser encerrada em `POST /api/surveys/{roundId}/close`). Já encerrada, 422 `recurrenceEnded`.
Parámetros
| Nombre | Dónde | Tipo | Descripción |
|---|---|---|---|
idobligatorio | path | string (uuid) |
Headers
| Nombre | Tipo | Descripción |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Cuerpo de la solicitud application/json
La especificación no declara los campos de este cuerpo (una subida multipart, por ejemplo). Consulta la guía del tema.
Respuestas
| Código | Descripción |
|---|---|
200 | Encerrada. |
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 | Sem repetição, já encerrada ou é uma rodada. |
500 | Erro interno do servidor. |
Ejemplo con curl
curl -X POST "https://api.memberfy.net/api/surveys/<id>/recurrence/end" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'