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ção | Obrigatória (Token de API, Bearer) |
| Scope | property-api-update |
| HTTP Method | PUT |
| Response | JSON |
| Version | 1 |
Uma regra decide onde se escreve
| Se a filial… | A escrita vai para | E 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
branchIdnumérico, tal comoGET /brancheso 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
}
| Campo | Tipo | Descrição |
|---|---|---|
name | string | O nome da filial |
email | string | O e-mail de contacto. É o que vê quem consulta o anúncio |
phone1 · phone2 · mobile | string | Os telefones de contacto |
address | string | O endereço |
zipcode | string | O código postal |
zone0 … zone3 | number | A sua localização, nas zonas da Mapaprop |
A resposta
{
"branchRef": "centro",
"mapapropBranchId": 12122,
"updated": true,
"scope": "mapaprop"
}
| Campo | Tipo | Descrição |
|---|---|---|
branchRef | string | A sua referência, a mesma que enviou |
mapapropBranchId | number | O id da filial na Mapaprop. Só vem se a filial existir lá |
updated | boolean | true |
scope | string | mapaprop ou ficha — onde se escreveu |
Erros
| Código | O que aconteceu | O que fazer |
|---|---|---|
400 | O body não é JSON válido | Verifique o Content-Type e o corpo |
403 | O token não tem o scope property-api-update | É uma permissão do seu token: escreva-nos |
404 | Esse 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 |
404 | Não há uma ficha para esse x-client-ref (error: customer_not_declared) | Crie-a com POST /customers |
409 | A conta chegou ao limite de filiais do seu plano (code: BRANCH_LIMIT_REACHED) | O limite é definido pelo plano da conta Mapaprop |
503 | Não conseguimos escrevê-la neste momento | É transitório e do nosso lado: tente de novo. Não se escreveu nada |
Relacionado
- Apagar uma filial
- GET /branches — as filiais da conta, com o seu
branchId - PUT /customers — declarar as filiais na ficha
- Várias filiais na ficha