Saltar para o conteúdo

Edita um endereço de encaminhamento

PATCH/api/virtual-office/me/addresses/{addressId}

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

Só o dono do endereço; de outra pessoa (equipe inclusive) ou de outra comunidade, 404. Só os campos enviados mudam; pedido já feito guarda a cópia antiga.

Parâmetros

NomeOndeTipoDescrição
addressIdobrigatóriopathstring (uuid)

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

A especificação não declara os campos deste corpo (upload multipart, por exemplo). Consulte o guia do assunto.

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`).
404Recurso não encontrado.
500Erro interno do servidor.

Exemplo com curl

curl -X PATCH "https://api.memberfy.net/api/virtual-office/me/addresses/<addressId>" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '"string"'