Pede para retirar, encaminhar ou descartar uma carta
POST/api/parcels/parcels/{parcelId}/request
- Auth
- Token erforderlich
- API-Schlüssel:
- parcels:write
- X-CommunityId
X-CommunityIdSende die X-CommunityId der Community, in der die Operation stattfindet.
**O destinatário** (o membro, ou um funcionário **atual** da empresa destinatária, regra da F-93 1C) de uma carta (`kind: LETTER`) ainda `RECEIVED`, com o escritório virtual ligado na comunidade e ativo para ele (plano ou produto com `includesVirtualOffice`, ou empresa residente `VIRTUAL_OFFICE`; sem: 403 `notActive`). `action`: `PICKUP` ("Vou retirar"), `FORWARD` (exige `addressId`, um endereço salvo da própria pessoa em `/api/virtual-office/me/addresses`; o endereço é copiado no pedido) ou `DISCARD` (fica registrado quem pediu e quando). Um pedido pendente por carta (409 `requestPending`). Quem não é destinatário, equipe inclusive, recebe 404; destinatário que perdeu o acesso ao espaço: 403 `forbidden`. Pacote ou outro tipo: 409 `notALetter`; carta fechada: 409. A fila da recepção é `GET /api/parcels/spaces/{spaceId}/requests`.
Parameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
parcelIdPflicht | path | string (uuid) |
Header
| Name | Typ | Beschreibung |
|---|---|---|
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 | Typ | Beschreibung |
|---|---|---|
actionPflicht | PICKUP | FORWARD | DISCARD | |
addressIdoptional | string (uuid) | Obrigatório com `FORWARD`. |
noteoptional | string | Recado para a recepção (cortado em 200 caracteres). · max 200 |
Antworten
| Status | Beschreibung |
|---|---|
201 | Pedido criado. |
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 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
409 | Conflito com o estado atual do recurso. |
500 | Erro interno do servidor. |
curl-Beispiel
curl -X POST "https://api.memberfy.net/api/parcels/parcels/<parcelId>/request" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"action":"PICKUP"}'