BETA

PUT /branches/{branchRef}

Altera os dados de uma filial do cliente: o nome, o endereço, o telefone, o e-mail.

O branchRef é a sua referência — a mesma que declara em branches[] da ficha. Nomeia a filial como sempre a nomeou e nós resolvemos onde é preciso escrever.

Informação do recurso
AutenticaçãoObrigatória (Token de API, Bearer)
Scopeproperty-api-update
HTTP MethodPUT
ResponseJSON
Version1

Uma regra decide onde se escreve

Se a filial…A escrita vai paraE na resposta
existe na conta Mapaprop do cliente (a ficha tem o seu mapapropBranchId)a Mapaprop — que é de onde saem os dados de contacto ao publicar — e depois a sua ficha"scope": "mapaprop"
vive apenas na ficha (o seu cliente não tem conta Mapaprop)a ficha, que é o seu cadastro"scope": "ficha"

Não precisa de escolher: resolve-se sozinho, e a resposta diz-lhe o que aconteceu.

ℹ️ Se o seu cliente tem conta Mapaprop, também pode nomear a filial pelo seu branchId numérico, tal como GET /branches o devolve, sem declarar nada na ficha.

🔴 Substitui a filial completa

É o mesmo contrato do PUT de uma propriedade: o que envia É a filial. Um campo que omite fica vazio, não se conserva.

Envie-a sempre completa. Se quiser alterar apenas o telefone, envie também o nome, o e-mail e o endereço que já tinha.

A chamada

PUT https://property-api.mapaprop.com/property-v1/branches/centro
Authorization: Bearer {access_token}
x-client-ref: {a sua referência do cliente}
Content-Type: application/json
{
  "name": "Sucursal Centro",
  "email": "centro@inmobiliaria.com",
  "phone1": "2234000111",
  "mobile": "2235000111",
  "address": "San Martín 100",
  "zipcode": "7600",
  "zone0": 1,
  "zone1": 2,
  "zone2": 137,
  "zone3": 1137
}
CampoTipoDescrição
namestringO nome da filial
emailstringO e-mail de contacto. É o que vê quem consulta o anúncio
phone1 · phone2 · mobilestringOs telefones de contacto
addressstringO endereço
zipcodestringO código postal
zone0 … zone3numberA sua localização, nas zonas da Mapaprop

A resposta

{
  "branchRef": "centro",
  "mapapropBranchId": 12122,
  "updated": true,
  "scope": "mapaprop"
}
CampoTipoDescrição
branchRefstringA sua referência, a mesma que enviou
mapapropBranchIdnumberO id da filial na Mapaprop. Só vem se a filial existir lá
updatedbooleantrue
scopestringmapaprop ou ficha — onde se escreveu

Erros

CódigoO que aconteceuO que fazer
400O body não é JSON válidoVerifique o Content-Type e o corpo
403O token não tem o scope property-api-updateÉ uma permissão do seu token: escreva-nos
404Esse branchRef não é uma filial do cliente (rule: branch_not_found)O erro lista as refs que de facto tem. Declaram-se com PUT /customers
404Não há uma ficha para esse x-client-ref (error: customer_not_declared)Crie-a com POST /customers
409A conta chegou ao limite de filiais do seu plano (code: BRANCH_LIMIT_REACHED)O limite é definido pelo plano da conta Mapaprop
503Não conseguimos escrevê-la neste momentoÉ transitório e do nosso lado: tente de novo. Não se escreveu nada

Relacionado