Saltar al contenido

O destinatário tem escritório virtual ativo?

GET/api/virtual-office/recipient-status

Auth
Requiere token
Clave de API:
parcels:read
X-CommunityId
X-CommunityId Envía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.

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

NombreDóndeTipoDescripción
memberIdopcionalquerystring (uuid)
companyIdopcionalquerystring (uuid)

Headers

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

Respuestas

CódigoDescripción
200Situação.
400Requisição inválida — falha de validação.
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`).
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
500Erro interno do servidor.

Ejemplo con curl

curl -X GET "https://api.memberfy.net/api/virtual-office/recipient-status" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"