Pular para o conteúdo
memberfy
BR

Liga o escritório virtual e cadastra o endereço comercial

PUT/api/virtual-office/settings

Auth
Exige token
Chave de API:
parcels:write
X-CommunityId
X-CommunityId Envie o X-CommunityId da comunidade em que a operação acontece.

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

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

Corpo da requisição application/json

NomeTipoDescrição
enabledopcionalboolean
addressopcionalobjectEndereço (comercial da comunidade ou salvo pelo membro). `country` é ISO 3166-1 alfa-2.
address.streetopcionalstringmax 160
address.numberopcionalstringmax 20
address.complementopcionalstringmax 80
address.districtopcionalstringmax 80
address.cityopcionalstringmax 80
address.stateopcionalstringmax 40
address.postalCodeopcionalstringmax 20
address.countryopcionalstringmin 2, max 2

Respostas

CódigoDescrição
200Salvo.
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.
500Erro interno do servidor.

Exemplo com 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 '{}'