O destinatário tem escritório virtual ativo?
GET/api/virtual-office/recipient-status
- Auth
- Exige token
- Chave de API:
- parcels:read
- X-CommunityId
X-CommunityIdEnvie o X-CommunityId da comunidade em que a operação acontece.
Equipe. Para a recepção conferir antes de registrar uma correspondência: exatamente um de `memberId` e `companyId` (os dois ou nenhum: 400; de outra comunidade: 404). Com o recurso ligado e o destinatário sem plano, `warning` é `noVirtualOffice` e `warningMessage` traz o aviso "sem escritório virtual ativo". O registro de uma carta (`POST /api/parcels/spaces/{spaceId}/parcels`) devolve o mesmo em `data.virtualOffice`.
Parâmetros
| Nome | Onde | Tipo | Descrição |
|---|---|---|---|
memberIdopcional | query | string (uuid) | |
companyIdopcional | query | string (uuid) |
Headers
| Nome | Tipo | Descrição |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Respostas
| Código | Descrição |
|---|---|
200 | Situação. |
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. |
500 | Erro interno do servidor. |
Exemplo com curl
curl -X GET "https://api.memberfy.net/api/virtual-office/recipient-status" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"