PUT /branches/{branchRef}
Cambia los datos de una sucursal del cliente: su nombre, su dirección, su teléfono, su mail.
El branchRef es tu referencia — la misma que declarás en
branches[] de la ficha. Nombrás la sucursal como la nombraste
siempre y nosotros resolvemos dónde hay que escribir.
| Información del recurso | |
|---|---|
| Autenticación | Requerida (Token de API, Bearer) |
| Scope | property-api-update |
| HTTP Method | PUT |
| Response | JSON |
| Version | 1 |
Una regla decide dónde se escribe
| Si la sucursal… | La escritura va a | Y en la respuesta |
|---|---|---|
existe en la cuenta de Mapaprop del cliente (la ficha tiene su mapapropBranchId) | Mapaprop — que es de donde salen los datos de contacto cuando se publica — y después su ficha | "scope": "mapaprop" |
| vive sólo en la ficha (tu cliente no tiene cuenta de Mapaprop) | la ficha, que es su padrón | "scope": "ficha" |
No tenés que elegir: se resuelve solo, y la respuesta te dice qué pasó.
ℹ️ Si tu cliente sí tiene cuenta de Mapaprop, también podés nombrar la sucursal por su
branchIdnumérico, tal como lo devuelveGET /branches, sin declarar nada en la ficha.
🔴 Reemplaza la sucursal completa
Es el mismo contrato que el PUT de una propiedad: lo que
mandás ES la sucursal. Un campo que omitís queda vacío, no se conserva.
Mandala entera, siempre. Si sólo querés cambiar el teléfono, mandá también el nombre, el mail y la dirección que ya tenía.
La llamada
PUT https://property-api.mapaprop.com/property-v1/branches/centro
Authorization: Bearer {access_token}
x-client-ref: {tu referencia del 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 | Descripción |
|---|---|---|
name | string | El nombre de la sucursal |
email | string | El mail de contacto. Es el que ve quien consulta el aviso |
phone1 · phone2 · mobile | string | Los teléfonos de contacto |
address | string | La dirección |
zipcode | string | El código postal |
zone0 … zone3 | number | Su ubicación, en las zonas de Mapaprop |
La respuesta
{
"branchRef": "centro",
"mapapropBranchId": 12122,
"updated": true,
"scope": "mapaprop"
}
| Campo | Tipo | Descripción |
|---|---|---|
branchRef | string | Tu referencia, la misma que mandaste |
mapapropBranchId | number | El id de la sucursal en Mapaprop. Sólo viene si la sucursal existe ahí |
updated | boolean | true |
scope | string | mapaprop o ficha — dónde se escribió |
Errores
| Código | Qué pasó | Qué hacer |
|---|---|---|
400 | El body no es JSON válido | Revisá el Content-Type y el cuerpo |
403 | El token no tiene el scope property-api-update | Es un permiso de tu token: escribinos |
404 | Ese branchRef no es una sucursal del cliente (rule: branch_not_found) | El error te lista los refs que sí tiene. Se declaran con PUT /customers |
404 | No hay una ficha para ese x-client-ref (error: customer_not_declared) | Creála con POST /customers |
409 | La cuenta llegó al tope de sucursales de su plan (code: BRANCH_LIMIT_REACHED) | El tope lo fija el plan de la cuenta de Mapaprop |
503 | No pudimos escribirla en este momento | Es transitorio y del lado nuestro: reintentá. No se escribió nada |
Relacionado
- Borrar una sucursal
- GET /branches — las sucursales de la cuenta, con su
branchId - PUT /customers — declarar las sucursales en la ficha
- Varias sucursales en la ficha