BETA

Atualizar um cliente

PUT /property-v1/customers

Muda os dados da ficha. É a razão pela qual a ficha existe: mudar um telefone é esta chamada e nada mais, em vez de recadastrar o inventário.

curl -X PUT https://property-api.mapaprop.com/property-v1/customers \
  -H "Authorization: Bearer $TOKEN" \
  -H "x-client-ref: cliente-42" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Inmobiliaria Modelo",
        "email": "contacto@inmobiliaria-modelo.test",
        "phone1": "2239999999" }'

Aceita os mesmos campos que o POST e devolve 200 com a ficha atualizada.

O PUT declara como a ficha fica por completo, não faz merge campo por campo: o que você não enviar fica vazio. Se quiser mudar só o telefone, envie também o resto dos dados.

Por isso name, email e phone1 também são obrigatórios aqui: um PUT que os omitisse deixaria o cliente sem o contato que sai publicado nos seus anúncios. Responde 400 com o campo em field.

O customerId não é tocado. É a única coisa que faz com que mudar um telefone não obrigue a recriar nada.

As filiais também são atualizadas aqui

branches funciona igual ao POST: você declara o conjunto completo e ele é guardado. E se você é cliente do Mapaprop e declara uma filial nova com seus dados e sem mapapropBranchId, nós a criamos na sua conta e devolvemos o id dela na resposta:

{
  "branches": { "created": [ { "branchRef": "sur", "mapapropBranchId": 781 } ], "failed": [] },
  "customer": { "…" }
}

Repetir o PUT não duplica nada, e você não precisa enviar o mapapropBranchId. O vínculo entre seu branchRef e o id da filial é guardado por nós, e nós o preservamos mesmo que seu body não o mencione. Então você pode repetir exatamente o mesmo PUT: as que já foram criadas não são criadas de novo. Se uma falhou, você corrige essa e repete.

O que este PUT não faz é mudar os dados de uma filial que já está no Mapaprop: esses dados são lidos da sua conta, que é onde você os edita. O que você declara aqui para uma filial vinculada é apenas o vínculo.

A mudança alcança os imóveis NOVOS

Cada imóvel guarda o contato com que foi criado: é o registro de como foi publicado, então não é reescrito — nem reenviando o imóvel.

Ou seja: a ficha evita que você repita o bloco em cada cadastro, e o que já cadastrou conserva seus dados.

Se você precisar que uma mudança de contato alcance o inventário já cadastrado, escreva para dev@mapaprop.com: hoje não há como fazer isso pela API.

Um cliente com baixa não é atualizado

Se o cliente está com baixa, o PUT responde 404 com error: customer_deleted. Primeiro ele é reativado com o POST — que além disso aplica os dados que você enviar — e depois é atualizado, se for preciso.

É de propósito: um PUT que o atualizasse deixaria uma ficha com baixa e dados novos, o que não significa nada.

Códigos de resposta

CódigoO que aconteceuO que fazer
200A ficha atualizada—
400Falta name, email ou phone1; country não é um inteiro positivo; branch não é um objeto; ou um texto passa de 256 caracteresO campo vem em field
401Token ausente ou inválido—
403O seu token não tem o scope property-api-updateEscreva para nós para habilitá-lo
404Não existe, ou está com baixa (error: customer_deleted)Veja GET

Relacionado