Pausa a série
POST/api/one-on-ones/series/{seriesId}/pause
- Auth
- Requires a token
- API key:
- No API key accepted
- X-CommunityId
X-CommunityIdSend 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.
Um dos participantes. Pausada, as reuniões ficam como estão e nenhum lembrete sai (não ativa: 409 `seriesNotActive`). Pausar, retomar ou encerrar a série interna de registros (`kind: LOG`): 409 `logSeries`.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
seriesIdrequired | path | string (uuid) |
Headers
| Name | Type | Description |
|---|---|---|
X-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Request body application/json
The specification does not declare the fields of this body (a multipart upload, for example). See the topic guide.
Responses
| Status | Description |
|---|---|
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. |
curl example
curl -X POST "https://api.memberfy.net/api/one-on-ones/series/<seriesId>/pause" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'