Devolve o PDI com uma nota
POST/api/development-plans/{id}/return
- 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.
Quem pode aprovar (veja aprovar). Nota obrigatória (422 `noteRequired`, até 2000 caracteres); o PDI volta a rascunho, a pessoa vê a nota (`returnNote`), edita e reenvia. A pessoa recebe o e-mail "PDI devolvido" (sem a nota).
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | 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
| Name | Type | Description |
|---|---|---|
noterequired | string | max 2000 |
Responses
| Status | Description |
|---|---|
200 | O PDI. |
400 | Requisição inválida — falha de validação. |
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 para esta ação no PDI (ex.: líder indireto ou financeiro tentando aprovar, `developmentPlan.errors.approveDenied`), espaço fechado para quem cria o próprio PDI, ou sessão de suporte do SuperAdmin (`supportSession`). |
404 | Recurso não encontrado. |
409 | Conflito com o estado atual do recurso. |
422 | Sem nota ou nota longa demais. |
500 | Erro interno do servidor. |
curl example
curl -X POST "https://api.memberfy.net/api/development-plans/<id>/return" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"note":"string"}'