Saltar al contenido principal

Actualizar Inmueble

PUThttps://{environment}.metrocuadrado.com/rest-api/realestate/update

Actualiza la información de un inmueble existente. Este endpoint utiliza el método PUT, por lo que se debe enviar la petición completa con todos los campos obligatorios y los valores con los que el inmueble debe quedar. No es una actualización parcial (PATCH).

Ambientes Disponibles​

AmbienteURL Base
Desarrollohttps://ptec-core-dev.metrocuadrado.com/rest-api/realestate/update
Producciónhttps://www.metrocuadrado.com/rest-api/realestate/update

Parámetros​

HeaderValorRequeridoDescripción
Content-Typeapplication/jsonSíTipo de contenido
x-api-keystringSíAPI key de autenticación
tokenstringSíToken JWT de acceso

Ejemplos​

curl -X PUT \
  'https://ptec-core-dev.metrocuadrado.com/rest-api/realestate/update' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'token: tu-jwt-token' \
  -d '{
    "realEstateId": "11222-M1234567",
    "realEstateType": 2,
    "realEstateOffer": 1,
    "price": 12000000,
    "administration": 800000,
    "city": 5,
    "neighborhood": "Laureles",
    "stratum": 5,
    "reference1": "9876543210",
    "address": "Carrera 80 # 33B 45",
    "latitude": 6.24420,
    "longitude": -75.58121,
    "amenities": {
      "builtTime": "Entre 5 y 10 años",
      "rooms": "4",
      "bathrooms": "3",
      "garages": "2",
      "garageType": "Compartido",
      "builtArea": "90",
      "area": "110",
      "negotiable": "false",
      "terraceOrBalcony": "Balcón",
      "terraceOrBalconyArea": "12.5",
      "dinningRoomType": "Comedor Auxiliar",
      "kitchenForm": "Abierta",
      "heaterType": "Gas",
      "gasInstallationType": "Propano",
      "stoveType": "Eléctrica",
      "closedComplex": false,
      "laundryArea": false,
      "furnished": false,
      "wardrobes": "3",
      "curtainType": "Cortinas",
      "block": "B",
      "apartmentNumber": "204",
      "floorNumber": "2",
      "studyOrLibrary": false,
      "serviceRoom": "false",
      "chimney": "false",
      "airConditioned": "false",
      "cytophone": "false",
      "registrationNumber": "XYZ123456",
      "jacuzzi": "false",
      "alarm": "false",
      "pool": "false",
      "tennisCourt": "false",
      "squashCourt": "false",
      "basketballCourt": "false",
      "soccerField": "false",
      "sauna": "false",
      "heater": "false",
      "handicappedAccesible": "false",
      "greenArea": "true",
      "childrenArea": "true",
      "cctv": "true",
      "bbqArea": "false",
      "surveillanceType": "Portería",
      "petsAllowed": "true",
      "onMainStreet": "false",
      "onSecondaryRoad": "true",
      "smokingAllowed": "false",
      "nearbySupermarket": "true",
      "nearbyShoppingCenter": "false",
      "nearbyPark": "true",
      "nearbyPublicTransport": "true",
      "nearbySchoolCollege": "false",
      "woodenFloor": "false",
      "carpetedFloor": "false",
      "tiledFloor": "true",
      "porcelainTiledFloor": "false",
      "fullKitchen": "true",
      "americanKitchen": "false",
      "serviceBathroom": "false",
      "utilityRoom": "false",
      "golfCage": "false",
      "surveillance": "true",
      "gateHouse": "false",
      "ruralZone": "false",
      "suitableForChildren": true,
      "terrace": false,
      "twoFamilyHome": false,
      "auxiliaryBathroom": false,
      "inBuilding": true,
      "shoppingZone": false,
      "residentialZone": true,
      "lifts": "1",
      "bodyguardRoom": false,
      "view": "Interior",
      "auxiliaryDinningRoom": false,
      "bedroomFlooringType": "Vinilo",
      "studyFlooringType": "Cerámica",
      "diningRoomFlooringType": "Mármol",
      "livingRoomFlooringType": "Granito",
      "flooringType": "Cerámica",
      "mortgageEntity": "Bancolombia",
      "hall": false,
      "securityDoors": false,
      "panoramicView": false,
      "elevator": false,
      "communityHall": false,
      "coveredGarage": false,
      "gym": false,
      "visitorParkingLot": false,
      "parkingType": "Cubierto"
    },
    "images": [
      "https://example.com/image1.jpg",
      "https://example.com/image2.jpg",
      "https://example.com/image3.jpg"
    ],
    "video": "https://www.youtube.com/watch?v=example123",
    "comments": "APTO EN VENTA: Este apartamento está ubicado en una zona tranquila y residencial, ideal para familias. Cuenta con amplios espacios y buena iluminación natural.",
    "agentId": 123456,
    "responseUrl": "https://example.com/api/callback"
  }'

Notas Importantes​

- Requiere un token JWT válido (generar en el endpoint de autenticación)

- La API Key debe corresponder al ambiente seleccionado

- Todos los campos marcados como requeridos deben enviarse

Comportamiento del PUT​

  • Este endpoint requiere el envío completo del recurso. Se debe incluir todos los campos obligatorios y todos los valores con los que el inmueble debe quedar registrado.
  • Todos los campos son modificables una vez creado el inmueble.

Campos opcionales y valores nulos​

  • Los campos opcionales que no se necesiten no deben incluirse en la petición. No enviar campos con valor null o vacío.

Imágenes​

  • El arreglo images reemplaza completamente las imágenes existentes del inmueble.
  • Se requieren mínimo 3 y máximo 20 imágenes.
  • Formatos aceptados: JPG, JPEG, JIF, JFIF, JPE, JFI, PNG. Máximo 8 MB por imagen.

Amenities​

  • Solo se aceptan los atributos definidos por la API. No se permiten atributos personalizados.
  • Consultar el catálogo de características para ver los amenities disponibles según el tipo de inmueble.

Validaciones de negocio​

  • realEstateId: No es obligatorio en el body, se obtiene automáticamente del token JWT enviado en los headers.
  • agentId: Si se envía, debe corresponder a un agente existente. Consultar el endpoint de agentes para obtener IDs válidos.
  • username: Se utiliza en la autenticación. Debe ser un usuario válido, con membresía activa y credenciales creadas.
  • integratorId: Campo opcional. Identificador del integrador que realiza la petición.

Campos de texto​

  • No se soporta marcado HTML en ningún campo de texto.
  • El campo comments tiene un máximo de 1.000 caracteres.

Cómo Probar​

Para probar este endpoint, sigue estos pasos:

  1. Genera un token JWT usando el endpoint de autenticación
  2. Asegúrate de usar la API Key correcta según el ambiente
  3. Incluye el token en el header token
  4. Prepara el body JSON con todos los campos obligatorios y los valores actualizados del inmueble
  5. Realiza la petición PUT al endpoint correspondiente

Códigos de Respuesta​

CódigoDescripción
200Transacción de actualización recibida
400Parámetros inválidos o faltantes
401Token inválido o expirado
404Inmueble no encontrado

Probar Endpoint​

API Tester

Prueba los endpoints de forma interactiva

Token Requerido

Este endpoint requiere autenticación. Configura un token JWT válido usando el botón de token en la parte superior de la página.