Zum Inhalt springen

Manda lembrete a quem ainda tem avaliação pendente

POST/api/performance-reviews/cycles/{cycleId}/reminders

Auth
Token erforderlich
API-Schlüssel:
Kein API-Schlüssel möglich
X-CommunityId
X-CommunityId Sende die X-CommunityId der Community, in der die Operation stattfindet.
Die Beschreibungen der Endpoints stammen aus der API-Spezifikation und sind vorerst auf Portugiesisch. Die Oberfläche drumherum ist übersetzt.

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`.

Parameter

NameOrtTypBeschreibung
cycleIdPflichtpathstring (uuid)

Header

NameTypBeschreibung
X-CommunityIdoptionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Request-Body application/json

NameTypBeschreibung
dryRunoptionalboolean

Antworten

StatusBeschreibung
200`{ dryRun, recipientCount, recipients: [perfil], emailNotice }`.
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`).
403Sem permissão (`teamOnly`: só owner e admin; `progressDenied`/`resultsDenied`: quem não lidera ninguém; `supportSession`).
404Recurso não encontrado.
409Conflito com o estado atual do recurso.
500Erro interno do servidor.

curl-Beispiel

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 '{}'