Encerra a série
POST/api/one-on-ones/series/{seriesId}/end
- Auth
- Exige token
- Chave de API:
- Não aceita chave de API
- X-CommunityId
X-CommunityIdEnvie o X-CommunityId da comunidade em que a operação acontece.
Um dos participantes. O histórico fica, só leitura; o par pode começar outra série.
Parâmetros
| Nome | Onde | Tipo | Descrição |
|---|---|---|---|
seriesIdobrigatório | path | string (uuid) |
Headers
| Nome | Tipo | Descrição |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corpo da requisição application/json
A especificação não declara os campos deste corpo (upload multipart, por exemplo). Consulte o guia do assunto.
Respostas
| Código | Descrição |
|---|---|
200 | A série. |
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`). |
404 | Recurso não encontrado. |
409 | Conflito com o estado atual do recurso. |
Exemplo com curl
curl -X POST "https://api.memberfy.net/api/one-on-ones/series/<seriesId>/end" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'