Liga o escritório virtual e cadastra o endereço comercial
PUT/api/virtual-office/settings
- Auth
- Requiere token
- Clave de API:
- parcels:write
- X-CommunityId
X-CommunityIdEnví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.
Owner e admin (moderador e financeiro: 403). `address` é parcial: só os campos enviados mudam. Ligar (`enabled: true`) exige o endereço completo (logradouro, cidade, CEP e país, salvos ou enviados agora): 400 `addressRequired` com um item em `errors` por campo que falta. Desligar esconde o endereço de todos e bloqueia pedidos novos; os pedidos pendentes continuam.
Headers
| Nombre | Tipo | Descripción |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Cuerpo de la solicitud application/json
| Nombre | Tipo | Descripción |
|---|---|---|
enabledopcional | boolean | |
addressopcional | object | Endereço (comercial da comunidade ou salvo pelo membro). `country` é ISO 3166-1 alfa-2. |
address.streetopcional | string | max 160 |
address.numberopcional | string | max 20 |
address.complementopcional | string | max 80 |
address.districtopcional | string | max 80 |
address.cityopcional | string | max 80 |
address.stateopcional | string | max 40 |
address.postalCodeopcional | string | max 20 |
address.countryopcional | string | min 2, max 2 |
Respuestas
| Código | Descripción |
|---|---|
200 | Salvo. |
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. |
500 | Erro interno do servidor. |
Ejemplo con curl
curl -X PUT "https://api.memberfy.net/api/virtual-office/settings" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'