BETA

DELETE /branches/{branchRef}

Borra una sucursal del cliente.

Información del recurso
AutenticaciónRequerida (Token de API, Bearer)
Scopeproperty-api-delete
HTTP MethodDELETE
ResponseJSON
Version1

🔴 No es sólo sacarla de una lista

Si la sucursal existe en la cuenta de Mapaprop del cliente, borrarla mueve cosas: sus propiedades, contactos, carteles y usuarios pasan a otra sucursal. Eso no se deshace.

Cuántas sucursales tiene la cuentaQué pasa
2Todo pasa a la sucursal principal. No hay nada que elegir
3 o másElegís vos con ?targetBranchRef= — si no lo mandás, respondemos 400 en vez de decidir por tu cliente
1No se puede borrar: una cuenta no puede quedarse sin sucursales

Si la sucursal vive sólo en la ficha (tu cliente no tiene cuenta de Mapaprop), se saca la entrada y no hay nada que reasignar.

La llamada

DELETE https://property-api.mapaprop.com/property-v1/branches/centro
Authorization: Bearer {access_token}
x-client-ref: {tu referencia del cliente}

Con destino, cuando la cuenta tiene tres o más sucursales:

DELETE https://property-api.mapaprop.com/property-v1/branches/centro?targetBranchRef=casa-central
ParámetroTipoDescripción
branchRefstring (path)Tu referencia de la sucursal que se borra. También vale su branchId numérico de Mapaprop
targetBranchRefstring (query)La sucursal que se queda con las propiedades, los contactos y los carteles. Obligatorio con 3 o más sucursales

La respuesta

{
  "branchRef": "centro",
  "mapapropBranchId": 12122,
  "deleted": true,
  "deletedInMapaprop": true,
  "reassignedTo": 1,
  "scope": "mapaprop"
}
CampoTipoDescripción
deletedbooleantrue — la sucursal ya no está
deletedInMapapropbooleantrue si además se borró en la cuenta de Mapaprop. false = vivía sólo en la ficha
reassignedTonumberEl branchId que recibió las propiedades, si mandaste un destino
scopestringmapaprop o ficha

Errores

CódigoQué pasóQué hacer
400Falta el destino (code: TARGET_BRANCH_REQUIRED)La cuenta tiene 3 o más sucursales: mandá ?targetBranchRef=
400El destino no sirve (code: INVALID_TARGET_BRANCH)No puede ser la misma que se borra ni la sucursal de un asesor. Mirá GET /branches
403El token no tiene el scope property-api-deleteEs un permiso de tu token: escribinos
404Ese branchRef no es una sucursal del cliente (rule: branch_not_found)El error te lista los refs que sí tiene
409Es la única sucursal de la cuenta (code: MUST_HAVE_AT_LEAST_ONE_BRANCH)Creá la otra primero y después borrá ésta
409Es la sucursal de un asesor (code: CANNOT_DELETE_AGENT_BRANCH)Su baja se hace desde el usuario del asesor, en Mapaprop. Por API todavía no hay forma
503No pudimos borrarla en este momentoEs transitorio y del lado nuestro: reintentá. No se borró nada

ℹ️ El 409 del asesor no se resuelve reintentando. Una sucursal de asesor está atada a su usuario: se libera cuando ese usuario se desactiva, y eso se hace en Mapaprop. Es una regla de la cuenta, no un problema de tu llamada.

Relacionado