Liga o escritório virtual e cadastra o endereço comercial
PUT/api/virtual-office/settings
- Auth
- Requires a token
- API key:
- parcels:write
- X-CommunityId
X-CommunityIdSend the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.
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
| Name | Type | Description |
|---|---|---|
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 | Type | Description |
|---|---|---|
enabledoptional | boolean | |
addressoptional | object | Endereço (comercial da comunidade ou salvo pelo membro). `country` é ISO 3166-1 alfa-2. |
address.streetoptional | string | max 160 |
address.numberoptional | string | max 20 |
address.complementoptional | string | max 80 |
address.districtoptional | string | max 80 |
address.cityoptional | string | max 80 |
address.stateoptional | string | max 40 |
address.postalCodeoptional | string | max 20 |
address.countryoptional | string | min 2, max 2 |
Responses
| Status | Description |
|---|---|
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. |
curl example
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 '{}'