Manda lembrete a quem ainda tem avaliação pendente
POST/api/performance-reviews/cycles/{cycleId}/reminders
- Auth
- Richiede un token
- Chiave API:
- Non accetta chiavi API
- X-CommunityId
X-CommunityIdInvia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.
Owner e admin, com o ciclo aberto. Só quem tem avaliação não iniciada ou em andamento recebe o e-mail (pela fila, categoria `performanceReview`, sem conteúdo); quem desligou a categoria não recebe. Com `dryRun: true`, devolve a lista sem enviar (o que o MCP mostra antes de confirmar). No máximo um lembrete manual por hora por ciclo (409 `reminderTooSoon`); ninguém pendente: 409 `nobodyPending`. Além disso, o lembrete automático sai nos `reminderDays` antes de `closesOn`.
Parametri
| Nome | Dove | Tipo | Descrizione |
|---|---|---|---|
cycleIdobbligatorio | path | string (uuid) |
Header
| Nome | Tipo | Descrizione |
|---|---|---|
X-CommunityIdfacoltativo | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corpo della richiesta application/json
| Nome | Tipo | Descrizione |
|---|---|---|
dryRunfacoltativo | boolean |
Risposte
| Codice | Descrizione |
|---|---|
200 | `{ dryRun, recipientCount, recipients: [perfil], emailNotice }`. |
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 | Sem permissão (`teamOnly`: só owner e admin; `progressDenied`/`resultsDenied`: quem não lidera ninguém; `supportSession`). |
404 | Recurso não encontrado. |
409 | Conflito com o estado atual do recurso. |
500 | Erro interno do servidor. |
Esempio con curl
curl -X POST "https://api.memberfy.net/api/performance-reviews/cycles/<cycleId>/reminders" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'