Liga o escritório virtual e cadastra o endereço comercial
PUT/api/virtual-office/settings
- Auth
- Richiede un token
- Chiave API:
- parcels:write
- X-CommunityId
X-CommunityIdInvia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.
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.
Header
| Nome | Tipo | Descrizione |
|---|---|---|
X-CommunityIdfacoltativo | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corpo della richiesta application/json
| Nome | Tipo | Descrizione |
|---|---|---|
enabledfacoltativo | boolean | |
addressfacoltativo | object | Endereço (comercial da comunidade ou salvo pelo membro). `country` é ISO 3166-1 alfa-2. |
address.streetfacoltativo | string | max 160 |
address.numberfacoltativo | string | max 20 |
address.complementfacoltativo | string | max 80 |
address.districtfacoltativo | string | max 80 |
address.cityfacoltativo | string | max 80 |
address.statefacoltativo | string | max 40 |
address.postalCodefacoltativo | string | max 20 |
address.countryfacoltativo | string | min 2, max 2 |
Risposte
| Codice | Descrizione |
|---|---|
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. |
Esempio 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 '{}'