API de TochiHub

El contrato de tu integración, campo por campo. Explora una operación o prueba una solicitud con tu API key.

URL basehttps://docs.tochihub.cl

Descargar OpenAPI Markdown para asistentes

Estado del servicio

GET/v1/health

Comprueba que la API está disponible. No requiere autenticación.

GET/v1/health

cURL

curl 'https://docs.tochihub.cl/v1/health'

JavaScript

const response = await fetch("https://docs.tochihub.cl/v1/health", {
  method: "GET",
  headers: {},
});

const data = await response.json();

Python

import os
import requests

response = requests.request(
    "GET",
    "https://docs.tochihub.cl/v1/health",
    headers={},
    timeout=30,
)
print(response.json())

Respuestas

Servicio disponible.

JSON

{
  "status": "ok",
  "service": "api-public"
}

Esquema de respuesta

statusstringOpcional

servicestringOpcional

Listar propiedades

GET/v1/properties

Lista paginada (más nuevas primero). Filtra por estado, operación, texto libre o externalId (el id de tu CRM). Una key de prueba solo ve propiedades sandbox y una de producción solo las reales. Scope requerido: properties:read.

API key requerida x-api-keyVer autenticación →

Parámetros de consulta

pagenumberOpcional

Página (parte en 1).

mín. 1Por defecto: 1

limitnumberOpcional

Resultados por página.

mín. 1máx. 100Por defecto: 20

statusPropertyStatusOpcional

Estado calculado: READY si ya cumple título, precio y 3 fotos.

"DRAFT""READY""PUBLISHED""PAUSED""ARCHIVED"

operationTypeOperationTypeOpcional

SALE = venta, RENT = arriendo.

"SALE""RENT"

searchstringOpcional

Búsqueda por título, comuna o región.

externalIdstringOpcional

Filtra por el id de tu CRM (externalId).

GET/v1/properties

cURL

curl 'https://docs.tochihub.cl/v1/properties' \
  --header "x-api-key: $TOCHIHUB_API_KEY"

JavaScript

const response = await fetch("https://docs.tochihub.cl/v1/properties", {
  method: "GET",
  headers: {
    "x-api-key": "YOUR_API_KEY"
  },
});

const data = await response.json();

Python

import os
import requests

response = requests.request(
    "GET",
    "https://docs.tochihub.cl/v1/properties",
    headers={"x-api-key":os.environ["TOCHIHUB_API_KEY"]},
    timeout=30,
)
print(response.json())

Respuestas

Solicitud completada.

JSON

{
  "items": [
    {
      "id": "clw2v8c4m0000u7w4mr9db4kn",
      "externalId": "crm-prop-12345",
      "sandbox": false,
      "title": "Departamento 2D2B a pasos del Metro Manquehue",
      "description": null,
      "operationType": "SALE",
      "status": "DRAFT",
      "priceValue": 6250,
      "priceCurrency": "CLP",
      "propertyType": "departamento",
      "bedrooms": 2,
      "bathrooms": 2,
      "parkingSpaces": 1,
      "storageUnits": 1,
      "totalAreaM2": 35.2,
      "usefulAreaM2": 33.4,
      "terraceAreaM2": 1.8,
      "commonExpenses": 120000,
      "yearBuilt": 2015,
      "lat": -33.4072,
      "lng": -70.5681,
      "addressLine": "Av. Apoquindo 4501",
      "unitNumber": "1203",
      "commune": "Las Condes",
      "region": "Región Metropolitana",
      "reference": "A pasos del Metro Manquehue",
      "propertyRole": "123-45",
      "clubId": "clw2v8c4m0000u7w4mr9db4kn",
      "amenities": {
        "comfort": {
          "pool": true
        },
        "special": {
          "furnished": false
        }
      },
      "characteristics": {
        "orientation": "norte",
        "floorLevel": 12
      },
      "media": [
        {
          "id": "clw2v8c4m0001u7w4abcd1234",
          "url": "https://cdn.tu-crm.cl/propiedades/apt-123/principal.jpg",
          "type": "IMAGE",
          "sortOrder": 0,
          "altText": "Living comedor con vista al cerro"
        }
      ],
      "createdAt": "2026-10-05T14:03:00.000Z",
      "updatedAt": "2026-10-05T14:03:00.000Z"
    }
  ],
  "total": 42,
  "page": 1,
  "limit": 20
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

itemsPublicPropertyDetailResponseDto[]Requerido

Ver campos del elemento

idstringRequerido

externalIdstring | nullOpcional

Id en tu CRM (el externalId que enviaste).

sandboxbooleanRequerido

true si fue creada con una API key de prueba (nunca llega a portales reales).

titlestringRequerido

descriptionstring | nullOpcional

operationTypeOperationTypeRequerido

SALE = venta, RENT = arriendo.

"SALE""RENT"

Ver campos

OperationType

Valores: "SALE" "RENT"

SALE = venta, RENT = arriendo.

statusPropertyStatusRequerido

DRAFT: faltan datos o fotos. READY: lista para publicar. PUBLISHED: activa en al menos un portal. PAUSED / ARCHIVED.

"DRAFT""READY""PUBLISHED""PAUSED""ARCHIVED"

Ver campos

PropertyStatus

Valores: "DRAFT" "READY" "PUBLISHED" "PAUSED" "ARCHIVED"

DRAFT: faltan datos o fotos. READY: lista para publicar. PUBLISHED: activa en al menos un portal. PAUSED / ARCHIVED.

priceValuenumberRequerido

priceCurrencyPriceCurrencyRequerido

"CLP""UF"

Ver campos

PriceCurrency

Valores: "CLP" "UF"

propertyTypestring | nullOpcional

bedroomsnumber | nullOpcional

bathroomsnumber | nullOpcional

parkingSpacesnumber | nullOpcional

storageUnitsnumber | nullOpcional

totalAreaM2number | nullOpcional

usefulAreaM2number | nullOpcional

terraceAreaM2number | nullOpcional

commonExpensesnumber | nullOpcional

yearBuiltnumber | nullOpcional

latnumber | nullOpcional

lngnumber | nullOpcional

addressLinestring | nullOpcional

unitNumberstring | nullOpcional

communestring | nullOpcional

regionstring | nullOpcional

referencestring | nullOpcional

propertyRolestring | nullOpcional

clubIdstring | nullOpcional

amenitiesobjectRequerido

Amenidades guardadas, en el mismo formato que se envían.

characteristicsobjectRequerido

Características guardadas. Envíalas completas en el PATCH: el objeto se reemplaza entero.

mediaPublicPropertyMediaResponseDto[]Requerido

Ver campos del elemento

idstringRequerido

Id de la foto. Úsalo para editarla o eliminarla.

urlstringRequerido

typestringRequerido

sortOrdernumberRequerido

altTextstring | nullOpcional

createdAtstringRequerido

updatedAtstringRequerido

totalnumberRequerido

Total de resultados con los filtros aplicados.

pagenumberRequerido

limitnumberRequerido

Body o parámetros inválidos; error.details lista los campos.

JSON

{
  "error": {
    "code": "bad_request",
    "message": "La validación del request falló",
    "details": [
      "title must be a string"
    ],
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Falta el header x-api-key, o la key es inválida o fue revocada.

JSON

{
  "error": {
    "code": "unauthorized",
    "message": "API key inválida o revocada",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

La key no tiene el scope requerido, o el plan/la suscripción de la corredora no lo permite.

JSON

{
  "error": {
    "code": "forbidden",
    "message": "La API key no tiene el scope requerido: properties:read",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Superaste el rate limit; espera los segundos del header Retry-After.

JSON

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Superaste el límite de requests de la API pública; reintenta después de Retry-After segundos",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Retry-AfterintegerOpcional

Segundos a esperar antes de reintentar.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Crear una propiedad

POST/v1/properties

Crea una propiedad de la corredora dueña de la API key. Queda en DRAFT y pasa sola a READY cuando tiene título, precio y al menos 3 fotos. Con una key de prueba (th_test_) se crea como sandbox: solo la ven las keys de prueba y nunca llega a portales reales. Emite el webhook PROPERTY_CREATED. Scope requerido: properties:write.

API key requerida x-api-keyVer autenticación →

Encabezados

Idempotency-KeystringOpcional

Clave estable para reintentar sin duplicar (válida 7 días). Repetirla con el mismo body devuelve la misma respuesta; con otro body devuelve 409.

Cuerpo de la solicitud

application/json

titlestringRequerido

Título del aviso. Yapo exige al menos 10 caracteres; TocToc entre 10 y 70.

descriptionstringOpcional

Descripción del aviso en texto plano (si llega HTML se convierte a texto). TocToc exige al menos 50 caracteres.

operationTypeOperationTypeRequerido

SALE = venta, RENT = arriendo.

"SALE""RENT"

Ver campos

OperationType

Valores: "SALE" "RENT"

SALE = venta, RENT = arriendo.

priceValuenumberRequerido

Precio como entero. Los precios en UF también van como entero.

mín. 0

priceCurrencyPriceCurrencyRequerido

"CLP""UF"

Ver campos

PriceCurrency

Valores: "CLP" "UF"

propertyTypestringOpcional

Tipo de propiedad: departamento, casa, oficina, local, terreno, parcela, bodega, estacionamiento.

bedroomsnumberOpcional

Dormitorios.

mín. 0

bathroomsnumberOpcional

Baños.

mín. 0

parkingSpacesnumberOpcional

Estacionamientos.

mín. 0

storageUnitsnumberOpcional

Bodegas.

mín. 0

totalAreaM2numberOpcional

Superficie total en m². En casas, parcelas y terrenos es la superficie del terreno. Admite decimales.

mín. 0

usefulAreaM2numberOpcional

Superficie útil en m². Yapo y TocToc la publican como superficie construida; si falta, Yapo usa la superficie total. Admite decimales.

mín. 0

terraceAreaM2numberOpcional

Superficie de terraza en m². Admite decimales.

mín. 0

commonExpensesnumber | nullOpcional

Gastos comunes mensuales en CLP. Omitirlos o enviar 0 significa "no informado": los portales no muestran gastos comunes. En PATCH, null borra el valor guardado.

yearBuiltnumberOpcional

Año de construcción.

latnumberOpcional

Latitud. Varios portales exigen la ubicación en el mapa.

lngnumberOpcional

Longitud.

addressLinestringOpcional

referencestringOpcional

Referencia de ubicación para el aviso.

propertyRolestringOpcional

Rol de avalúo (SII). TocToc lo lee.

unitNumberstringOpcional

Número de departamento u oficina.

communestringOpcional

Comuna, con tildes y ñ (ej. "Ñuñoa").

regionstringOpcional

amenitiesobjectOpcional

Amenidades por grupo (grupo → clave → booleano). true = la propiedad la tiene; false = no la tiene, y se publica como "No"; omitirla = no informado, y no se publica. Claves que leen los portales: comfort (pool, gym, bbq, sauna, laundry, washerHookup, rooftop, fireplace, gamesRoom, cinemaRoom, eventsRoom, greenAreas, playground, bikeStorage, tennisCourt), security (elevator, concierge, alarmSystem, automaticGate, gatedCommunity, visitorParking, controlledAccess), services (heating, naturalGas), environments (attic, jacuzzi, dailyDining, suiteBedroom, walkInCloset, guestBathroom) y special (furnished, petsAllowed). Envía solo lo que conoces.

characteristicsobjectOpcional

Datos extra que algunos portales leen (orientation, floorLevel, videoTourUrl, contactName, contactPhone, contactEmail, ...). La clave "external" está reservada.

externalIdstringOpcional

Id estable de la propiedad en tu CRM. Úsalo para encontrarla después con GET /v1/properties?externalId=.

clubIdstringOpcional

Id de una colección (club) de la corredora o global.

statusstringOpcional

Obsoleto: se ignora. El estado se calcula solo (READY cuando tiene título, precio y al menos 3 fotos).

"DRAFT""READY"

mediaCreatePublicPropertyMediaDto[]Opcional

Fotos por URL.

Ver campos del elemento

typePropertyMediaTypeOpcional

Tipo de archivo. Solo las IMAGE cuentan para el mínimo de 3 fotos.

Por defecto: "IMAGE"

"IMAGE""VIDEO""TOUR_360""DOCUMENT"

Ver campos

PropertyMediaType

Valores: "IMAGE" "VIDEO" "TOUR_360" "DOCUMENT"

Tipo de archivo. Solo las IMAGE cuentan para el mínimo de 3 fotos.

urlstringRequerido

URL pública (HTTPS) de la foto. Los portales la descargan tal cual: debe ser accesible sin autenticación.

sortOrdernumberOpcional

Orden de la foto; la de menor orden es la portada.

mín. 0

altTextstringOpcional

POST/v1/properties

cURL

curl 'https://docs.tochihub.cl/v1/properties' \
  --request POST \
  --header "x-api-key: $TOCHIHUB_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "Departamento 2D2B a pasos del Metro Manquehue",
  "description": "Departamento luminoso con estacionamiento y bodega, orientación norte.",
  "operationType": "SALE",
  "priceValue": 6250,
  "priceCurrency": "UF",
  "propertyType": "departamento",
  "bedrooms": 2,
  "bathrooms": 2,
  "parkingSpaces": 1,
  "storageUnits": 1,
  "totalAreaM2": 35.2,
  "usefulAreaM2": 33.4,
  "terraceAreaM2": 1.8,
  "commonExpenses": 120000,
  "yearBuilt": 2015,
  "lat": -33.4072,
  "lng": -70.5681,
  "addressLine": "Av. Apoquindo 4501",
  "reference": "A pasos del Metro Manquehue",
  "propertyRole": "123-45",
  "unitNumber": "1203",
  "commune": "Las Condes",
  "region": "Región Metropolitana",
  "amenities": {
    "comfort": {
      "pool": true,
      "gym": true
    },
    "security": {
      "elevator": true
    },
    "special": {
      "furnished": false
    }
  },
  "characteristics": {
    "orientation": "norte",
    "floorLevel": 12
  },
  "externalId": "crm-prop-12345",
  "clubId": "clw2v8c4m0000u7w4mr9db4kn",
  "status": "DRAFT",
  "media": [
    {
      "type": "IMAGE",
      "url": "https://cdn.tu-crm.cl/propiedades/apt-123/principal.jpg",
      "sortOrder": 0,
      "altText": "Living comedor con vista al cerro"
    }
  ]
}'

JavaScript

const response = await fetch("https://docs.tochihub.cl/v1/properties", {
  method: "POST",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "title": "Departamento 2D2B a pasos del Metro Manquehue",
    "description": "Departamento luminoso con estacionamiento y bodega, orientación norte.",
    "operationType": "SALE",
    "priceValue": 6250,
    "priceCurrency": "UF",
    "propertyType": "departamento",
    "bedrooms": 2,
    "bathrooms": 2,
    "parkingSpaces": 1,
    "storageUnits": 1,
    "totalAreaM2": 35.2,
    "usefulAreaM2": 33.4,
    "terraceAreaM2": 1.8,
    "commonExpenses": 120000,
    "yearBuilt": 2015,
    "lat": -33.4072,
    "lng": -70.5681,
    "addressLine": "Av. Apoquindo 4501",
    "reference": "A pasos del Metro Manquehue",
    "propertyRole": "123-45",
    "unitNumber": "1203",
    "commune": "Las Condes",
    "region": "Región Metropolitana",
    "amenities": {
      "comfort": {
        "pool": true,
        "gym": true
      },
      "security": {
        "elevator": true
      },
      "special": {
        "furnished": false
      }
    },
    "characteristics": {
      "orientation": "norte",
      "floorLevel": 12
    },
    "externalId": "crm-prop-12345",
    "clubId": "clw2v8c4m0000u7w4mr9db4kn",
    "status": "DRAFT",
    "media": [
      {
        "type": "IMAGE",
        "url": "https://cdn.tu-crm.cl/propiedades/apt-123/principal.jpg",
        "sortOrder": 0,
        "altText": "Living comedor con vista al cerro"
      }
    ]
  }),
});

const data = await response.json();

Python

import os
import requests

response = requests.request(
    "POST",
    "https://docs.tochihub.cl/v1/properties",
    headers={"x-api-key":os.environ["TOCHIHUB_API_KEY"],"Content-Type":"application/json"},
    json=__import__("json").loads("{\"title\":\"Departamento 2D2B a pasos del Metro Manquehue\",\"description\":\"Departamento luminoso con estacionamiento y bodega, orientación norte.\",\"operationType\":\"SALE\",\"priceValue\":6250,\"priceCurrency\":\"UF\",\"propertyType\":\"departamento\",\"bedrooms\":2,\"bathrooms\":2,\"parkingSpaces\":1,\"storageUnits\":1,\"totalAreaM2\":35.2,\"usefulAreaM2\":33.4,\"terraceAreaM2\":1.8,\"commonExpenses\":120000,\"yearBuilt\":2015,\"lat\":-33.4072,\"lng\":-70.5681,\"addressLine\":\"Av. Apoquindo 4501\",\"reference\":\"A pasos del Metro Manquehue\",\"propertyRole\":\"123-45\",\"unitNumber\":\"1203\",\"commune\":\"Las Condes\",\"region\":\"Región Metropolitana\",\"amenities\":{\"comfort\":{\"pool\":true,\"gym\":true},\"security\":{\"elevator\":true},\"special\":{\"furnished\":false}},\"characteristics\":{\"orientation\":\"norte\",\"floorLevel\":12},\"externalId\":\"crm-prop-12345\",\"clubId\":\"clw2v8c4m0000u7w4mr9db4kn\",\"status\":\"DRAFT\",\"media\":[{\"type\":\"IMAGE\",\"url\":\"https://cdn.tu-crm.cl/propiedades/apt-123/principal.jpg\",\"sortOrder\":0,\"altText\":\"Living comedor con vista al cerro\"}]}"),
    timeout=30,
)
print(response.json())

Respuestas

Propiedad creada.

JSON

{
  "id": "clw2v8c4m0000u7w4mr9db4kn",
  "status": "READY",
  "mediaCount": 3,
  "sandbox": false,
  "createdAt": "2026-10-05T14:03:00.000Z"
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

idstringRequerido

Id de la propiedad en TochiHub.

statusPropertyStatusRequerido

Estado calculado: READY si ya cumple título, precio y 3 fotos.

"DRAFT""READY""PUBLISHED""PAUSED""ARCHIVED"

Ver campos

PropertyStatus

Valores: "DRAFT" "READY" "PUBLISHED" "PAUSED" "ARCHIVED"

Estado calculado: READY si ya cumple título, precio y 3 fotos.

mediaCountnumberRequerido

Cantidad de fotos/archivos asociados.

sandboxbooleanRequerido

true si se creó con una API key de prueba.

createdAtstringRequerido

Body o parámetros inválidos; error.details lista los campos.

JSON

{
  "error": {
    "code": "bad_request",
    "message": "La validación del request falló",
    "details": [
      "title must be a string"
    ],
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Falta el header x-api-key, o la key es inválida o fue revocada.

JSON

{
  "error": {
    "code": "unauthorized",
    "message": "API key inválida o revocada",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

La key no tiene el scope requerido, o el plan/la suscripción de la corredora no lo permite.

JSON

{
  "error": {
    "code": "forbidden",
    "message": "La API key no tiene el scope requerido: properties:write",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

La Idempotency-Key ya se usó con otro body o sigue en proceso.

JSON

{
  "error": {
    "code": "conflict",
    "message": "La Idempotency-Key ya se usó con otro body o sigue en proceso.",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Superaste el rate limit; espera los segundos del header Retry-After.

JSON

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Superaste el límite de requests de la API pública; reintenta después de Retry-After segundos",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Retry-AfterintegerOpcional

Segundos a esperar antes de reintentar.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Obtener una propiedad

GET/v1/properties/{id}

Devuelve el detalle completo de una propiedad de la corredora. Scope requerido: properties:read.

API key requerida x-api-keyVer autenticación →

Parámetros de ruta

idstringRequerido

Identificador del recurso, devuelto al crearlo o listarlo.

GET/v1/properties/{id}

cURL

curl 'https://docs.tochihub.cl/v1/properties/%7Bid%7D' \
  --header "x-api-key: $TOCHIHUB_API_KEY"

JavaScript

const response = await fetch("https://docs.tochihub.cl/v1/properties/%7Bid%7D", {
  method: "GET",
  headers: {
    "x-api-key": "YOUR_API_KEY"
  },
});

const data = await response.json();

Python

import os
import requests

response = requests.request(
    "GET",
    "https://docs.tochihub.cl/v1/properties/%7Bid%7D",
    headers={"x-api-key":os.environ["TOCHIHUB_API_KEY"]},
    timeout=30,
)
print(response.json())

Respuestas

Solicitud completada.

JSON

{
  "id": "clw2v8c4m0000u7w4mr9db4kn",
  "externalId": "crm-prop-12345",
  "sandbox": false,
  "title": "Departamento 2D2B a pasos del Metro Manquehue",
  "description": null,
  "operationType": "SALE",
  "status": "DRAFT",
  "priceValue": 6250,
  "priceCurrency": "CLP",
  "propertyType": "departamento",
  "bedrooms": 2,
  "bathrooms": 2,
  "parkingSpaces": 1,
  "storageUnits": 1,
  "totalAreaM2": 35.2,
  "usefulAreaM2": 33.4,
  "terraceAreaM2": 1.8,
  "commonExpenses": 120000,
  "yearBuilt": 2015,
  "lat": -33.4072,
  "lng": -70.5681,
  "addressLine": "Av. Apoquindo 4501",
  "unitNumber": "1203",
  "commune": "Las Condes",
  "region": "Región Metropolitana",
  "reference": "A pasos del Metro Manquehue",
  "propertyRole": "123-45",
  "clubId": "clw2v8c4m0000u7w4mr9db4kn",
  "amenities": {
    "comfort": {
      "pool": true
    },
    "special": {
      "furnished": false
    }
  },
  "characteristics": {
    "orientation": "norte",
    "floorLevel": 12
  },
  "media": [
    {
      "id": "clw2v8c4m0001u7w4abcd1234",
      "url": "https://cdn.tu-crm.cl/propiedades/apt-123/principal.jpg",
      "type": "IMAGE",
      "sortOrder": 0,
      "altText": "Living comedor con vista al cerro"
    }
  ],
  "createdAt": "2026-10-05T14:03:00.000Z",
  "updatedAt": "2026-10-05T14:03:00.000Z"
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

idstringRequerido

externalIdstring | nullOpcional

Id en tu CRM (el externalId que enviaste).

sandboxbooleanRequerido

true si fue creada con una API key de prueba (nunca llega a portales reales).

titlestringRequerido

descriptionstring | nullOpcional

operationTypeOperationTypeRequerido

SALE = venta, RENT = arriendo.

"SALE""RENT"

Ver campos

OperationType

Valores: "SALE" "RENT"

SALE = venta, RENT = arriendo.

statusPropertyStatusRequerido

DRAFT: faltan datos o fotos. READY: lista para publicar. PUBLISHED: activa en al menos un portal. PAUSED / ARCHIVED.

"DRAFT""READY""PUBLISHED""PAUSED""ARCHIVED"

Ver campos

PropertyStatus

Valores: "DRAFT" "READY" "PUBLISHED" "PAUSED" "ARCHIVED"

DRAFT: faltan datos o fotos. READY: lista para publicar. PUBLISHED: activa en al menos un portal. PAUSED / ARCHIVED.

priceValuenumberRequerido

priceCurrencyPriceCurrencyRequerido

"CLP""UF"

Ver campos

PriceCurrency

Valores: "CLP" "UF"

propertyTypestring | nullOpcional

bedroomsnumber | nullOpcional

bathroomsnumber | nullOpcional

parkingSpacesnumber | nullOpcional

storageUnitsnumber | nullOpcional

totalAreaM2number | nullOpcional

usefulAreaM2number | nullOpcional

terraceAreaM2number | nullOpcional

commonExpensesnumber | nullOpcional

yearBuiltnumber | nullOpcional

latnumber | nullOpcional

lngnumber | nullOpcional

addressLinestring | nullOpcional

unitNumberstring | nullOpcional

communestring | nullOpcional

regionstring | nullOpcional

referencestring | nullOpcional

propertyRolestring | nullOpcional

clubIdstring | nullOpcional

amenitiesobjectRequerido

Amenidades guardadas, en el mismo formato que se envían.

characteristicsobjectRequerido

Características guardadas. Envíalas completas en el PATCH: el objeto se reemplaza entero.

mediaPublicPropertyMediaResponseDto[]Requerido

Ver campos del elemento

idstringRequerido

Id de la foto. Úsalo para editarla o eliminarla.

urlstringRequerido

typestringRequerido

sortOrdernumberRequerido

altTextstring | nullOpcional

createdAtstringRequerido

updatedAtstringRequerido

Falta el header x-api-key, o la key es inválida o fue revocada.

JSON

{
  "error": {
    "code": "unauthorized",
    "message": "API key inválida o revocada",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

La key no tiene el scope requerido, o el plan/la suscripción de la corredora no lo permite.

JSON

{
  "error": {
    "code": "forbidden",
    "message": "La API key no tiene el scope requerido: properties:read",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

El recurso no existe o pertenece a otra corredora / otro modo (prueba vs producción).

JSON

{
  "error": {
    "code": "not_found",
    "message": "La propiedad no existe o no pertenece a esta API key",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Superaste el rate limit; espera los segundos del header Retry-After.

JSON

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Superaste el límite de requests de la API pública; reintenta después de Retry-After segundos",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Retry-AfterintegerOpcional

Segundos a esperar antes de reintentar.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Actualizar una propiedad

PATCH/v1/properties/{id}

Actualiza solo los campos enviados. Si characteristics viene, reemplaza el objeto completo (la clave external se conserva). Si la propiedad está publicada, los portales donde está activa se actualizan solos. Scope requerido: properties:write.

API key requerida x-api-keyVer autenticación →

Parámetros de ruta

idstringRequerido

Identificador del recurso, devuelto al crearlo o listarlo.

Cuerpo de la solicitud

application/json

titlestringOpcional

Título del aviso. Yapo exige al menos 10 caracteres; TocToc entre 10 y 70.

descriptionstringOpcional

Descripción del aviso en texto plano (si llega HTML se convierte a texto). TocToc exige al menos 50 caracteres.

operationTypeOperationTypeOpcional

SALE = venta, RENT = arriendo.

"SALE""RENT"

Ver campos

OperationType

Valores: "SALE" "RENT"

SALE = venta, RENT = arriendo.

priceValuenumberOpcional

Precio como entero. Los precios en UF también van como entero.

mín. 0

priceCurrencyPriceCurrencyOpcional

"CLP""UF"

Ver campos

PriceCurrency

Valores: "CLP" "UF"

propertyTypestringOpcional

Tipo de propiedad: departamento, casa, oficina, local, terreno, parcela, bodega, estacionamiento.

bedroomsnumberOpcional

Dormitorios.

mín. 0

bathroomsnumberOpcional

Baños.

mín. 0

parkingSpacesnumberOpcional

Estacionamientos.

mín. 0

storageUnitsnumberOpcional

Bodegas.

mín. 0

totalAreaM2numberOpcional

Superficie total en m². En casas, parcelas y terrenos es la superficie del terreno. Admite decimales.

mín. 0

usefulAreaM2numberOpcional

Superficie útil en m². Yapo y TocToc la publican como superficie construida; si falta, Yapo usa la superficie total. Admite decimales.

mín. 0

terraceAreaM2numberOpcional

Superficie de terraza en m². Admite decimales.

mín. 0

commonExpensesnumber | nullOpcional

Gastos comunes mensuales en CLP. Omitirlos o enviar 0 significa "no informado": los portales no muestran gastos comunes. En PATCH, null borra el valor guardado.

yearBuiltnumberOpcional

Año de construcción.

latnumberOpcional

Latitud. Varios portales exigen la ubicación en el mapa.

lngnumberOpcional

Longitud.

addressLinestringOpcional

referencestringOpcional

Referencia de ubicación para el aviso.

propertyRolestringOpcional

Rol de avalúo (SII). TocToc lo lee.

unitNumberstringOpcional

Número de departamento u oficina.

communestringOpcional

Comuna, con tildes y ñ (ej. "Ñuñoa").

regionstringOpcional

amenitiesobjectOpcional

characteristicsobjectOpcional

Datos extra que algunos portales leen (orientation, floorLevel, videoTourUrl, contactName, contactPhone, contactEmail, ...). La clave "external" está reservada.

externalIdstringOpcional

Id estable de la propiedad en tu CRM.

PATCH/v1/properties/{id}

cURL

curl 'https://docs.tochihub.cl/v1/properties/%7Bid%7D' \
  --request PATCH \
  --header "x-api-key: $TOCHIHUB_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "Departamento 2D2B a pasos del Metro Manquehue",
  "description": "Departamento luminoso con estacionamiento y bodega, orientación norte.",
  "operationType": "SALE",
  "priceValue": 6250,
  "priceCurrency": "UF",
  "propertyType": "departamento",
  "bedrooms": 2,
  "bathrooms": 2,
  "parkingSpaces": 1,
  "storageUnits": 1,
  "totalAreaM2": 35.2,
  "usefulAreaM2": 33.4,
  "terraceAreaM2": 1.8,
  "commonExpenses": 120000,
  "yearBuilt": 2015,
  "lat": -33.4072,
  "lng": -70.5681,
  "addressLine": "Av. Apoquindo 4501",
  "reference": "A pasos del Metro Manquehue",
  "propertyRole": "123-45",
  "unitNumber": "1203",
  "commune": "Las Condes",
  "region": "Región Metropolitana",
  "amenities": {
    "comfort": {
      "pool": true,
      "gym": true
    },
    "security": {
      "elevator": true
    },
    "special": {
      "furnished": false
    }
  },
  "characteristics": {
    "orientation": "norte",
    "floorLevel": 12
  },
  "externalId": "crm-prop-12345"
}'

JavaScript

const response = await fetch("https://docs.tochihub.cl/v1/properties/%7Bid%7D", {
  method: "PATCH",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "title": "Departamento 2D2B a pasos del Metro Manquehue",
    "description": "Departamento luminoso con estacionamiento y bodega, orientación norte.",
    "operationType": "SALE",
    "priceValue": 6250,
    "priceCurrency": "UF",
    "propertyType": "departamento",
    "bedrooms": 2,
    "bathrooms": 2,
    "parkingSpaces": 1,
    "storageUnits": 1,
    "totalAreaM2": 35.2,
    "usefulAreaM2": 33.4,
    "terraceAreaM2": 1.8,
    "commonExpenses": 120000,
    "yearBuilt": 2015,
    "lat": -33.4072,
    "lng": -70.5681,
    "addressLine": "Av. Apoquindo 4501",
    "reference": "A pasos del Metro Manquehue",
    "propertyRole": "123-45",
    "unitNumber": "1203",
    "commune": "Las Condes",
    "region": "Región Metropolitana",
    "amenities": {
      "comfort": {
        "pool": true,
        "gym": true
      },
      "security": {
        "elevator": true
      },
      "special": {
        "furnished": false
      }
    },
    "characteristics": {
      "orientation": "norte",
      "floorLevel": 12
    },
    "externalId": "crm-prop-12345"
  }),
});

const data = await response.json();

Python

import os
import requests

response = requests.request(
    "PATCH",
    "https://docs.tochihub.cl/v1/properties/%7Bid%7D",
    headers={"x-api-key":os.environ["TOCHIHUB_API_KEY"],"Content-Type":"application/json"},
    json=__import__("json").loads("{\"title\":\"Departamento 2D2B a pasos del Metro Manquehue\",\"description\":\"Departamento luminoso con estacionamiento y bodega, orientación norte.\",\"operationType\":\"SALE\",\"priceValue\":6250,\"priceCurrency\":\"UF\",\"propertyType\":\"departamento\",\"bedrooms\":2,\"bathrooms\":2,\"parkingSpaces\":1,\"storageUnits\":1,\"totalAreaM2\":35.2,\"usefulAreaM2\":33.4,\"terraceAreaM2\":1.8,\"commonExpenses\":120000,\"yearBuilt\":2015,\"lat\":-33.4072,\"lng\":-70.5681,\"addressLine\":\"Av. Apoquindo 4501\",\"reference\":\"A pasos del Metro Manquehue\",\"propertyRole\":\"123-45\",\"unitNumber\":\"1203\",\"commune\":\"Las Condes\",\"region\":\"Región Metropolitana\",\"amenities\":{\"comfort\":{\"pool\":true,\"gym\":true},\"security\":{\"elevator\":true},\"special\":{\"furnished\":false}},\"characteristics\":{\"orientation\":\"norte\",\"floorLevel\":12},\"externalId\":\"crm-prop-12345\"}"),
    timeout=30,
)
print(response.json())

Respuestas

Solicitud completada.

JSON

{
  "id": "clw2v8c4m0000u7w4mr9db4kn",
  "externalId": "crm-prop-12345",
  "sandbox": false,
  "title": "Departamento 2D2B a pasos del Metro Manquehue",
  "description": null,
  "operationType": "SALE",
  "status": "DRAFT",
  "priceValue": 6250,
  "priceCurrency": "CLP",
  "propertyType": "departamento",
  "bedrooms": 2,
  "bathrooms": 2,
  "parkingSpaces": 1,
  "storageUnits": 1,
  "totalAreaM2": 35.2,
  "usefulAreaM2": 33.4,
  "terraceAreaM2": 1.8,
  "commonExpenses": 120000,
  "yearBuilt": 2015,
  "lat": -33.4072,
  "lng": -70.5681,
  "addressLine": "Av. Apoquindo 4501",
  "unitNumber": "1203",
  "commune": "Las Condes",
  "region": "Región Metropolitana",
  "reference": "A pasos del Metro Manquehue",
  "propertyRole": "123-45",
  "clubId": "clw2v8c4m0000u7w4mr9db4kn",
  "amenities": {
    "comfort": {
      "pool": true
    },
    "special": {
      "furnished": false
    }
  },
  "characteristics": {
    "orientation": "norte",
    "floorLevel": 12
  },
  "media": [
    {
      "id": "clw2v8c4m0001u7w4abcd1234",
      "url": "https://cdn.tu-crm.cl/propiedades/apt-123/principal.jpg",
      "type": "IMAGE",
      "sortOrder": 0,
      "altText": "Living comedor con vista al cerro"
    }
  ],
  "createdAt": "2026-10-05T14:03:00.000Z",
  "updatedAt": "2026-10-05T14:03:00.000Z"
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

idstringRequerido

externalIdstring | nullOpcional

Id en tu CRM (el externalId que enviaste).

sandboxbooleanRequerido

true si fue creada con una API key de prueba (nunca llega a portales reales).

titlestringRequerido

descriptionstring | nullOpcional

operationTypeOperationTypeRequerido

SALE = venta, RENT = arriendo.

"SALE""RENT"

Ver campos

OperationType

Valores: "SALE" "RENT"

SALE = venta, RENT = arriendo.

statusPropertyStatusRequerido

DRAFT: faltan datos o fotos. READY: lista para publicar. PUBLISHED: activa en al menos un portal. PAUSED / ARCHIVED.

"DRAFT""READY""PUBLISHED""PAUSED""ARCHIVED"

Ver campos

PropertyStatus

Valores: "DRAFT" "READY" "PUBLISHED" "PAUSED" "ARCHIVED"

DRAFT: faltan datos o fotos. READY: lista para publicar. PUBLISHED: activa en al menos un portal. PAUSED / ARCHIVED.

priceValuenumberRequerido

priceCurrencyPriceCurrencyRequerido

"CLP""UF"

Ver campos

PriceCurrency

Valores: "CLP" "UF"

propertyTypestring | nullOpcional

bedroomsnumber | nullOpcional

bathroomsnumber | nullOpcional

parkingSpacesnumber | nullOpcional

storageUnitsnumber | nullOpcional

totalAreaM2number | nullOpcional

usefulAreaM2number | nullOpcional

terraceAreaM2number | nullOpcional

commonExpensesnumber | nullOpcional

yearBuiltnumber | nullOpcional

latnumber | nullOpcional

lngnumber | nullOpcional

addressLinestring | nullOpcional

unitNumberstring | nullOpcional

communestring | nullOpcional

regionstring | nullOpcional

referencestring | nullOpcional

propertyRolestring | nullOpcional

clubIdstring | nullOpcional

amenitiesobjectRequerido

Amenidades guardadas, en el mismo formato que se envían.

characteristicsobjectRequerido

Características guardadas. Envíalas completas en el PATCH: el objeto se reemplaza entero.

mediaPublicPropertyMediaResponseDto[]Requerido

Ver campos del elemento

idstringRequerido

Id de la foto. Úsalo para editarla o eliminarla.

urlstringRequerido

typestringRequerido

sortOrdernumberRequerido

altTextstring | nullOpcional

createdAtstringRequerido

updatedAtstringRequerido

Body o parámetros inválidos; error.details lista los campos.

JSON

{
  "error": {
    "code": "bad_request",
    "message": "La validación del request falló",
    "details": [
      "title must be a string"
    ],
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Falta el header x-api-key, o la key es inválida o fue revocada.

JSON

{
  "error": {
    "code": "unauthorized",
    "message": "API key inválida o revocada",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

La key no tiene el scope requerido, o el plan/la suscripción de la corredora no lo permite.

JSON

{
  "error": {
    "code": "forbidden",
    "message": "La API key no tiene el scope requerido: properties:write",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

El recurso no existe o pertenece a otra corredora / otro modo (prueba vs producción).

JSON

{
  "error": {
    "code": "not_found",
    "message": "La propiedad no existe o no pertenece a esta API key",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Superaste el rate limit; espera los segundos del header Retry-After.

JSON

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Superaste el límite de requests de la API pública; reintenta después de Retry-After segundos",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Retry-AfterintegerOpcional

Segundos a esperar antes de reintentar.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Archivar (eliminar) una propiedad

DELETE/v1/properties/{id}

Archiva la propiedad: deja de aparecer como disponible y no se puede publicar. Antes debe estar despublicada de todos los portales (DELETE /v1/properties/{id}/publications/{portalCode} y esperar el webhook). Repetir la llamada sobre una propiedad ya archivada no hace nada. Emite PROPERTY_STATUS_CHANGED. Scope requerido: properties:write.

API key requerida x-api-keyVer autenticación →

Parámetros de ruta

idstringRequerido

Identificador del recurso, devuelto al crearlo o listarlo.

DELETE/v1/properties/{id}

cURL

curl 'https://docs.tochihub.cl/v1/properties/%7Bid%7D' \
  --request DELETE \
  --header "x-api-key: $TOCHIHUB_API_KEY"

JavaScript

const response = await fetch("https://docs.tochihub.cl/v1/properties/%7Bid%7D", {
  method: "DELETE",
  headers: {
    "x-api-key": "YOUR_API_KEY"
  },
});

const data = await response.json();

Python

import os
import requests

response = requests.request(
    "DELETE",
    "https://docs.tochihub.cl/v1/properties/%7Bid%7D",
    headers={"x-api-key":os.environ["TOCHIHUB_API_KEY"]},
    timeout=30,
)
print(response.json())

Respuestas

Solicitud completada.

JSON

{
  "id": "clw2v8c4m0000u7w4mr9db4kn",
  "externalId": "crm-prop-12345",
  "sandbox": false,
  "title": "Departamento 2D2B a pasos del Metro Manquehue",
  "description": null,
  "operationType": "SALE",
  "status": "DRAFT",
  "priceValue": 6250,
  "priceCurrency": "CLP",
  "propertyType": "departamento",
  "bedrooms": 2,
  "bathrooms": 2,
  "parkingSpaces": 1,
  "storageUnits": 1,
  "totalAreaM2": 35.2,
  "usefulAreaM2": 33.4,
  "terraceAreaM2": 1.8,
  "commonExpenses": 120000,
  "yearBuilt": 2015,
  "lat": -33.4072,
  "lng": -70.5681,
  "addressLine": "Av. Apoquindo 4501",
  "unitNumber": "1203",
  "commune": "Las Condes",
  "region": "Región Metropolitana",
  "reference": "A pasos del Metro Manquehue",
  "propertyRole": "123-45",
  "clubId": "clw2v8c4m0000u7w4mr9db4kn",
  "amenities": {
    "comfort": {
      "pool": true
    },
    "special": {
      "furnished": false
    }
  },
  "characteristics": {
    "orientation": "norte",
    "floorLevel": 12
  },
  "media": [
    {
      "id": "clw2v8c4m0001u7w4abcd1234",
      "url": "https://cdn.tu-crm.cl/propiedades/apt-123/principal.jpg",
      "type": "IMAGE",
      "sortOrder": 0,
      "altText": "Living comedor con vista al cerro"
    }
  ],
  "createdAt": "2026-10-05T14:03:00.000Z",
  "updatedAt": "2026-10-05T14:03:00.000Z"
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

idstringRequerido

externalIdstring | nullOpcional

Id en tu CRM (el externalId que enviaste).

sandboxbooleanRequerido

true si fue creada con una API key de prueba (nunca llega a portales reales).

titlestringRequerido

descriptionstring | nullOpcional

operationTypeOperationTypeRequerido

SALE = venta, RENT = arriendo.

"SALE""RENT"

Ver campos

OperationType

Valores: "SALE" "RENT"

SALE = venta, RENT = arriendo.

statusPropertyStatusRequerido

DRAFT: faltan datos o fotos. READY: lista para publicar. PUBLISHED: activa en al menos un portal. PAUSED / ARCHIVED.

"DRAFT""READY""PUBLISHED""PAUSED""ARCHIVED"

Ver campos

PropertyStatus

Valores: "DRAFT" "READY" "PUBLISHED" "PAUSED" "ARCHIVED"

DRAFT: faltan datos o fotos. READY: lista para publicar. PUBLISHED: activa en al menos un portal. PAUSED / ARCHIVED.

priceValuenumberRequerido

priceCurrencyPriceCurrencyRequerido

"CLP""UF"

Ver campos

PriceCurrency

Valores: "CLP" "UF"

propertyTypestring | nullOpcional

bedroomsnumber | nullOpcional

bathroomsnumber | nullOpcional

parkingSpacesnumber | nullOpcional

storageUnitsnumber | nullOpcional

totalAreaM2number | nullOpcional

usefulAreaM2number | nullOpcional

terraceAreaM2number | nullOpcional

commonExpensesnumber | nullOpcional

yearBuiltnumber | nullOpcional

latnumber | nullOpcional

lngnumber | nullOpcional

addressLinestring | nullOpcional

unitNumberstring | nullOpcional

communestring | nullOpcional

regionstring | nullOpcional

referencestring | nullOpcional

propertyRolestring | nullOpcional

clubIdstring | nullOpcional

amenitiesobjectRequerido

Amenidades guardadas, en el mismo formato que se envían.

characteristicsobjectRequerido

Características guardadas. Envíalas completas en el PATCH: el objeto se reemplaza entero.

mediaPublicPropertyMediaResponseDto[]Requerido

Ver campos del elemento

idstringRequerido

Id de la foto. Úsalo para editarla o eliminarla.

urlstringRequerido

typestringRequerido

sortOrdernumberRequerido

altTextstring | nullOpcional

createdAtstringRequerido

updatedAtstringRequerido

Body o parámetros inválidos; error.details lista los campos.

JSON

{
  "error": {
    "code": "bad_request",
    "message": "La validación del request falló",
    "details": [
      "title must be a string"
    ],
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Falta el header x-api-key, o la key es inválida o fue revocada.

JSON

{
  "error": {
    "code": "unauthorized",
    "message": "API key inválida o revocada",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

La key no tiene el scope requerido, o el plan/la suscripción de la corredora no lo permite.

JSON

{
  "error": {
    "code": "forbidden",
    "message": "La API key no tiene el scope requerido: properties:write",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

El recurso no existe o pertenece a otra corredora / otro modo (prueba vs producción).

JSON

{
  "error": {
    "code": "not_found",
    "message": "La propiedad no existe o no pertenece a esta API key",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Superaste el rate limit; espera los segundos del header Retry-After.

JSON

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Superaste el límite de requests de la API pública; reintenta después de Retry-After segundos",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Retry-AfterintegerOpcional

Segundos a esperar antes de reintentar.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Estadísticas por portal

GET/v1/properties/{id}/metrics

Último dato de visitas, contactos y clics de cada portal donde la propiedad tiene estadísticas, más los totales. Los valores son acumulados del aviso y se actualizan cuando TochiHub sincroniza con cada portal (ver sync en GET /v1/portals). Las propiedades sandbox no tienen estadísticas. Scope requerido: properties:read.

API key requerida x-api-keyVer autenticación →

Parámetros de ruta

idstringRequerido

Identificador del recurso, devuelto al crearlo o listarlo.

GET/v1/properties/{id}/metrics

cURL

curl 'https://docs.tochihub.cl/v1/properties/%7Bid%7D/metrics' \
  --header "x-api-key: $TOCHIHUB_API_KEY"

JavaScript

const response = await fetch("https://docs.tochihub.cl/v1/properties/%7Bid%7D/metrics", {
  method: "GET",
  headers: {
    "x-api-key": "YOUR_API_KEY"
  },
});

const data = await response.json();

Python

import os
import requests

response = requests.request(
    "GET",
    "https://docs.tochihub.cl/v1/properties/%7Bid%7D/metrics",
    headers={"x-api-key":os.environ["TOCHIHUB_API_KEY"]},
    timeout=30,
)
print(response.json())

Respuestas

Solicitud completada.

JSON

{
  "propertyId": "clw2v8c4m0000u7w4mr9db4kn",
  "externalId": "crm-prop-12345",
  "totals": {
    "views": 1890,
    "contacts": 21,
    "clicks": 140
  },
  "portals": [
    {
      "portalCode": "MERCADO_LIBRE",
      "portalName": "Mercado Libre",
      "views": 1240,
      "contacts": 12,
      "clicks": 80,
      "sharedViewsWith": [
        "PORTAL_INMOBILIARIO"
      ],
      "measuredAt": "2026-10-10T06:00:00.000Z"
    },
    {
      "portalCode": "PORTAL_INMOBILIARIO",
      "portalName": "Portal Inmobiliario",
      "views": 1240,
      "contacts": 6,
      "clicks": 45,
      "sharedViewsWith": [
        "MERCADO_LIBRE"
      ],
      "measuredAt": "2026-10-10T06:00:00.000Z"
    },
    {
      "portalCode": "TOCTOC",
      "portalName": "TocToc",
      "views": 650,
      "contacts": 3,
      "clicks": 15,
      "sharedViewsWith": [],
      "measuredAt": "2026-10-10T06:00:00.000Z"
    }
  ]
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

propertyIdstringRequerido

externalIdstring | nullOpcional

totalsPublicPropertyMetricsTotalsDtoRequerido

Ver campos

viewsnumberRequerido

Suma de visitas. Un aviso compartido entre Mercado Libre y Portal Inmobiliario se cuenta una sola vez.

contactsnumberRequerido

Suma de contactos de todos los portales.

clicksnumberRequerido

Suma de clics de todos los portales.

portalsPublicPortalMetricsDto[]Requerido

Último dato por portal. Un portal sin estadísticas no aparece.

Ver campos del elemento

portalCodePortalCodeRequerido

"MERCADO_LIBRE""PORTAL_INMOBILIARIO""YAPO""TOCTOC""ENLACE_INMOBILIARIO""CHILE_DEPTOS""DOOMOS""PROPPIT""INSTAGRAM""FACEBOOK_MARKETPLACE""META_ADS""TIKTOK_ADS""TIKTOK"

Ver campos

PortalCode

Valores: "MERCADO_LIBRE" "PORTAL_INMOBILIARIO" "YAPO" "TOCTOC" "ENLACE_INMOBILIARIO" "CHILE_DEPTOS" "DOOMOS" "PROPPIT" "INSTAGRAM" "FACEBOOK_MARKETPLACE" "META_ADS" "TIKTOK_ADS" "TIKTOK"

portalNamestringRequerido

viewsnumber | nullOpcional

Visitas acumuladas del aviso. null = el portal no la informa.

contactsnumber | nullOpcional

Contactos acumulados. null = el portal no lo informa.

clicksnumber | nullOpcional

Clics acumulados. null = el portal no lo informa.

sharedViewsWithPortalCode[]Requerido

Portales que muestran este mismo aviso y comparten su contador de visitas (Mercado Libre y Portal Inmobiliario publican un único aviso). Cada portal informa el mismo valor de views, pero totals.views lo suma una sola vez. Vacío si el aviso no se comparte.

measuredAtstringRequerido

Momento en que se leyó este dato del portal.

Falta el header x-api-key, o la key es inválida o fue revocada.

JSON

{
  "error": {
    "code": "unauthorized",
    "message": "API key inválida o revocada",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

La key no tiene el scope requerido, o el plan/la suscripción de la corredora no lo permite.

JSON

{
  "error": {
    "code": "forbidden",
    "message": "La API key no tiene el scope requerido: properties:read",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

El recurso no existe o pertenece a otra corredora / otro modo (prueba vs producción).

JSON

{
  "error": {
    "code": "not_found",
    "message": "La propiedad no existe o no pertenece a esta API key",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Superaste el rate limit; espera los segundos del header Retry-After.

JSON

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Superaste el límite de requests de la API pública; reintenta después de Retry-After segundos",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Retry-AfterintegerOpcional

Segundos a esperar antes de reintentar.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Agregar fotos

POST/v1/properties/{id}/media

Agrega fotos por URL pública al final de la galería (o en el sortOrder indicado). Recalcula el estado y sincroniza los portales activos. Scope requerido: properties:write.

API key requerida x-api-keyVer autenticación →

Parámetros de ruta

idstringRequerido

Identificador del recurso, devuelto al crearlo o listarlo.

Cuerpo de la solicitud

application/json

mediaCreatePublicPropertyMediaDto[]Requerido

1 elementos mín.30 elementos máx.

Ver campos del elemento

typePropertyMediaTypeOpcional

Tipo de archivo. Solo las IMAGE cuentan para el mínimo de 3 fotos.

Por defecto: "IMAGE"

"IMAGE""VIDEO""TOUR_360""DOCUMENT"

Ver campos

PropertyMediaType

Valores: "IMAGE" "VIDEO" "TOUR_360" "DOCUMENT"

Tipo de archivo. Solo las IMAGE cuentan para el mínimo de 3 fotos.

urlstringRequerido

URL pública (HTTPS) de la foto. Los portales la descargan tal cual: debe ser accesible sin autenticación.

sortOrdernumberOpcional

Orden de la foto; la de menor orden es la portada.

mín. 0

altTextstringOpcional

POST/v1/properties/{id}/media

cURL

curl 'https://docs.tochihub.cl/v1/properties/%7Bid%7D/media' \
  --request POST \
  --header "x-api-key: $TOCHIHUB_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "media": [
    {
      "type": "IMAGE",
      "url": "https://cdn.tu-crm.cl/propiedades/apt-123/principal.jpg",
      "sortOrder": 0,
      "altText": "Living comedor con vista al cerro"
    }
  ]
}'

JavaScript

const response = await fetch("https://docs.tochihub.cl/v1/properties/%7Bid%7D/media", {
  method: "POST",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "media": [
      {
        "type": "IMAGE",
        "url": "https://cdn.tu-crm.cl/propiedades/apt-123/principal.jpg",
        "sortOrder": 0,
        "altText": "Living comedor con vista al cerro"
      }
    ]
  }),
});

const data = await response.json();

Python

import os
import requests

response = requests.request(
    "POST",
    "https://docs.tochihub.cl/v1/properties/%7Bid%7D/media",
    headers={"x-api-key":os.environ["TOCHIHUB_API_KEY"],"Content-Type":"application/json"},
    json=__import__("json").loads("{\"media\":[{\"type\":\"IMAGE\",\"url\":\"https://cdn.tu-crm.cl/propiedades/apt-123/principal.jpg\",\"sortOrder\":0,\"altText\":\"Living comedor con vista al cerro\"}]}"),
    timeout=30,
)
print(response.json())

Respuestas

Solicitud completada.

JSON

{
  "id": "clw2v8c4m0000u7w4mr9db4kn",
  "externalId": "crm-prop-12345",
  "sandbox": false,
  "title": "Departamento 2D2B a pasos del Metro Manquehue",
  "description": null,
  "operationType": "SALE",
  "status": "DRAFT",
  "priceValue": 6250,
  "priceCurrency": "CLP",
  "propertyType": "departamento",
  "bedrooms": 2,
  "bathrooms": 2,
  "parkingSpaces": 1,
  "storageUnits": 1,
  "totalAreaM2": 35.2,
  "usefulAreaM2": 33.4,
  "terraceAreaM2": 1.8,
  "commonExpenses": 120000,
  "yearBuilt": 2015,
  "lat": -33.4072,
  "lng": -70.5681,
  "addressLine": "Av. Apoquindo 4501",
  "unitNumber": "1203",
  "commune": "Las Condes",
  "region": "Región Metropolitana",
  "reference": "A pasos del Metro Manquehue",
  "propertyRole": "123-45",
  "clubId": "clw2v8c4m0000u7w4mr9db4kn",
  "amenities": {
    "comfort": {
      "pool": true
    },
    "special": {
      "furnished": false
    }
  },
  "characteristics": {
    "orientation": "norte",
    "floorLevel": 12
  },
  "media": [
    {
      "id": "clw2v8c4m0001u7w4abcd1234",
      "url": "https://cdn.tu-crm.cl/propiedades/apt-123/principal.jpg",
      "type": "IMAGE",
      "sortOrder": 0,
      "altText": "Living comedor con vista al cerro"
    }
  ],
  "createdAt": "2026-10-05T14:03:00.000Z",
  "updatedAt": "2026-10-05T14:03:00.000Z"
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

idstringRequerido

externalIdstring | nullOpcional

Id en tu CRM (el externalId que enviaste).

sandboxbooleanRequerido

true si fue creada con una API key de prueba (nunca llega a portales reales).

titlestringRequerido

descriptionstring | nullOpcional

operationTypeOperationTypeRequerido

SALE = venta, RENT = arriendo.

"SALE""RENT"

Ver campos

OperationType

Valores: "SALE" "RENT"

SALE = venta, RENT = arriendo.

statusPropertyStatusRequerido

DRAFT: faltan datos o fotos. READY: lista para publicar. PUBLISHED: activa en al menos un portal. PAUSED / ARCHIVED.

"DRAFT""READY""PUBLISHED""PAUSED""ARCHIVED"

Ver campos

PropertyStatus

Valores: "DRAFT" "READY" "PUBLISHED" "PAUSED" "ARCHIVED"

DRAFT: faltan datos o fotos. READY: lista para publicar. PUBLISHED: activa en al menos un portal. PAUSED / ARCHIVED.

priceValuenumberRequerido

priceCurrencyPriceCurrencyRequerido

"CLP""UF"

Ver campos

PriceCurrency

Valores: "CLP" "UF"

propertyTypestring | nullOpcional

bedroomsnumber | nullOpcional

bathroomsnumber | nullOpcional

parkingSpacesnumber | nullOpcional

storageUnitsnumber | nullOpcional

totalAreaM2number | nullOpcional

usefulAreaM2number | nullOpcional

terraceAreaM2number | nullOpcional

commonExpensesnumber | nullOpcional

yearBuiltnumber | nullOpcional

latnumber | nullOpcional

lngnumber | nullOpcional

addressLinestring | nullOpcional

unitNumberstring | nullOpcional

communestring | nullOpcional

regionstring | nullOpcional

referencestring | nullOpcional

propertyRolestring | nullOpcional

clubIdstring | nullOpcional

amenitiesobjectRequerido

Amenidades guardadas, en el mismo formato que se envían.

characteristicsobjectRequerido

Características guardadas. Envíalas completas en el PATCH: el objeto se reemplaza entero.

mediaPublicPropertyMediaResponseDto[]Requerido

Ver campos del elemento

idstringRequerido

Id de la foto. Úsalo para editarla o eliminarla.

urlstringRequerido

typestringRequerido

sortOrdernumberRequerido

altTextstring | nullOpcional

createdAtstringRequerido

updatedAtstringRequerido

Body o parámetros inválidos; error.details lista los campos.

JSON

{
  "error": {
    "code": "bad_request",
    "message": "La validación del request falló",
    "details": [
      "title must be a string"
    ],
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Falta el header x-api-key, o la key es inválida o fue revocada.

JSON

{
  "error": {
    "code": "unauthorized",
    "message": "API key inválida o revocada",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

La key no tiene el scope requerido, o el plan/la suscripción de la corredora no lo permite.

JSON

{
  "error": {
    "code": "forbidden",
    "message": "La API key no tiene el scope requerido: properties:write",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

El recurso no existe o pertenece a otra corredora / otro modo (prueba vs producción).

JSON

{
  "error": {
    "code": "not_found",
    "message": "La propiedad no existe o no pertenece a esta API key",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Superaste el rate limit; espera los segundos del header Retry-After.

JSON

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Superaste el límite de requests de la API pública; reintenta después de Retry-After segundos",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Retry-AfterintegerOpcional

Segundos a esperar antes de reintentar.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Pausar una propiedad publicada

POST/v1/properties/{id}/pause

Retira los avisos activos de todos los portales y deja la propiedad en PAUSED (Mercado Libre y Portal Inmobiliario quedan pausados, no cerrados). Solo aplica a propiedades PUBLISHED. Emite PROPERTY_STATUS_CHANGED. Scope requerido: properties:write.

API key requerida x-api-keyVer autenticación →

Parámetros de ruta

idstringRequerido

Identificador del recurso, devuelto al crearlo o listarlo.

POST/v1/properties/{id}/pause

cURL

curl 'https://docs.tochihub.cl/v1/properties/%7Bid%7D/pause' \
  --request POST \
  --header "x-api-key: $TOCHIHUB_API_KEY"

JavaScript

const response = await fetch("https://docs.tochihub.cl/v1/properties/%7Bid%7D/pause", {
  method: "POST",
  headers: {
    "x-api-key": "YOUR_API_KEY"
  },
});

const data = await response.json();

Python

import os
import requests

response = requests.request(
    "POST",
    "https://docs.tochihub.cl/v1/properties/%7Bid%7D/pause",
    headers={"x-api-key":os.environ["TOCHIHUB_API_KEY"]},
    timeout=30,
)
print(response.json())

Respuestas

Solicitud completada.

JSON

{
  "id": "clw2v8c4m0000u7w4mr9db4kn",
  "externalId": "crm-prop-12345",
  "sandbox": false,
  "title": "Departamento 2D2B a pasos del Metro Manquehue",
  "description": null,
  "operationType": "SALE",
  "status": "DRAFT",
  "priceValue": 6250,
  "priceCurrency": "CLP",
  "propertyType": "departamento",
  "bedrooms": 2,
  "bathrooms": 2,
  "parkingSpaces": 1,
  "storageUnits": 1,
  "totalAreaM2": 35.2,
  "usefulAreaM2": 33.4,
  "terraceAreaM2": 1.8,
  "commonExpenses": 120000,
  "yearBuilt": 2015,
  "lat": -33.4072,
  "lng": -70.5681,
  "addressLine": "Av. Apoquindo 4501",
  "unitNumber": "1203",
  "commune": "Las Condes",
  "region": "Región Metropolitana",
  "reference": "A pasos del Metro Manquehue",
  "propertyRole": "123-45",
  "clubId": "clw2v8c4m0000u7w4mr9db4kn",
  "amenities": {
    "comfort": {
      "pool": true
    },
    "special": {
      "furnished": false
    }
  },
  "characteristics": {
    "orientation": "norte",
    "floorLevel": 12
  },
  "media": [
    {
      "id": "clw2v8c4m0001u7w4abcd1234",
      "url": "https://cdn.tu-crm.cl/propiedades/apt-123/principal.jpg",
      "type": "IMAGE",
      "sortOrder": 0,
      "altText": "Living comedor con vista al cerro"
    }
  ],
  "createdAt": "2026-10-05T14:03:00.000Z",
  "updatedAt": "2026-10-05T14:03:00.000Z"
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

idstringRequerido

externalIdstring | nullOpcional

Id en tu CRM (el externalId que enviaste).

sandboxbooleanRequerido

true si fue creada con una API key de prueba (nunca llega a portales reales).

titlestringRequerido

descriptionstring | nullOpcional

operationTypeOperationTypeRequerido

SALE = venta, RENT = arriendo.

"SALE""RENT"

Ver campos

OperationType

Valores: "SALE" "RENT"

SALE = venta, RENT = arriendo.

statusPropertyStatusRequerido

DRAFT: faltan datos o fotos. READY: lista para publicar. PUBLISHED: activa en al menos un portal. PAUSED / ARCHIVED.

"DRAFT""READY""PUBLISHED""PAUSED""ARCHIVED"

Ver campos

PropertyStatus

Valores: "DRAFT" "READY" "PUBLISHED" "PAUSED" "ARCHIVED"

DRAFT: faltan datos o fotos. READY: lista para publicar. PUBLISHED: activa en al menos un portal. PAUSED / ARCHIVED.

priceValuenumberRequerido

priceCurrencyPriceCurrencyRequerido

"CLP""UF"

Ver campos

PriceCurrency

Valores: "CLP" "UF"

propertyTypestring | nullOpcional

bedroomsnumber | nullOpcional

bathroomsnumber | nullOpcional

parkingSpacesnumber | nullOpcional

storageUnitsnumber | nullOpcional

totalAreaM2number | nullOpcional

usefulAreaM2number | nullOpcional

terraceAreaM2number | nullOpcional

commonExpensesnumber | nullOpcional

yearBuiltnumber | nullOpcional

latnumber | nullOpcional

lngnumber | nullOpcional

addressLinestring | nullOpcional

unitNumberstring | nullOpcional

communestring | nullOpcional

regionstring | nullOpcional

referencestring | nullOpcional

propertyRolestring | nullOpcional

clubIdstring | nullOpcional

amenitiesobjectRequerido

Amenidades guardadas, en el mismo formato que se envían.

characteristicsobjectRequerido

Características guardadas. Envíalas completas en el PATCH: el objeto se reemplaza entero.

mediaPublicPropertyMediaResponseDto[]Requerido

Ver campos del elemento

idstringRequerido

Id de la foto. Úsalo para editarla o eliminarla.

urlstringRequerido

typestringRequerido

sortOrdernumberRequerido

altTextstring | nullOpcional

createdAtstringRequerido

updatedAtstringRequerido

Body o parámetros inválidos; error.details lista los campos.

JSON

{
  "error": {
    "code": "bad_request",
    "message": "La validación del request falló",
    "details": [
      "title must be a string"
    ],
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Falta el header x-api-key, o la key es inválida o fue revocada.

JSON

{
  "error": {
    "code": "unauthorized",
    "message": "API key inválida o revocada",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

La key no tiene el scope requerido, o el plan/la suscripción de la corredora no lo permite.

JSON

{
  "error": {
    "code": "forbidden",
    "message": "La API key no tiene el scope requerido: properties:write",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

El recurso no existe o pertenece a otra corredora / otro modo (prueba vs producción).

JSON

{
  "error": {
    "code": "not_found",
    "message": "La propiedad no existe o no pertenece a esta API key",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Superaste el rate limit; espera los segundos del header Retry-After.

JSON

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Superaste el límite de requests de la API pública; reintenta después de Retry-After segundos",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Retry-AfterintegerOpcional

Segundos a esperar antes de reintentar.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Reanudar una propiedad pausada

POST/v1/properties/{id}/resume

Vuelve a publicar en los portales donde estaba publicada al pausarse. Solo aplica a propiedades PAUSED con al menos 3 fotos. Si un portal no está listo (credenciales, datos o cupo), se omite y la propiedad se reanuda en los demás; revisa el estado por portal en la respuesta. Si ningún portal puede reanudarse, responde 400 y la propiedad sigue PAUSED. Emite PROPERTY_STATUS_CHANGED. Scope requerido: properties:write.

API key requerida x-api-keyVer autenticación →

Parámetros de ruta

idstringRequerido

Identificador del recurso, devuelto al crearlo o listarlo.

POST/v1/properties/{id}/resume

cURL

curl 'https://docs.tochihub.cl/v1/properties/%7Bid%7D/resume' \
  --request POST \
  --header "x-api-key: $TOCHIHUB_API_KEY"

JavaScript

const response = await fetch("https://docs.tochihub.cl/v1/properties/%7Bid%7D/resume", {
  method: "POST",
  headers: {
    "x-api-key": "YOUR_API_KEY"
  },
});

const data = await response.json();

Python

import os
import requests

response = requests.request(
    "POST",
    "https://docs.tochihub.cl/v1/properties/%7Bid%7D/resume",
    headers={"x-api-key":os.environ["TOCHIHUB_API_KEY"]},
    timeout=30,
)
print(response.json())

Respuestas

Solicitud completada.

JSON

{
  "id": "clw2v8c4m0000u7w4mr9db4kn",
  "externalId": "crm-prop-12345",
  "sandbox": false,
  "title": "Departamento 2D2B a pasos del Metro Manquehue",
  "description": null,
  "operationType": "SALE",
  "status": "DRAFT",
  "priceValue": 6250,
  "priceCurrency": "CLP",
  "propertyType": "departamento",
  "bedrooms": 2,
  "bathrooms": 2,
  "parkingSpaces": 1,
  "storageUnits": 1,
  "totalAreaM2": 35.2,
  "usefulAreaM2": 33.4,
  "terraceAreaM2": 1.8,
  "commonExpenses": 120000,
  "yearBuilt": 2015,
  "lat": -33.4072,
  "lng": -70.5681,
  "addressLine": "Av. Apoquindo 4501",
  "unitNumber": "1203",
  "commune": "Las Condes",
  "region": "Región Metropolitana",
  "reference": "A pasos del Metro Manquehue",
  "propertyRole": "123-45",
  "clubId": "clw2v8c4m0000u7w4mr9db4kn",
  "amenities": {
    "comfort": {
      "pool": true
    },
    "special": {
      "furnished": false
    }
  },
  "characteristics": {
    "orientation": "norte",
    "floorLevel": 12
  },
  "media": [
    {
      "id": "clw2v8c4m0001u7w4abcd1234",
      "url": "https://cdn.tu-crm.cl/propiedades/apt-123/principal.jpg",
      "type": "IMAGE",
      "sortOrder": 0,
      "altText": "Living comedor con vista al cerro"
    }
  ],
  "createdAt": "2026-10-05T14:03:00.000Z",
  "updatedAt": "2026-10-05T14:03:00.000Z"
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

idstringRequerido

externalIdstring | nullOpcional

Id en tu CRM (el externalId que enviaste).

sandboxbooleanRequerido

true si fue creada con una API key de prueba (nunca llega a portales reales).

titlestringRequerido

descriptionstring | nullOpcional

operationTypeOperationTypeRequerido

SALE = venta, RENT = arriendo.

"SALE""RENT"

Ver campos

OperationType

Valores: "SALE" "RENT"

SALE = venta, RENT = arriendo.

statusPropertyStatusRequerido

DRAFT: faltan datos o fotos. READY: lista para publicar. PUBLISHED: activa en al menos un portal. PAUSED / ARCHIVED.

"DRAFT""READY""PUBLISHED""PAUSED""ARCHIVED"

Ver campos

PropertyStatus

Valores: "DRAFT" "READY" "PUBLISHED" "PAUSED" "ARCHIVED"

DRAFT: faltan datos o fotos. READY: lista para publicar. PUBLISHED: activa en al menos un portal. PAUSED / ARCHIVED.

priceValuenumberRequerido

priceCurrencyPriceCurrencyRequerido

"CLP""UF"

Ver campos

PriceCurrency

Valores: "CLP" "UF"

propertyTypestring | nullOpcional

bedroomsnumber | nullOpcional

bathroomsnumber | nullOpcional

parkingSpacesnumber | nullOpcional

storageUnitsnumber | nullOpcional

totalAreaM2number | nullOpcional

usefulAreaM2number | nullOpcional

terraceAreaM2number | nullOpcional

commonExpensesnumber | nullOpcional

yearBuiltnumber | nullOpcional

latnumber | nullOpcional

lngnumber | nullOpcional

addressLinestring | nullOpcional

unitNumberstring | nullOpcional

communestring | nullOpcional

regionstring | nullOpcional

referencestring | nullOpcional

propertyRolestring | nullOpcional

clubIdstring | nullOpcional

amenitiesobjectRequerido

Amenidades guardadas, en el mismo formato que se envían.

characteristicsobjectRequerido

Características guardadas. Envíalas completas en el PATCH: el objeto se reemplaza entero.

mediaPublicPropertyMediaResponseDto[]Requerido

Ver campos del elemento

idstringRequerido

Id de la foto. Úsalo para editarla o eliminarla.

urlstringRequerido

typestringRequerido

sortOrdernumberRequerido

altTextstring | nullOpcional

createdAtstringRequerido

updatedAtstringRequerido

Body o parámetros inválidos; error.details lista los campos.

JSON

{
  "error": {
    "code": "bad_request",
    "message": "La validación del request falló",
    "details": [
      "title must be a string"
    ],
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Falta el header x-api-key, o la key es inválida o fue revocada.

JSON

{
  "error": {
    "code": "unauthorized",
    "message": "API key inválida o revocada",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

La key no tiene el scope requerido, o el plan/la suscripción de la corredora no lo permite.

JSON

{
  "error": {
    "code": "forbidden",
    "message": "La API key no tiene el scope requerido: properties:write",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

El recurso no existe o pertenece a otra corredora / otro modo (prueba vs producción).

JSON

{
  "error": {
    "code": "not_found",
    "message": "La propiedad no existe o no pertenece a esta API key",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Superaste el rate limit; espera los segundos del header Retry-After.

JSON

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Superaste el límite de requests de la API pública; reintenta después de Retry-After segundos",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Retry-AfterintegerOpcional

Segundos a esperar antes de reintentar.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Editar una foto

PATCH/v1/properties/{id}/media/{mediaId}

Cambia el orden (sortOrder) o el texto alternativo de una foto. El id viene en media[].id del detalle. Sincroniza los portales activos y emite PROPERTY_UPDATED. Scope requerido: properties:write.

API key requerida x-api-keyVer autenticación →

Parámetros de ruta

idstringRequerido

Identificador del recurso, devuelto al crearlo o listarlo.

mediaIdstringRequerido

Identificador del recurso, devuelto al crearlo o listarlo.

Cuerpo de la solicitud

application/json

sortOrdernumberOpcional

Nuevo orden; la de menor orden es la portada.

mín. 0

altTextstringOpcional

PATCH/v1/properties/{id}/media/{mediaId}

cURL

curl 'https://docs.tochihub.cl/v1/properties/%7Bid%7D/media/%7BmediaId%7D' \
  --request PATCH \
  --header "x-api-key: $TOCHIHUB_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "sortOrder": 0,
  "altText": "Living comedor con vista al cerro"
}'

JavaScript

const response = await fetch("https://docs.tochihub.cl/v1/properties/%7Bid%7D/media/%7BmediaId%7D", {
  method: "PATCH",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "sortOrder": 0,
    "altText": "Living comedor con vista al cerro"
  }),
});

const data = await response.json();

Python

import os
import requests

response = requests.request(
    "PATCH",
    "https://docs.tochihub.cl/v1/properties/%7Bid%7D/media/%7BmediaId%7D",
    headers={"x-api-key":os.environ["TOCHIHUB_API_KEY"],"Content-Type":"application/json"},
    json=__import__("json").loads("{\"sortOrder\":0,\"altText\":\"Living comedor con vista al cerro\"}"),
    timeout=30,
)
print(response.json())

Respuestas

Solicitud completada.

JSON

{
  "id": "clw2v8c4m0000u7w4mr9db4kn",
  "externalId": "crm-prop-12345",
  "sandbox": false,
  "title": "Departamento 2D2B a pasos del Metro Manquehue",
  "description": null,
  "operationType": "SALE",
  "status": "DRAFT",
  "priceValue": 6250,
  "priceCurrency": "CLP",
  "propertyType": "departamento",
  "bedrooms": 2,
  "bathrooms": 2,
  "parkingSpaces": 1,
  "storageUnits": 1,
  "totalAreaM2": 35.2,
  "usefulAreaM2": 33.4,
  "terraceAreaM2": 1.8,
  "commonExpenses": 120000,
  "yearBuilt": 2015,
  "lat": -33.4072,
  "lng": -70.5681,
  "addressLine": "Av. Apoquindo 4501",
  "unitNumber": "1203",
  "commune": "Las Condes",
  "region": "Región Metropolitana",
  "reference": "A pasos del Metro Manquehue",
  "propertyRole": "123-45",
  "clubId": "clw2v8c4m0000u7w4mr9db4kn",
  "amenities": {
    "comfort": {
      "pool": true
    },
    "special": {
      "furnished": false
    }
  },
  "characteristics": {
    "orientation": "norte",
    "floorLevel": 12
  },
  "media": [
    {
      "id": "clw2v8c4m0001u7w4abcd1234",
      "url": "https://cdn.tu-crm.cl/propiedades/apt-123/principal.jpg",
      "type": "IMAGE",
      "sortOrder": 0,
      "altText": "Living comedor con vista al cerro"
    }
  ],
  "createdAt": "2026-10-05T14:03:00.000Z",
  "updatedAt": "2026-10-05T14:03:00.000Z"
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

idstringRequerido

externalIdstring | nullOpcional

Id en tu CRM (el externalId que enviaste).

sandboxbooleanRequerido

true si fue creada con una API key de prueba (nunca llega a portales reales).

titlestringRequerido

descriptionstring | nullOpcional

operationTypeOperationTypeRequerido

SALE = venta, RENT = arriendo.

"SALE""RENT"

Ver campos

OperationType

Valores: "SALE" "RENT"

SALE = venta, RENT = arriendo.

statusPropertyStatusRequerido

DRAFT: faltan datos o fotos. READY: lista para publicar. PUBLISHED: activa en al menos un portal. PAUSED / ARCHIVED.

"DRAFT""READY""PUBLISHED""PAUSED""ARCHIVED"

Ver campos

PropertyStatus

Valores: "DRAFT" "READY" "PUBLISHED" "PAUSED" "ARCHIVED"

DRAFT: faltan datos o fotos. READY: lista para publicar. PUBLISHED: activa en al menos un portal. PAUSED / ARCHIVED.

priceValuenumberRequerido

priceCurrencyPriceCurrencyRequerido

"CLP""UF"

Ver campos

PriceCurrency

Valores: "CLP" "UF"

propertyTypestring | nullOpcional

bedroomsnumber | nullOpcional

bathroomsnumber | nullOpcional

parkingSpacesnumber | nullOpcional

storageUnitsnumber | nullOpcional

totalAreaM2number | nullOpcional

usefulAreaM2number | nullOpcional

terraceAreaM2number | nullOpcional

commonExpensesnumber | nullOpcional

yearBuiltnumber | nullOpcional

latnumber | nullOpcional

lngnumber | nullOpcional

addressLinestring | nullOpcional

unitNumberstring | nullOpcional

communestring | nullOpcional

regionstring | nullOpcional

referencestring | nullOpcional

propertyRolestring | nullOpcional

clubIdstring | nullOpcional

amenitiesobjectRequerido

Amenidades guardadas, en el mismo formato que se envían.

characteristicsobjectRequerido

Características guardadas. Envíalas completas en el PATCH: el objeto se reemplaza entero.

mediaPublicPropertyMediaResponseDto[]Requerido

Ver campos del elemento

idstringRequerido

Id de la foto. Úsalo para editarla o eliminarla.

urlstringRequerido

typestringRequerido

sortOrdernumberRequerido

altTextstring | nullOpcional

createdAtstringRequerido

updatedAtstringRequerido

Body o parámetros inválidos; error.details lista los campos.

JSON

{
  "error": {
    "code": "bad_request",
    "message": "La validación del request falló",
    "details": [
      "title must be a string"
    ],
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Falta el header x-api-key, o la key es inválida o fue revocada.

JSON

{
  "error": {
    "code": "unauthorized",
    "message": "API key inválida o revocada",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

La key no tiene el scope requerido, o el plan/la suscripción de la corredora no lo permite.

JSON

{
  "error": {
    "code": "forbidden",
    "message": "La API key no tiene el scope requerido: properties:write",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

El recurso no existe o pertenece a otra corredora / otro modo (prueba vs producción).

JSON

{
  "error": {
    "code": "not_found",
    "message": "La propiedad no existe o no pertenece a esta API key",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Superaste el rate limit; espera los segundos del header Retry-After.

JSON

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Superaste el límite de requests de la API pública; reintenta después de Retry-After segundos",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Retry-AfterintegerOpcional

Segundos a esperar antes de reintentar.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Eliminar una foto

DELETE/v1/properties/{id}/media/{mediaId}

Quita la foto de la galería y recalcula el estado. En una propiedad PUBLISHED no se puede bajar de 3 fotos (páusala primero). Sincroniza los portales activos y emite PROPERTY_UPDATED. Scope requerido: properties:write.

API key requerida x-api-keyVer autenticación →

Parámetros de ruta

idstringRequerido

Identificador del recurso, devuelto al crearlo o listarlo.

mediaIdstringRequerido

Identificador del recurso, devuelto al crearlo o listarlo.

DELETE/v1/properties/{id}/media/{mediaId}

cURL

curl 'https://docs.tochihub.cl/v1/properties/%7Bid%7D/media/%7BmediaId%7D' \
  --request DELETE \
  --header "x-api-key: $TOCHIHUB_API_KEY"

JavaScript

const response = await fetch("https://docs.tochihub.cl/v1/properties/%7Bid%7D/media/%7BmediaId%7D", {
  method: "DELETE",
  headers: {
    "x-api-key": "YOUR_API_KEY"
  },
});

const data = await response.json();

Python

import os
import requests

response = requests.request(
    "DELETE",
    "https://docs.tochihub.cl/v1/properties/%7Bid%7D/media/%7BmediaId%7D",
    headers={"x-api-key":os.environ["TOCHIHUB_API_KEY"]},
    timeout=30,
)
print(response.json())

Respuestas

Solicitud completada.

JSON

{
  "id": "clw2v8c4m0000u7w4mr9db4kn",
  "externalId": "crm-prop-12345",
  "sandbox": false,
  "title": "Departamento 2D2B a pasos del Metro Manquehue",
  "description": null,
  "operationType": "SALE",
  "status": "DRAFT",
  "priceValue": 6250,
  "priceCurrency": "CLP",
  "propertyType": "departamento",
  "bedrooms": 2,
  "bathrooms": 2,
  "parkingSpaces": 1,
  "storageUnits": 1,
  "totalAreaM2": 35.2,
  "usefulAreaM2": 33.4,
  "terraceAreaM2": 1.8,
  "commonExpenses": 120000,
  "yearBuilt": 2015,
  "lat": -33.4072,
  "lng": -70.5681,
  "addressLine": "Av. Apoquindo 4501",
  "unitNumber": "1203",
  "commune": "Las Condes",
  "region": "Región Metropolitana",
  "reference": "A pasos del Metro Manquehue",
  "propertyRole": "123-45",
  "clubId": "clw2v8c4m0000u7w4mr9db4kn",
  "amenities": {
    "comfort": {
      "pool": true
    },
    "special": {
      "furnished": false
    }
  },
  "characteristics": {
    "orientation": "norte",
    "floorLevel": 12
  },
  "media": [
    {
      "id": "clw2v8c4m0001u7w4abcd1234",
      "url": "https://cdn.tu-crm.cl/propiedades/apt-123/principal.jpg",
      "type": "IMAGE",
      "sortOrder": 0,
      "altText": "Living comedor con vista al cerro"
    }
  ],
  "createdAt": "2026-10-05T14:03:00.000Z",
  "updatedAt": "2026-10-05T14:03:00.000Z"
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

idstringRequerido

externalIdstring | nullOpcional

Id en tu CRM (el externalId que enviaste).

sandboxbooleanRequerido

true si fue creada con una API key de prueba (nunca llega a portales reales).

titlestringRequerido

descriptionstring | nullOpcional

operationTypeOperationTypeRequerido

SALE = venta, RENT = arriendo.

"SALE""RENT"

Ver campos

OperationType

Valores: "SALE" "RENT"

SALE = venta, RENT = arriendo.

statusPropertyStatusRequerido

DRAFT: faltan datos o fotos. READY: lista para publicar. PUBLISHED: activa en al menos un portal. PAUSED / ARCHIVED.

"DRAFT""READY""PUBLISHED""PAUSED""ARCHIVED"

Ver campos

PropertyStatus

Valores: "DRAFT" "READY" "PUBLISHED" "PAUSED" "ARCHIVED"

DRAFT: faltan datos o fotos. READY: lista para publicar. PUBLISHED: activa en al menos un portal. PAUSED / ARCHIVED.

priceValuenumberRequerido

priceCurrencyPriceCurrencyRequerido

"CLP""UF"

Ver campos

PriceCurrency

Valores: "CLP" "UF"

propertyTypestring | nullOpcional

bedroomsnumber | nullOpcional

bathroomsnumber | nullOpcional

parkingSpacesnumber | nullOpcional

storageUnitsnumber | nullOpcional

totalAreaM2number | nullOpcional

usefulAreaM2number | nullOpcional

terraceAreaM2number | nullOpcional

commonExpensesnumber | nullOpcional

yearBuiltnumber | nullOpcional

latnumber | nullOpcional

lngnumber | nullOpcional

addressLinestring | nullOpcional

unitNumberstring | nullOpcional

communestring | nullOpcional

regionstring | nullOpcional

referencestring | nullOpcional

propertyRolestring | nullOpcional

clubIdstring | nullOpcional

amenitiesobjectRequerido

Amenidades guardadas, en el mismo formato que se envían.

characteristicsobjectRequerido

Características guardadas. Envíalas completas en el PATCH: el objeto se reemplaza entero.

mediaPublicPropertyMediaResponseDto[]Requerido

Ver campos del elemento

idstringRequerido

Id de la foto. Úsalo para editarla o eliminarla.

urlstringRequerido

typestringRequerido

sortOrdernumberRequerido

altTextstring | nullOpcional

createdAtstringRequerido

updatedAtstringRequerido

Body o parámetros inválidos; error.details lista los campos.

JSON

{
  "error": {
    "code": "bad_request",
    "message": "La validación del request falló",
    "details": [
      "title must be a string"
    ],
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Falta el header x-api-key, o la key es inválida o fue revocada.

JSON

{
  "error": {
    "code": "unauthorized",
    "message": "API key inválida o revocada",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

La key no tiene el scope requerido, o el plan/la suscripción de la corredora no lo permite.

JSON

{
  "error": {
    "code": "forbidden",
    "message": "La API key no tiene el scope requerido: properties:write",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

El recurso no existe o pertenece a otra corredora / otro modo (prueba vs producción).

JSON

{
  "error": {
    "code": "not_found",
    "message": "La propiedad no existe o no pertenece a esta API key",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Superaste el rate limit; espera los segundos del header Retry-After.

JSON

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Superaste el límite de requests de la API pública; reintenta después de Retry-After segundos",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Retry-AfterintegerOpcional

Segundos a esperar antes de reintentar.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Listar portales y su estado

GET/v1/portals

Todos los portales con publicación automática, indicando si la corredora puede publicar ahora (available/status), el cupo usado y disponible, la cuenta conectada y el estado de sincronización (publicaciones en curso, con error y última lectura de estadísticas). Úsalo antes de publicar para elegir portales con cupo, o para rotar avisos. Con una key de prueba todos los portales aparecen disponibles y sin límite. Scope requerido: properties:read.

API key requerida x-api-keyVer autenticación →

GET/v1/portals

cURL

curl 'https://docs.tochihub.cl/v1/portals' \
  --header "x-api-key: $TOCHIHUB_API_KEY"

JavaScript

const response = await fetch("https://docs.tochihub.cl/v1/portals", {
  method: "GET",
  headers: {
    "x-api-key": "YOUR_API_KEY"
  },
});

const data = await response.json();

Python

import os
import requests

response = requests.request(
    "GET",
    "https://docs.tochihub.cl/v1/portals",
    headers={"x-api-key":os.environ["TOCHIHUB_API_KEY"]},
    timeout=30,
)
print(response.json())

Respuestas

Solicitud completada.

JSON

[
  {
    "code": "MERCADO_LIBRE",
    "name": "Mercado Libre",
    "available": true,
    "status": "AVAILABLE",
    "statusDescription": "Disponible para publicar.",
    "credentialSource": "BROKER",
    "credentialValidatedAt": "2026-10-01T12:00:00.000Z",
    "quota": {
      "active": 37,
      "limit": 100,
      "remaining": 63
    },
    "sync": {
      "inProgress": 2,
      "failed": 1,
      "statsLastSyncedAt": "2026-10-10T06:00:00.000Z",
      "statsLastAttemptAt": "2026-10-10T06:00:00.000Z",
      "statsLastError": null
    }
  },
  {
    "code": "TOCTOC",
    "name": "TocToc",
    "available": false,
    "status": "QUOTA_EXHAUSTED",
    "statusDescription": "Sin cupo: despublica otra propiedad de este portal para liberar uno.",
    "credentialSource": "PLATFORM",
    "credentialValidatedAt": "2026-10-02T09:30:00.000Z",
    "quota": {
      "active": 20,
      "limit": 20,
      "remaining": 0
    },
    "sync": {
      "inProgress": 0,
      "failed": 0,
      "statsLastSyncedAt": "2026-10-09T06:00:00.000Z",
      "statsLastAttemptAt": "2026-10-10T06:00:00.000Z",
      "statsLastError": "TocToc no respondió a tiempo"
    }
  },
  {
    "code": "YAPO",
    "name": "Yapo",
    "available": false,
    "status": "MISSING_CREDENTIALS",
    "statusDescription": "Falta conectar la cuenta del portal en TochiHub (Configuración → Conexiones).",
    "credentialSource": null,
    "credentialValidatedAt": null,
    "quota": {
      "active": 0,
      "limit": 50,
      "remaining": 50
    },
    "sync": {
      "inProgress": 0,
      "failed": 0,
      "statsLastSyncedAt": null,
      "statsLastAttemptAt": null,
      "statsLastError": null
    }
  }
]

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

codePortalCodeRequerido

"MERCADO_LIBRE""PORTAL_INMOBILIARIO""YAPO""TOCTOC""ENLACE_INMOBILIARIO""CHILE_DEPTOS""DOOMOS""PROPPIT""INSTAGRAM""FACEBOOK_MARKETPLACE""META_ADS""TIKTOK_ADS""TIKTOK"

Ver campos

PortalCode

namestringRequerido

availablebooleanRequerido

true si se puede publicar en este portal ahora mismo.

statusstringRequerido

AVAILABLE: se puede publicar. QUOTA_EXHAUSTED: sin cupo; despublica otra propiedad para liberar uno. MISSING_CREDENTIALS: conecta la cuenta del portal en TochiHub. NOT_IN_PLAN: el plan no incluye el portal. PLAN_INACTIVE: el plan de la corredora no está activo.

"AVAILABLE""QUOTA_EXHAUSTED""MISSING_CREDENTIALS""NOT_IN_PLAN""PLAN_INACTIVE"

statusDescriptionstringRequerido

credentialSourcestring | nullOpcional

Cuenta que se usa para publicar: la propia de la corredora o la de TochiHub. null = ninguna.

"BROKER""PLATFORM"

credentialValidatedAtstring | nullOpcional

Última validación exitosa de esa cuenta.

quotaPublicPortalQuotaDtoRequerido

Ver campos

activenumberRequerido

Avisos activos (SUCCESS) de la corredora en este portal.

limitnumber | nullOpcional

Máximo de avisos activos según el plan. null = sin límite; 0 = el plan no incluye el portal.

remainingnumber | nullOpcional

Cupos libres. null = sin límite.

syncPublicPortalSyncDtoRequerido

Ver campos

inProgressnumberRequerido

Publicaciones en cola o en proceso (QUEUED, RUNNING, RETRYING).

failednumberRequerido

Publicaciones con error definitivo (FAILED). Consulta el detalle por propiedad.

statsLastSyncedAtstring | nullOpcional

Última lectura exitosa de estadísticas de este portal. null = nunca.

statsLastAttemptAtstring | nullOpcional

Último intento de leer estadísticas, exitoso o no.

statsLastErrorstring | nullOpcional

Error del último intento si falló; null si fue exitoso.

Falta el header x-api-key, o la key es inválida o fue revocada.

JSON

{
  "error": {
    "code": "unauthorized",
    "message": "API key inválida o revocada",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

La key no tiene el scope requerido, o el plan/la suscripción de la corredora no lo permite.

JSON

{
  "error": {
    "code": "forbidden",
    "message": "La API key no tiene el scope requerido: properties:read",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Superaste el rate limit; espera los segundos del header Retry-After.

JSON

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Superaste el límite de requests de la API pública; reintenta después de Retry-After segundos",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Retry-AfterintegerOpcional

Segundos a esperar antes de reintentar.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Validar una propiedad contra los portales (sin publicar)

POST/v1/properties/validate

Corre las mismas validaciones por portal que la publicación real (fotos mínimas, título, superficie, comuna, ubicación, etc.) y devuelve cada problema con su explicación en español. No crea ni publica nada. Scope requerido: properties:read.

API key requerida x-api-keyVer autenticación →

Cuerpo de la solicitud

application/json

propertyIdstringOpcional

Valida una propiedad ya creada. Usa esto o property.

propertyCreatePublicPropertyDtoOpcional

Valida un payload sin crearlo (mismo formato que POST /v1/properties).

Ver campos

titlestringRequerido

Título del aviso. Yapo exige al menos 10 caracteres; TocToc entre 10 y 70.

descriptionstringOpcional

Descripción del aviso en texto plano (si llega HTML se convierte a texto). TocToc exige al menos 50 caracteres.

operationTypeOperationTypeRequerido

SALE = venta, RENT = arriendo.

"SALE""RENT"

Ver campos

OperationType

Valores: "SALE" "RENT"

SALE = venta, RENT = arriendo.

priceValuenumberRequerido

Precio como entero. Los precios en UF también van como entero.

mín. 0

priceCurrencyPriceCurrencyRequerido

"CLP""UF"

Ver campos

PriceCurrency

Valores: "CLP" "UF"

propertyTypestringOpcional

Tipo de propiedad: departamento, casa, oficina, local, terreno, parcela, bodega, estacionamiento.

bedroomsnumberOpcional

Dormitorios.

mín. 0

bathroomsnumberOpcional

Baños.

mín. 0

parkingSpacesnumberOpcional

Estacionamientos.

mín. 0

storageUnitsnumberOpcional

Bodegas.

mín. 0

totalAreaM2numberOpcional

Superficie total en m². En casas, parcelas y terrenos es la superficie del terreno. Admite decimales.

mín. 0

usefulAreaM2numberOpcional

Superficie útil en m². Yapo y TocToc la publican como superficie construida; si falta, Yapo usa la superficie total. Admite decimales.

mín. 0

terraceAreaM2numberOpcional

Superficie de terraza en m². Admite decimales.

mín. 0

commonExpensesnumber | nullOpcional

Gastos comunes mensuales en CLP. Omitirlos o enviar 0 significa "no informado": los portales no muestran gastos comunes. En PATCH, null borra el valor guardado.

yearBuiltnumberOpcional

Año de construcción.

latnumberOpcional

Latitud. Varios portales exigen la ubicación en el mapa.

lngnumberOpcional

Longitud.

addressLinestringOpcional

referencestringOpcional

Referencia de ubicación para el aviso.

propertyRolestringOpcional

Rol de avalúo (SII). TocToc lo lee.

unitNumberstringOpcional

Número de departamento u oficina.

communestringOpcional

Comuna, con tildes y ñ (ej. "Ñuñoa").

regionstringOpcional

amenitiesobjectOpcional

characteristicsobjectOpcional

Datos extra que algunos portales leen (orientation, floorLevel, videoTourUrl, contactName, contactPhone, contactEmail, ...). La clave "external" está reservada.

externalIdstringOpcional

Id estable de la propiedad en tu CRM. Úsalo para encontrarla después con GET /v1/properties?externalId=.

clubIdstringOpcional

Id de una colección (club) de la corredora o global.

statusstringOpcional

Obsoleto: se ignora. El estado se calcula solo (READY cuando tiene título, precio y al menos 3 fotos).

"DRAFT""READY"

mediaCreatePublicPropertyMediaDto[]Opcional

Fotos por URL.

Ver campos del elemento

typePropertyMediaTypeOpcional

Tipo de archivo. Solo las IMAGE cuentan para el mínimo de 3 fotos.

Por defecto: "IMAGE"

"IMAGE""VIDEO""TOUR_360""DOCUMENT"

Ver campos

PropertyMediaType

Valores: "IMAGE" "VIDEO" "TOUR_360" "DOCUMENT"

Tipo de archivo. Solo las IMAGE cuentan para el mínimo de 3 fotos.

urlstringRequerido

URL pública (HTTPS) de la foto. Los portales la descargan tal cual: debe ser accesible sin autenticación.

sortOrdernumberOpcional

Orden de la foto; la de menor orden es la portada.

mín. 0

altTextstringOpcional

portalsPortalCode[]Opcional

Portales a validar. Por defecto, los habilitados para tu corredora.

POST/v1/properties/validate

cURL

curl 'https://docs.tochihub.cl/v1/properties/validate' \
  --request POST \
  --header "x-api-key: $TOCHIHUB_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "propertyId": "clw2v8c4m0000u7w4mr9db4kn",
  "property": {
    "title": "Departamento 2D2B a pasos del Metro Manquehue",
    "description": "Departamento luminoso con estacionamiento y bodega, orientación norte.",
    "operationType": "SALE",
    "priceValue": 6250,
    "priceCurrency": "UF",
    "propertyType": "departamento",
    "bedrooms": 2,
    "bathrooms": 2,
    "parkingSpaces": 1,
    "storageUnits": 1,
    "totalAreaM2": 35.2,
    "usefulAreaM2": 33.4,
    "terraceAreaM2": 1.8,
    "commonExpenses": 120000,
    "yearBuilt": 2015,
    "lat": -33.4072,
    "lng": -70.5681,
    "addressLine": "Av. Apoquindo 4501",
    "reference": "A pasos del Metro Manquehue",
    "propertyRole": "123-45",
    "unitNumber": "1203",
    "commune": "Las Condes",
    "region": "Región Metropolitana",
    "amenities": {
      "comfort": {
        "pool": true,
        "gym": true
      },
      "security": {
        "elevator": true
      },
      "special": {
        "furnished": false
      }
    },
    "characteristics": {
      "orientation": "norte",
      "floorLevel": 12
    },
    "externalId": "crm-prop-12345",
    "clubId": "clw2v8c4m0000u7w4mr9db4kn",
    "status": "DRAFT",
    "media": [
      {
        "type": "IMAGE",
        "url": "https://cdn.tu-crm.cl/propiedades/apt-123/principal.jpg",
        "sortOrder": 0,
        "altText": "Living comedor con vista al cerro"
      }
    ]
  },
  "portals": [
    "MERCADO_LIBRE"
  ]
}'

JavaScript

const response = await fetch("https://docs.tochihub.cl/v1/properties/validate", {
  method: "POST",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "propertyId": "clw2v8c4m0000u7w4mr9db4kn",
    "property": {
      "title": "Departamento 2D2B a pasos del Metro Manquehue",
      "description": "Departamento luminoso con estacionamiento y bodega, orientación norte.",
      "operationType": "SALE",
      "priceValue": 6250,
      "priceCurrency": "UF",
      "propertyType": "departamento",
      "bedrooms": 2,
      "bathrooms": 2,
      "parkingSpaces": 1,
      "storageUnits": 1,
      "totalAreaM2": 35.2,
      "usefulAreaM2": 33.4,
      "terraceAreaM2": 1.8,
      "commonExpenses": 120000,
      "yearBuilt": 2015,
      "lat": -33.4072,
      "lng": -70.5681,
      "addressLine": "Av. Apoquindo 4501",
      "reference": "A pasos del Metro Manquehue",
      "propertyRole": "123-45",
      "unitNumber": "1203",
      "commune": "Las Condes",
      "region": "Región Metropolitana",
      "amenities": {
        "comfort": {
          "pool": true,
          "gym": true
        },
        "security": {
          "elevator": true
        },
        "special": {
          "furnished": false
        }
      },
      "characteristics": {
        "orientation": "norte",
        "floorLevel": 12
      },
      "externalId": "crm-prop-12345",
      "clubId": "clw2v8c4m0000u7w4mr9db4kn",
      "status": "DRAFT",
      "media": [
        {
          "type": "IMAGE",
          "url": "https://cdn.tu-crm.cl/propiedades/apt-123/principal.jpg",
          "sortOrder": 0,
          "altText": "Living comedor con vista al cerro"
        }
      ]
    },
    "portals": [
      "MERCADO_LIBRE"
    ]
  }),
});

const data = await response.json();

Python

import os
import requests

response = requests.request(
    "POST",
    "https://docs.tochihub.cl/v1/properties/validate",
    headers={"x-api-key":os.environ["TOCHIHUB_API_KEY"],"Content-Type":"application/json"},
    json=__import__("json").loads("{\"propertyId\":\"clw2v8c4m0000u7w4mr9db4kn\",\"property\":{\"title\":\"Departamento 2D2B a pasos del Metro Manquehue\",\"description\":\"Departamento luminoso con estacionamiento y bodega, orientación norte.\",\"operationType\":\"SALE\",\"priceValue\":6250,\"priceCurrency\":\"UF\",\"propertyType\":\"departamento\",\"bedrooms\":2,\"bathrooms\":2,\"parkingSpaces\":1,\"storageUnits\":1,\"totalAreaM2\":35.2,\"usefulAreaM2\":33.4,\"terraceAreaM2\":1.8,\"commonExpenses\":120000,\"yearBuilt\":2015,\"lat\":-33.4072,\"lng\":-70.5681,\"addressLine\":\"Av. Apoquindo 4501\",\"reference\":\"A pasos del Metro Manquehue\",\"propertyRole\":\"123-45\",\"unitNumber\":\"1203\",\"commune\":\"Las Condes\",\"region\":\"Región Metropolitana\",\"amenities\":{\"comfort\":{\"pool\":true,\"gym\":true},\"security\":{\"elevator\":true},\"special\":{\"furnished\":false}},\"characteristics\":{\"orientation\":\"norte\",\"floorLevel\":12},\"externalId\":\"crm-prop-12345\",\"clubId\":\"clw2v8c4m0000u7w4mr9db4kn\",\"status\":\"DRAFT\",\"media\":[{\"type\":\"IMAGE\",\"url\":\"https://cdn.tu-crm.cl/propiedades/apt-123/principal.jpg\",\"sortOrder\":0,\"altText\":\"Living comedor con vista al cerro\"}]},\"portals\":[\"MERCADO_LIBRE\"]}"),
    timeout=30,
)
print(response.json())

Respuestas

Solicitud completada.

JSON

{
  "valid": false,
  "portals": [
    {
      "portalCode": "MERCADO_LIBRE",
      "valid": false,
      "errors": [
        {
          "message": "Yapo requires the built area (square, m²) on the property.",
          "description": "Falta la superficie construida (m²)."
        }
      ]
    }
  ]
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

validbooleanRequerido

true solo si pasa en todos los portales pedidos.

portalsPortalValidationDto[]Requerido

Ver campos del elemento

portalCodePortalCodeRequerido

"MERCADO_LIBRE""PORTAL_INMOBILIARIO""YAPO""TOCTOC""ENLACE_INMOBILIARIO""CHILE_DEPTOS""DOOMOS""PROPPIT""INSTAGRAM""FACEBOOK_MARKETPLACE""META_ADS""TIKTOK_ADS""TIKTOK"

Ver campos

PortalCode

validbooleanRequerido

errorsPublicationIssueDto[]Requerido

Ver campos del elemento

messagestringRequerido

Mensaje original del portal o de la validación.

descriptionstringRequerido

Explicación en español, lista para mostrar.

Body o parámetros inválidos; error.details lista los campos.

JSON

{
  "error": {
    "code": "bad_request",
    "message": "La validación del request falló",
    "details": [
      "title must be a string"
    ],
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Falta el header x-api-key, o la key es inválida o fue revocada.

JSON

{
  "error": {
    "code": "unauthorized",
    "message": "API key inválida o revocada",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

La key no tiene el scope requerido, o el plan/la suscripción de la corredora no lo permite.

JSON

{
  "error": {
    "code": "forbidden",
    "message": "La API key no tiene el scope requerido: properties:read",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

El recurso no existe o pertenece a otra corredora / otro modo (prueba vs producción).

JSON

{
  "error": {
    "code": "not_found",
    "message": "La propiedad no existe o no pertenece a esta API key",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Superaste el rate limit; espera los segundos del header Retry-After.

JSON

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Superaste el límite de requests de la API pública; reintenta después de Retry-After segundos",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Retry-AfterintegerOpcional

Segundos a esperar antes de reintentar.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Estado de publicación por portal

GET/v1/properties/{id}/publications

Un registro por portal: estado, URL del aviso y último error (original y en español). Scope requerido: properties:read.

API key requerida x-api-keyVer autenticación →

Parámetros de ruta

idstringRequerido

Identificador del recurso, devuelto al crearlo o listarlo.

GET/v1/properties/{id}/publications

cURL

curl 'https://docs.tochihub.cl/v1/properties/%7Bid%7D/publications' \
  --header "x-api-key: $TOCHIHUB_API_KEY"

JavaScript

const response = await fetch("https://docs.tochihub.cl/v1/properties/%7Bid%7D/publications", {
  method: "GET",
  headers: {
    "x-api-key": "YOUR_API_KEY"
  },
});

const data = await response.json();

Python

import os
import requests

response = requests.request(
    "GET",
    "https://docs.tochihub.cl/v1/properties/%7Bid%7D/publications",
    headers={"x-api-key":os.environ["TOCHIHUB_API_KEY"]},
    timeout=30,
)
print(response.json())

Respuestas

Solicitud completada.

JSON

[
  {
    "portalCode": "MERCADO_LIBRE",
    "portalName": "Yapo",
    "status": "PENDING",
    "externalUrl": "https://www.yapo.cl/...",
    "lastError": null,
    "lastErrorDescription": null,
    "updatedAt": "2026-10-05T14:03:00.000Z"
  }
]

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

portalCodePortalCodeRequerido

"MERCADO_LIBRE""PORTAL_INMOBILIARIO""YAPO""TOCTOC""ENLACE_INMOBILIARIO""CHILE_DEPTOS""DOOMOS""PROPPIT""INSTAGRAM""FACEBOOK_MARKETPLACE""META_ADS""TIKTOK_ADS""TIKTOK"

Ver campos

PortalCode

portalNamestringRequerido

statusPublicationStatusRequerido

QUEUED/RUNNING/RETRYING: en curso. SUCCESS: activa. FAILED: falló (ver lastErrorDescription). UNPUBLISHED: dada de baja.

"PENDING""QUEUED""RUNNING""SUCCESS""FAILED""RETRYING""CANCELED""UNPUBLISHED"

Ver campos

PublicationStatus

Valores: "PENDING" "QUEUED" "RUNNING" "SUCCESS" "FAILED" "RETRYING" "CANCELED" "UNPUBLISHED"

QUEUED/RUNNING/RETRYING: en curso. SUCCESS: activa. FAILED: falló (ver lastErrorDescription). UNPUBLISHED: dada de baja.

externalUrlstring | nullOpcional

lastErrorstring | nullOpcional

Mensaje original del portal.

lastErrorDescriptionstring | nullOpcional

El mismo error explicado en español.

updatedAtstringRequerido

Falta el header x-api-key, o la key es inválida o fue revocada.

JSON

{
  "error": {
    "code": "unauthorized",
    "message": "API key inválida o revocada",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

La key no tiene el scope requerido, o el plan/la suscripción de la corredora no lo permite.

JSON

{
  "error": {
    "code": "forbidden",
    "message": "La API key no tiene el scope requerido: properties:read",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

El recurso no existe o pertenece a otra corredora / otro modo (prueba vs producción).

JSON

{
  "error": {
    "code": "not_found",
    "message": "La propiedad no existe o no pertenece a esta API key",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Superaste el rate limit; espera los segundos del header Retry-After.

JSON

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Superaste el límite de requests de la API pública; reintenta después de Retry-After segundos",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Retry-AfterintegerOpcional

Segundos a esperar antes de reintentar.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Publicar en portales

POST/v1/properties/{id}/publications

Encola la publicación en cada portal pedido y responde de inmediato con el resultado por portal (un portal rechazado no bloquea a los demás). El resultado final llega por el webhook PROPERTY_PUBLICATION_COMPLETED o consultando el estado. Requiere al menos 3 fotos. Con una key de prueba se simula: corre las validaciones reales, nunca contacta al portal y devuelve URLs de sandbox. Scope requerido: properties:write.

API key requerida x-api-keyVer autenticación →

Parámetros de ruta

idstringRequerido

Identificador del recurso, devuelto al crearlo o listarlo.

Cuerpo de la solicitud

application/json

portalsPortalCode[]Requerido

Portales destino. Usa GET /v1/portals para ver los habilitados para tu corredora.

POST/v1/properties/{id}/publications

cURL

curl 'https://docs.tochihub.cl/v1/properties/%7Bid%7D/publications' \
  --request POST \
  --header "x-api-key: $TOCHIHUB_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "portals": [
    "YAPO",
    "TOCTOC"
  ]
}'

JavaScript

const response = await fetch("https://docs.tochihub.cl/v1/properties/%7Bid%7D/publications", {
  method: "POST",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "portals": [
      "YAPO",
      "TOCTOC"
    ]
  }),
});

const data = await response.json();

Python

import os
import requests

response = requests.request(
    "POST",
    "https://docs.tochihub.cl/v1/properties/%7Bid%7D/publications",
    headers={"x-api-key":os.environ["TOCHIHUB_API_KEY"],"Content-Type":"application/json"},
    json=__import__("json").loads("{\"portals\":[\"YAPO\",\"TOCTOC\"]}"),
    timeout=30,
)
print(response.json())

Respuestas

Solicitud de publicación recibida; revisa el resultado de cada portal.

JSON

[
  {
    "portalCode": "MERCADO_LIBRE",
    "accepted": true,
    "status": "QUEUED",
    "error": {
      "message": "Yapo requires the built area (square, m²) on the property.",
      "description": "Falta la superficie construida (m²)."
    }
  }
]

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

portalCodePortalCodeRequerido

"MERCADO_LIBRE""PORTAL_INMOBILIARIO""YAPO""TOCTOC""ENLACE_INMOBILIARIO""CHILE_DEPTOS""DOOMOS""PROPPIT""INSTAGRAM""FACEBOOK_MARKETPLACE""META_ADS""TIKTOK_ADS""TIKTOK"

Ver campos

PortalCode

acceptedbooleanRequerido

true si el portal quedó encolado (producción) o simulado con éxito (sandbox).

statusPublicationStatusOpcional

QUEUED/RUNNING/RETRYING: en curso. SUCCESS: activa. FAILED: falló (ver lastErrorDescription). UNPUBLISHED: dada de baja.

"PENDING""QUEUED""RUNNING""SUCCESS""FAILED""RETRYING""CANCELED""UNPUBLISHED"

Ver campos

PublicationStatus

Valores: "PENDING" "QUEUED" "RUNNING" "SUCCESS" "FAILED" "RETRYING" "CANCELED" "UNPUBLISHED"

QUEUED/RUNNING/RETRYING: en curso. SUCCESS: activa. FAILED: falló (ver lastErrorDescription). UNPUBLISHED: dada de baja.

errorPublicationIssueDtoOpcional

Ver campos

messagestringRequerido

Mensaje original del portal o de la validación.

descriptionstringRequerido

Explicación en español, lista para mostrar.

Body o parámetros inválidos; error.details lista los campos.

JSON

{
  "error": {
    "code": "bad_request",
    "message": "La validación del request falló",
    "details": [
      "title must be a string"
    ],
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Falta el header x-api-key, o la key es inválida o fue revocada.

JSON

{
  "error": {
    "code": "unauthorized",
    "message": "API key inválida o revocada",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

La key no tiene el scope requerido, o el plan/la suscripción de la corredora no lo permite.

JSON

{
  "error": {
    "code": "forbidden",
    "message": "La API key no tiene el scope requerido: properties:write",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

El recurso no existe o pertenece a otra corredora / otro modo (prueba vs producción).

JSON

{
  "error": {
    "code": "not_found",
    "message": "La propiedad no existe o no pertenece a esta API key",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Superaste el rate limit; espera los segundos del header Retry-After.

JSON

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Superaste el límite de requests de la API pública; reintenta después de Retry-After segundos",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Retry-AfterintegerOpcional

Segundos a esperar antes de reintentar.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Despublicar de un portal

DELETE/v1/properties/{id}/publications/{portalCode}

Encola la baja del aviso en ese portal. Solo aplica si la publicación está activa (SUCCESS). Scope requerido: properties:write.

API key requerida x-api-keyVer autenticación →

Parámetros de ruta

idstringRequerido

Identificador del recurso, devuelto al crearlo o listarlo.

portalCodePortalCodeRequerido

"MERCADO_LIBRE""PORTAL_INMOBILIARIO""YAPO""TOCTOC""ENLACE_INMOBILIARIO""CHILE_DEPTOS""DOOMOS""PROPPIT""INSTAGRAM""FACEBOOK_MARKETPLACE""META_ADS""TIKTOK_ADS""TIKTOK"

DELETE/v1/properties/{id}/publications/{portalCode}

cURL

curl 'https://docs.tochihub.cl/v1/properties/%7Bid%7D/publications/%7BportalCode%7D' \
  --request DELETE \
  --header "x-api-key: $TOCHIHUB_API_KEY"

JavaScript

const response = await fetch("https://docs.tochihub.cl/v1/properties/%7Bid%7D/publications/%7BportalCode%7D", {
  method: "DELETE",
  headers: {
    "x-api-key": "YOUR_API_KEY"
  },
});

const data = await response.json();

Python

import os
import requests

response = requests.request(
    "DELETE",
    "https://docs.tochihub.cl/v1/properties/%7Bid%7D/publications/%7BportalCode%7D",
    headers={"x-api-key":os.environ["TOCHIHUB_API_KEY"]},
    timeout=30,
)
print(response.json())

Respuestas

Solicitud de publicación recibida; revisa el resultado de cada portal.

JSON

{
  "portalCode": "MERCADO_LIBRE",
  "accepted": true,
  "status": "QUEUED",
  "error": {
    "message": "Yapo requires the built area (square, m²) on the property.",
    "description": "Falta la superficie construida (m²)."
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

portalCodePortalCodeRequerido

"MERCADO_LIBRE""PORTAL_INMOBILIARIO""YAPO""TOCTOC""ENLACE_INMOBILIARIO""CHILE_DEPTOS""DOOMOS""PROPPIT""INSTAGRAM""FACEBOOK_MARKETPLACE""META_ADS""TIKTOK_ADS""TIKTOK"

Ver campos

PortalCode

acceptedbooleanRequerido

true si el portal quedó encolado (producción) o simulado con éxito (sandbox).

statusPublicationStatusOpcional

QUEUED/RUNNING/RETRYING: en curso. SUCCESS: activa. FAILED: falló (ver lastErrorDescription). UNPUBLISHED: dada de baja.

"PENDING""QUEUED""RUNNING""SUCCESS""FAILED""RETRYING""CANCELED""UNPUBLISHED"

Ver campos

PublicationStatus

Valores: "PENDING" "QUEUED" "RUNNING" "SUCCESS" "FAILED" "RETRYING" "CANCELED" "UNPUBLISHED"

QUEUED/RUNNING/RETRYING: en curso. SUCCESS: activa. FAILED: falló (ver lastErrorDescription). UNPUBLISHED: dada de baja.

errorPublicationIssueDtoOpcional

Ver campos

messagestringRequerido

Mensaje original del portal o de la validación.

descriptionstringRequerido

Explicación en español, lista para mostrar.

Falta el header x-api-key, o la key es inválida o fue revocada.

JSON

{
  "error": {
    "code": "unauthorized",
    "message": "API key inválida o revocada",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

La key no tiene el scope requerido, o el plan/la suscripción de la corredora no lo permite.

JSON

{
  "error": {
    "code": "forbidden",
    "message": "La API key no tiene el scope requerido: properties:write",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

El recurso no existe o pertenece a otra corredora / otro modo (prueba vs producción).

JSON

{
  "error": {
    "code": "not_found",
    "message": "La propiedad no existe o no pertenece a esta API key",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Superaste el rate limit; espera los segundos del header Retry-After.

JSON

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Superaste el límite de requests de la API pública; reintenta después de Retry-After segundos",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Retry-AfterintegerOpcional

Segundos a esperar antes de reintentar.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Cupo de propiedades del plan

GET/v1/usage

Cuántas propiedades cuentan para el cupo del plan, el máximo y cuántas puedes crear todavía. Crear y publicar tienen cupos distintos: el cupo de avisos por portal está en GET /v1/portals. Con una key de prueba cuenta solo propiedades sandbox, sin límite. Scope requerido: properties:read.

API key requerida x-api-keyVer autenticación →

GET/v1/usage

cURL

curl 'https://docs.tochihub.cl/v1/usage' \
  --header "x-api-key: $TOCHIHUB_API_KEY"

JavaScript

const response = await fetch("https://docs.tochihub.cl/v1/usage", {
  method: "GET",
  headers: {
    "x-api-key": "YOUR_API_KEY"
  },
});

const data = await response.json();

Python

import os
import requests

response = requests.request(
    "GET",
    "https://docs.tochihub.cl/v1/usage",
    headers={"x-api-key":os.environ["TOCHIHUB_API_KEY"]},
    timeout=30,
)
print(response.json())

Respuestas

Solicitud completada.

JSON

{
  "plan": {
    "name": "Growth",
    "active": true
  },
  "properties": {
    "active": 187,
    "limit": 200,
    "remaining": 13
  },
  "portalsNote": "Los avisos activos y el cupo de cada portal están en GET /v1/portals."
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

planPublicUsagePlanDtoRequerido

Ver campos

namestringRequerido

activebooleanRequerido

false si el plan está suspendido: no se pueden crear ni publicar propiedades.

propertiesPublicUsagePropertiesDtoRequerido

Ver campos

activenumberRequerido

Propiedades que cuentan para el cupo (todas menos las archivadas).

limitnumber | nullOpcional

Máximo de propiedades del plan. null = sin límite.

remainingnumber | nullOpcional

Propiedades que aún puedes crear. null = sin límite.

portalsNotestringRequerido

Falta el header x-api-key, o la key es inválida o fue revocada.

JSON

{
  "error": {
    "code": "unauthorized",
    "message": "API key inválida o revocada",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

La key no tiene el scope requerido, o el plan/la suscripción de la corredora no lo permite.

JSON

{
  "error": {
    "code": "forbidden",
    "message": "La API key no tiene el scope requerido: properties:read",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Superaste el rate limit; espera los segundos del header Retry-After.

JSON

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Superaste el límite de requests de la API pública; reintenta después de Retry-After segundos",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Retry-AfterintegerOpcional

Segundos a esperar antes de reintentar.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Listar leads

GET/v1/leads

Requiere leads:read. Lista los contactos de la corredora, más recientes primero, con paginación y filtros por propiedad/canal. Una key de prueba solo ve leads de propiedades sandbox. Scope requerido: leads:read.

API key requerida x-api-keyVer autenticación →

Parámetros de consulta

pagenumberOpcional

Página, desde 1.

mín. 1Por defecto: 1

limitnumberOpcional

Resultados por página.

mín. 1máx. 100Por defecto: 20

propertyIdstringOpcional

Filtrar por el id de una propiedad.

channelstringOpcional

Canal de origen del lead.

"MANUAL""INTERNAL_FORM""WHATSAPP""PORTAL_CONTACT"

GET/v1/leads

cURL

curl 'https://docs.tochihub.cl/v1/leads' \
  --header "x-api-key: $TOCHIHUB_API_KEY"

JavaScript

const response = await fetch("https://docs.tochihub.cl/v1/leads", {
  method: "GET",
  headers: {
    "x-api-key": "YOUR_API_KEY"
  },
});

const data = await response.json();

Python

import os
import requests

response = requests.request(
    "GET",
    "https://docs.tochihub.cl/v1/leads",
    headers={"x-api-key":os.environ["TOCHIHUB_API_KEY"]},
    timeout=30,
)
print(response.json())

Respuestas

Solicitud completada.

JSON

{
  "items": [
    {
      "id": "cm1lead0000000000000000",
      "propertyId": "cm1prop0000000000000000",
      "channel": "PORTAL_CONTACT",
      "portalCode": "YAPO",
      "contactName": "Camila Rojas",
      "contactPhone": "+56912345678",
      "contactEmail": "camila@example.com",
      "message": "¿Sigue disponible?",
      "respondedAt": null,
      "createdAt": "2026-10-05T14:03:00.000Z"
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 20
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

itemsPublicLeadDto[]Requerido

Ver campos del elemento

idstringRequerido

Identificador del lead.

propertyIdstringRequerido

Propiedad consultada.

channelstringRequerido

"MANUAL""INTERNAL_FORM""WHATSAPP""PORTAL_CONTACT"

portalCodestring | nullRequerido

Código del portal, si corresponde.

contactNamestring | nullRequerido

contactPhonestring | nullRequerido

contactEmailstring | nullRequerido

messagestring | nullRequerido

respondedAtstring | nullRequerido

Fecha de respuesta registrada.

createdAtstringRequerido

totalnumberRequerido

pagenumberRequerido

limitnumberRequerido

Body o parámetros inválidos; error.details lista los campos.

JSON

{
  "error": {
    "code": "bad_request",
    "message": "La validación del request falló",
    "details": [
      "title must be a string"
    ],
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Falta el header x-api-key, o la key es inválida o fue revocada.

JSON

{
  "error": {
    "code": "unauthorized",
    "message": "API key inválida o revocada",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

La key no tiene el scope requerido, o el plan/la suscripción de la corredora no lo permite.

JSON

{
  "error": {
    "code": "forbidden",
    "message": "La API key no tiene el scope requerido: leads:read",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Superaste el rate limit; espera los segundos del header Retry-After.

JSON

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Superaste el límite de requests de la API pública; reintenta después de Retry-After segundos",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Retry-AfterintegerOpcional

Segundos a esperar antes de reintentar.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Obtener un lead

GET/v1/leads/{id}

Requiere leads:read. Devuelve el contacto, su mensaje y la propiedad consultada, dentro de la corredora y del modo de la API key. Scope requerido: leads:read.

API key requerida x-api-keyVer autenticación →

Parámetros de ruta

idstringRequerido

Identificador del recurso, devuelto al crearlo o listarlo.

GET/v1/leads/{id}

cURL

curl 'https://docs.tochihub.cl/v1/leads/%7Bid%7D' \
  --header "x-api-key: $TOCHIHUB_API_KEY"

JavaScript

const response = await fetch("https://docs.tochihub.cl/v1/leads/%7Bid%7D", {
  method: "GET",
  headers: {
    "x-api-key": "YOUR_API_KEY"
  },
});

const data = await response.json();

Python

import os
import requests

response = requests.request(
    "GET",
    "https://docs.tochihub.cl/v1/leads/%7Bid%7D",
    headers={"x-api-key":os.environ["TOCHIHUB_API_KEY"]},
    timeout=30,
)
print(response.json())

Respuestas

Solicitud completada.

JSON

{
  "id": "cm1lead0000000000000000",
  "propertyId": "cm1prop0000000000000000",
  "channel": "PORTAL_CONTACT",
  "portalCode": "YAPO",
  "contactName": "Camila Rojas",
  "contactPhone": "+56912345678",
  "contactEmail": "camila@example.com",
  "message": "¿Sigue disponible?",
  "respondedAt": null,
  "createdAt": "2026-10-05T14:03:00.000Z"
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

idstringRequerido

Identificador del lead.

propertyIdstringRequerido

Propiedad consultada.

channelstringRequerido

"MANUAL""INTERNAL_FORM""WHATSAPP""PORTAL_CONTACT"

portalCodestring | nullRequerido

Código del portal, si corresponde.

contactNamestring | nullRequerido

contactPhonestring | nullRequerido

contactEmailstring | nullRequerido

messagestring | nullRequerido

respondedAtstring | nullRequerido

Fecha de respuesta registrada.

createdAtstringRequerido

Falta el header x-api-key, o la key es inválida o fue revocada.

JSON

{
  "error": {
    "code": "unauthorized",
    "message": "API key inválida o revocada",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

La key no tiene el scope requerido, o el plan/la suscripción de la corredora no lo permite.

JSON

{
  "error": {
    "code": "forbidden",
    "message": "La API key no tiene el scope requerido: leads:read",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

El recurso no existe o pertenece a otra corredora / otro modo (prueba vs producción).

JSON

{
  "error": {
    "code": "not_found",
    "message": "La propiedad no existe o no pertenece a esta API key",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Superaste el rate limit; espera los segundos del header Retry-After.

JSON

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Superaste el límite de requests de la API pública; reintenta después de Retry-After segundos",
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

Encabezados de respuesta

X-RateLimit-LimitintegerOpcional

Cupo de solicitudes por ventana.

X-RateLimit-RemainingintegerOpcional

Solicitudes restantes de esta API key.

X-RateLimit-ResetintegerOpcional

Reinicio de la ventana, epoch en segundos.

x-request-idstringOpcional

Identificador de diagnóstico de la solicitud.

Retry-AfterintegerOpcional

Segundos a esperar antes de reintentar.

Esquema de respuesta

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

LEAD_CREATED

Llegó un lead nuevo (desde un portal, el sitio o cargado a mano) asociado a una propiedad.

Cuerpo de la solicitud

application/json

idstringRequerido

Id estable para deduplicar.

eventstringRequerido

"LEAD_CREATED"

livemodebooleanRequerido

createdAtstringRequerido

date-time

dataobjectRequerido

Ver campos

leadIdstringRequerido

propertyIdstringRequerido

channelstringRequerido

contactNamestring | nullOpcional

contactPhonestring | nullOpcional

contactEmailstring | nullOpcional

messagestring | nullOpcional

createdAtstringRequerido

TochiHub envía este evento a tu receptor. Ver firma y reintentos →

Payload del evento

JSON

{
  "id": "delivery-ejemplo",
  "event": "LEAD_CREATED",
  "livemode": false,
  "createdAt": "2026-10-05T14:03:00.000Z",
  "data": {
    "leadId": "cm1lead0000000000000000",
    "propertyId": "cm1prop0000000000000000",
    "channel": "PORTAL_CONTACT",
    "contactName": "Camila Rojas",
    "contactPhone": "+56912345678",
    "contactEmail": "camila@example.com",
    "message": "Hola, ¿sigue disponible el departamento?",
    "createdAt": "2026-10-05T14:03:00.000Z"
  }
}

Respuestas

Evento recibido y persistido por tu receptor.

Esta respuesta no incluye un cuerpo JSON.

PROPERTY_CREATED

Se creó una propiedad (en el panel, por WhatsApp o por la API).

Cuerpo de la solicitud

application/json

idstringRequerido

Id estable para deduplicar.

eventstringRequerido

"PROPERTY_CREATED"

livemodebooleanRequerido

createdAtstringRequerido

date-time

dataobjectRequerido

Ver campos

propertyIdstringRequerido

externalIdstringRequerido

titlestringRequerido

operationTypestringRequerido

statusstringRequerido

createdAtstringRequerido

TochiHub envía este evento a tu receptor. Ver firma y reintentos →

Payload del evento

JSON

{
  "id": "delivery-ejemplo",
  "event": "PROPERTY_CREATED",
  "livemode": false,
  "createdAt": "2026-10-05T14:03:00.000Z",
  "data": {
    "propertyId": "cm1prop0000000000000000",
    "externalId": "crm-prop-12345",
    "title": "Departamento 2D2B en Providencia",
    "operationType": "SALE",
    "status": "DRAFT",
    "createdAt": "2026-10-05T14:03:00.000Z"
  }
}

Respuestas

Evento recibido y persistido por tu receptor.

Esta respuesta no incluye un cuerpo JSON.

PROPERTY_PUBLICATION_COMPLETED

Terminó una publicación, actualización o baja en un portal (con éxito o con error definitivo; nunca en un reintento).

Cuerpo de la solicitud

application/json

idstringRequerido

Id estable para deduplicar.

eventstringRequerido

"PROPERTY_PUBLICATION_COMPLETED"

livemodebooleanRequerido

createdAtstringRequerido

date-time

dataobjectRequerido

Ver campos

propertyIdstringRequerido

externalIdstringRequerido

portalCodestringRequerido

actionstringRequerido

succeededbooleanRequerido

errorMessagestring | nullOpcional

errorDescriptionstring | nullOpcional

TochiHub envía este evento a tu receptor. Ver firma y reintentos →

Payload del evento

JSON

{
  "id": "delivery-ejemplo",
  "event": "PROPERTY_PUBLICATION_COMPLETED",
  "livemode": false,
  "createdAt": "2026-10-05T14:03:00.000Z",
  "data": {
    "propertyId": "cm1prop0000000000000000",
    "externalId": "crm-prop-12345",
    "portalCode": "YAPO",
    "action": "PUBLISH",
    "succeeded": false,
    "errorMessage": "Yapo requires the built area (square, m²) on the property.",
    "errorDescription": "Falta la superficie construida (m²)."
  }
}

Respuestas

Evento recibido y persistido por tu receptor.

Esta respuesta no incluye un cuerpo JSON.

PROPERTY_UPDATED

Se editó una propiedad o su galería (en el panel o por la API). Trae el estado actual; consulta GET /v1/properties/{id} para el detalle.

Cuerpo de la solicitud

application/json

idstringRequerido

Id estable para deduplicar.

eventstringRequerido

"PROPERTY_UPDATED"

livemodebooleanRequerido

createdAtstringRequerido

date-time

dataobjectRequerido

Ver campos

propertyIdstringRequerido

externalIdstringRequerido

statusstringRequerido

updatedAtstringRequerido

TochiHub envía este evento a tu receptor. Ver firma y reintentos →

Payload del evento

JSON

{
  "id": "delivery-ejemplo",
  "event": "PROPERTY_UPDATED",
  "livemode": false,
  "createdAt": "2026-10-05T14:03:00.000Z",
  "data": {
    "propertyId": "cm1prop0000000000000000",
    "externalId": "crm-prop-12345",
    "status": "PUBLISHED",
    "updatedAt": "2026-10-05T14:03:00.000Z"
  }
}

Respuestas

Evento recibido y persistido por tu receptor.

Esta respuesta no incluye un cuerpo JSON.

PROPERTY_STATUS_CHANGED

Una propiedad se pausó, se reanudó o se archivó (en el panel o por la API).

Cuerpo de la solicitud

application/json

idstringRequerido

Id estable para deduplicar.

eventstringRequerido

"PROPERTY_STATUS_CHANGED"

livemodebooleanRequerido

createdAtstringRequerido

date-time

dataobjectRequerido

Ver campos

propertyIdstringRequerido

externalIdstringRequerido

previousStatusstringRequerido

statusstringRequerido

changedAtstringRequerido

TochiHub envía este evento a tu receptor. Ver firma y reintentos →

Payload del evento

JSON

{
  "id": "delivery-ejemplo",
  "event": "PROPERTY_STATUS_CHANGED",
  "livemode": false,
  "createdAt": "2026-10-05T14:03:00.000Z",
  "data": {
    "propertyId": "cm1prop0000000000000000",
    "externalId": "crm-prop-12345",
    "previousStatus": "PUBLISHED",
    "status": "PAUSED",
    "changedAt": "2026-10-05T14:03:00.000Z"
  }
}

Respuestas

Evento recibido y persistido por tu receptor.

Esta respuesta no incluye un cuerpo JSON.

INBOX_MESSAGE_RECEIVED

Entró un mensaje nuevo a la bandeja de entrada.

Cuerpo de la solicitud

application/json

idstringRequerido

Id estable para deduplicar.

eventstringRequerido

"INBOX_MESSAGE_RECEIVED"

livemodebooleanRequerido

createdAtstringRequerido

date-time

dataobjectRequerido

Ver campos

conversationIdstring | nullOpcional

messageIdstringRequerido

channelstringRequerido

contactNamestring | nullOpcional

contactPhonestring | nullOpcional

bodystring | nullOpcional

TochiHub envía este evento a tu receptor. Ver firma y reintentos →

Payload del evento

JSON

{
  "id": "delivery-ejemplo",
  "event": "INBOX_MESSAGE_RECEIVED",
  "livemode": false,
  "createdAt": "2026-10-05T14:03:00.000Z",
  "data": {
    "conversationId": "cm1conv0000000000000000",
    "messageId": "cm1msg00000000000000000",
    "channel": "WHATSAPP",
    "contactName": "Camila Rojas",
    "contactPhone": "+56912345678",
    "body": "¿Puedo visitar el depto el sábado?"
  }
}

Respuestas

Evento recibido y persistido por tu receptor.

Esta respuesta no incluye un cuerpo JSON.

TICKET_CREATED

Se creó un ticket de seguimiento (manual o porque el asistente derivó la conversación).

Cuerpo de la solicitud

application/json

idstringRequerido

Id estable para deduplicar.

eventstringRequerido

"TICKET_CREATED"

livemodebooleanRequerido

createdAtstringRequerido

date-time

dataobjectRequerido

Ver campos

ticketIdstringRequerido

titlestringRequerido

prioritystringRequerido

sourcestringRequerido

conversationIdstring | nullOpcional

TochiHub envía este evento a tu receptor. Ver firma y reintentos →

Payload del evento

JSON

{
  "id": "delivery-ejemplo",
  "event": "TICKET_CREATED",
  "livemode": false,
  "createdAt": "2026-10-05T14:03:00.000Z",
  "data": {
    "ticketId": "cm1tick0000000000000000",
    "title": "Cliente pide visita el sábado",
    "priority": "MEDIUM",
    "source": "BOT_FALLBACK",
    "conversationId": "cm1conv0000000000000000"
  }
}

Respuestas

Evento recibido y persistido por tu receptor.

Esta respuesta no incluye un cuerpo JSON.

CreatePublicPropertyMediaDto

typePropertyMediaTypeOpcional

Tipo de archivo. Solo las IMAGE cuentan para el mínimo de 3 fotos.

Por defecto: "IMAGE"

"IMAGE""VIDEO""TOUR_360""DOCUMENT"

Ver campos

PropertyMediaType

Valores: "IMAGE" "VIDEO" "TOUR_360" "DOCUMENT"

Tipo de archivo. Solo las IMAGE cuentan para el mínimo de 3 fotos.

urlstringRequerido

URL pública (HTTPS) de la foto. Los portales la descargan tal cual: debe ser accesible sin autenticación.

sortOrdernumberOpcional

Orden de la foto; la de menor orden es la portada.

mín. 0

altTextstringOpcional

CreatePublicPropertyDto

titlestringRequerido

Título del aviso. Yapo exige al menos 10 caracteres; TocToc entre 10 y 70.

descriptionstringOpcional

Descripción del aviso en texto plano (si llega HTML se convierte a texto). TocToc exige al menos 50 caracteres.

operationTypeOperationTypeRequerido

SALE = venta, RENT = arriendo.

"SALE""RENT"

Ver campos

OperationType

Valores: "SALE" "RENT"

SALE = venta, RENT = arriendo.

priceValuenumberRequerido

Precio como entero. Los precios en UF también van como entero.

mín. 0

priceCurrencyPriceCurrencyRequerido

"CLP""UF"

Ver campos

PriceCurrency

Valores: "CLP" "UF"

propertyTypestringOpcional

Tipo de propiedad: departamento, casa, oficina, local, terreno, parcela, bodega, estacionamiento.

bedroomsnumberOpcional

Dormitorios.

mín. 0

bathroomsnumberOpcional

Baños.

mín. 0

parkingSpacesnumberOpcional

Estacionamientos.

mín. 0

storageUnitsnumberOpcional

Bodegas.

mín. 0

totalAreaM2numberOpcional

Superficie total en m². En casas, parcelas y terrenos es la superficie del terreno. Admite decimales.

mín. 0

usefulAreaM2numberOpcional

Superficie útil en m². Yapo y TocToc la publican como superficie construida; si falta, Yapo usa la superficie total. Admite decimales.

mín. 0

terraceAreaM2numberOpcional

Superficie de terraza en m². Admite decimales.

mín. 0

commonExpensesnumber | nullOpcional

Gastos comunes mensuales en CLP. Omitirlos o enviar 0 significa "no informado": los portales no muestran gastos comunes. En PATCH, null borra el valor guardado.

yearBuiltnumberOpcional

Año de construcción.

latnumberOpcional

Latitud. Varios portales exigen la ubicación en el mapa.

lngnumberOpcional

Longitud.

addressLinestringOpcional

referencestringOpcional

Referencia de ubicación para el aviso.

propertyRolestringOpcional

Rol de avalúo (SII). TocToc lo lee.

unitNumberstringOpcional

Número de departamento u oficina.

communestringOpcional

Comuna, con tildes y ñ (ej. "Ñuñoa").

regionstringOpcional

amenitiesobjectOpcional

characteristicsobjectOpcional

Datos extra que algunos portales leen (orientation, floorLevel, videoTourUrl, contactName, contactPhone, contactEmail, ...). La clave "external" está reservada.

externalIdstringOpcional

Id estable de la propiedad en tu CRM. Úsalo para encontrarla después con GET /v1/properties?externalId=.

clubIdstringOpcional

Id de una colección (club) de la corredora o global.

statusstringOpcional

Obsoleto: se ignora. El estado se calcula solo (READY cuando tiene título, precio y al menos 3 fotos).

"DRAFT""READY"

mediaCreatePublicPropertyMediaDto[]Opcional

Fotos por URL.

Ver campos del elemento

typePropertyMediaTypeOpcional

Tipo de archivo. Solo las IMAGE cuentan para el mínimo de 3 fotos.

Por defecto: "IMAGE"

"IMAGE""VIDEO""TOUR_360""DOCUMENT"

Ver campos

PropertyMediaType

Valores: "IMAGE" "VIDEO" "TOUR_360" "DOCUMENT"

Tipo de archivo. Solo las IMAGE cuentan para el mínimo de 3 fotos.

urlstringRequerido

URL pública (HTTPS) de la foto. Los portales la descargan tal cual: debe ser accesible sin autenticación.

sortOrdernumberOpcional

Orden de la foto; la de menor orden es la portada.

mín. 0

altTextstringOpcional

Ejemplo JSON

JSON

{
  "title": "Departamento 2D2B a pasos del Metro Manquehue",
  "description": "Departamento luminoso con estacionamiento y bodega, orientación norte.",
  "operationType": "SALE",
  "priceValue": 6250,
  "priceCurrency": "UF",
  "propertyType": "departamento",
  "bedrooms": 2,
  "bathrooms": 2,
  "parkingSpaces": 1,
  "storageUnits": 1,
  "totalAreaM2": 35.2,
  "usefulAreaM2": 33.4,
  "terraceAreaM2": 1.8,
  "commonExpenses": 120000,
  "yearBuilt": 2015,
  "lat": -33.4072,
  "lng": -70.5681,
  "addressLine": "Av. Apoquindo 4501",
  "reference": "A pasos del Metro Manquehue",
  "propertyRole": "123-45",
  "unitNumber": "1203",
  "commune": "Las Condes",
  "region": "Región Metropolitana",
  "amenities": {
    "comfort": {
      "pool": true,
      "gym": true
    },
    "security": {
      "elevator": true
    },
    "special": {
      "furnished": false
    }
  },
  "characteristics": {
    "orientation": "norte",
    "floorLevel": 12
  },
  "externalId": "crm-prop-12345",
  "clubId": "clw2v8c4m0000u7w4mr9db4kn",
  "status": "DRAFT",
  "media": [
    {
      "type": "IMAGE",
      "url": "https://cdn.tu-crm.cl/propiedades/apt-123/principal.jpg",
      "sortOrder": 0,
      "altText": "Living comedor con vista al cerro"
    }
  ]
}

PublicPropertyResponseDto

idstringRequerido

Id de la propiedad en TochiHub.

statusPropertyStatusRequerido

Estado calculado: READY si ya cumple título, precio y 3 fotos.

"DRAFT""READY""PUBLISHED""PAUSED""ARCHIVED"

Ver campos

PropertyStatus

Valores: "DRAFT" "READY" "PUBLISHED" "PAUSED" "ARCHIVED"

Estado calculado: READY si ya cumple título, precio y 3 fotos.

mediaCountnumberRequerido

Cantidad de fotos/archivos asociados.

sandboxbooleanRequerido

true si se creó con una API key de prueba.

createdAtstringRequerido

PublicApiErrorDetailDto

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Ejemplo JSON

JSON

{
  "code": "bad_request",
  "message": "La validación del request falló",
  "details": [
    "title must be a string"
  ],
  "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
  "timestamp": "2026-10-05T14:03:00.000Z"
}

PublicApiErrorDto

errorPublicApiErrorDetailDtoRequerido

Ver campos

codestringRequerido

Código estable para tu código: bad_request, unauthorized, forbidden, not_found, conflict, rate_limit_exceeded, internal_error.

messagestringRequerido

Mensaje legible en español.

detailsobjectOpcional

Detalle opcional (por ejemplo, la lista de campos inválidos).

requestIdstringRequerido

Igual al header x-request-id; inclúyelo al pedir soporte.

timestampstringRequerido

Ejemplo JSON

JSON

{
  "error": {
    "code": "bad_request",
    "message": "La validación del request falló",
    "details": [
      "title must be a string"
    ],
    "requestId": "6c1b2a54-0f7e-4c55-9d0e-1f2b3c4d5e6f",
    "timestamp": "2026-10-05T14:03:00.000Z"
  }
}

PublicPropertyMediaResponseDto

idstringRequerido

Id de la foto. Úsalo para editarla o eliminarla.

urlstringRequerido

typestringRequerido

sortOrdernumberRequerido

altTextstring | nullOpcional

Ejemplo JSON

JSON

{
  "id": "clw2v8c4m0001u7w4abcd1234",
  "url": "https://cdn.tu-crm.cl/propiedades/apt-123/principal.jpg",
  "type": "IMAGE",
  "sortOrder": 0,
  "altText": "Living comedor con vista al cerro"
}

PublicPropertyDetailResponseDto

idstringRequerido

externalIdstring | nullOpcional

Id en tu CRM (el externalId que enviaste).

sandboxbooleanRequerido

true si fue creada con una API key de prueba (nunca llega a portales reales).

titlestringRequerido

descriptionstring | nullOpcional

operationTypeOperationTypeRequerido

SALE = venta, RENT = arriendo.

"SALE""RENT"

Ver campos

OperationType

Valores: "SALE" "RENT"

SALE = venta, RENT = arriendo.

statusPropertyStatusRequerido

DRAFT: faltan datos o fotos. READY: lista para publicar. PUBLISHED: activa en al menos un portal. PAUSED / ARCHIVED.

"DRAFT""READY""PUBLISHED""PAUSED""ARCHIVED"

Ver campos

PropertyStatus

Valores: "DRAFT" "READY" "PUBLISHED" "PAUSED" "ARCHIVED"

DRAFT: faltan datos o fotos. READY: lista para publicar. PUBLISHED: activa en al menos un portal. PAUSED / ARCHIVED.

priceValuenumberRequerido

priceCurrencyPriceCurrencyRequerido

"CLP""UF"

Ver campos

PriceCurrency

Valores: "CLP" "UF"

propertyTypestring | nullOpcional

bedroomsnumber | nullOpcional

bathroomsnumber | nullOpcional

parkingSpacesnumber | nullOpcional

storageUnitsnumber | nullOpcional

totalAreaM2number | nullOpcional

usefulAreaM2number | nullOpcional

terraceAreaM2number | nullOpcional

commonExpensesnumber | nullOpcional

yearBuiltnumber | nullOpcional

latnumber | nullOpcional

lngnumber | nullOpcional

addressLinestring | nullOpcional

unitNumberstring | nullOpcional

communestring | nullOpcional

regionstring | nullOpcional

referencestring | nullOpcional

propertyRolestring | nullOpcional

clubIdstring | nullOpcional

amenitiesobjectRequerido

Amenidades guardadas, en el mismo formato que se envían.

characteristicsobjectRequerido

Características guardadas. Envíalas completas en el PATCH: el objeto se reemplaza entero.

mediaPublicPropertyMediaResponseDto[]Requerido

Ver campos del elemento

idstringRequerido

Id de la foto. Úsalo para editarla o eliminarla.

urlstringRequerido

typestringRequerido

sortOrdernumberRequerido

altTextstring | nullOpcional

createdAtstringRequerido

updatedAtstringRequerido

Ejemplo JSON

JSON

{
  "id": "clw2v8c4m0000u7w4mr9db4kn",
  "externalId": "crm-prop-12345",
  "sandbox": false,
  "title": "Departamento 2D2B a pasos del Metro Manquehue",
  "description": null,
  "operationType": "SALE",
  "status": "DRAFT",
  "priceValue": 6250,
  "priceCurrency": "CLP",
  "propertyType": "departamento",
  "bedrooms": 2,
  "bathrooms": 2,
  "parkingSpaces": 1,
  "storageUnits": 1,
  "totalAreaM2": 35.2,
  "usefulAreaM2": 33.4,
  "terraceAreaM2": 1.8,
  "commonExpenses": 120000,
  "yearBuilt": 2015,
  "lat": -33.4072,
  "lng": -70.5681,
  "addressLine": "Av. Apoquindo 4501",
  "unitNumber": "1203",
  "commune": "Las Condes",
  "region": "Región Metropolitana",
  "reference": "A pasos del Metro Manquehue",
  "propertyRole": "123-45",
  "clubId": "clw2v8c4m0000u7w4mr9db4kn",
  "amenities": {
    "comfort": {
      "pool": true
    },
    "special": {
      "furnished": false
    }
  },
  "characteristics": {
    "orientation": "norte",
    "floorLevel": 12
  },
  "media": [
    {
      "id": "clw2v8c4m0001u7w4abcd1234",
      "url": "https://cdn.tu-crm.cl/propiedades/apt-123/principal.jpg",
      "type": "IMAGE",
      "sortOrder": 0,
      "altText": "Living comedor con vista al cerro"
    }
  ],
  "createdAt": "2026-10-05T14:03:00.000Z",
  "updatedAt": "2026-10-05T14:03:00.000Z"
}

PublicPropertyListResponseDto

itemsPublicPropertyDetailResponseDto[]Requerido

Ver campos del elemento

idstringRequerido

externalIdstring | nullOpcional

Id en tu CRM (el externalId que enviaste).

sandboxbooleanRequerido

true si fue creada con una API key de prueba (nunca llega a portales reales).

titlestringRequerido

descriptionstring | nullOpcional

operationTypeOperationTypeRequerido

SALE = venta, RENT = arriendo.

"SALE""RENT"

Ver campos

OperationType

Valores: "SALE" "RENT"

SALE = venta, RENT = arriendo.

statusPropertyStatusRequerido

DRAFT: faltan datos o fotos. READY: lista para publicar. PUBLISHED: activa en al menos un portal. PAUSED / ARCHIVED.

"DRAFT""READY""PUBLISHED""PAUSED""ARCHIVED"

Ver campos

PropertyStatus

Valores: "DRAFT" "READY" "PUBLISHED" "PAUSED" "ARCHIVED"

DRAFT: faltan datos o fotos. READY: lista para publicar. PUBLISHED: activa en al menos un portal. PAUSED / ARCHIVED.

priceValuenumberRequerido

priceCurrencyPriceCurrencyRequerido

"CLP""UF"

Ver campos

PriceCurrency

Valores: "CLP" "UF"

propertyTypestring | nullOpcional

bedroomsnumber | nullOpcional

bathroomsnumber | nullOpcional

parkingSpacesnumber | nullOpcional

storageUnitsnumber | nullOpcional

totalAreaM2number | nullOpcional

usefulAreaM2number | nullOpcional

terraceAreaM2number | nullOpcional

commonExpensesnumber | nullOpcional

yearBuiltnumber | nullOpcional

latnumber | nullOpcional

lngnumber | nullOpcional

addressLinestring | nullOpcional

unitNumberstring | nullOpcional

communestring | nullOpcional

regionstring | nullOpcional

referencestring | nullOpcional

propertyRolestring | nullOpcional

clubIdstring | nullOpcional

amenitiesobjectRequerido

Amenidades guardadas, en el mismo formato que se envían.

characteristicsobjectRequerido

Características guardadas. Envíalas completas en el PATCH: el objeto se reemplaza entero.

mediaPublicPropertyMediaResponseDto[]Requerido

Ver campos del elemento

idstringRequerido

Id de la foto. Úsalo para editarla o eliminarla.

urlstringRequerido

typestringRequerido

sortOrdernumberRequerido

altTextstring | nullOpcional

createdAtstringRequerido

updatedAtstringRequerido

totalnumberRequerido

Total de resultados con los filtros aplicados.

pagenumberRequerido

limitnumberRequerido

Ejemplo JSON

JSON

{
  "items": [
    {
      "id": "clw2v8c4m0000u7w4mr9db4kn",
      "externalId": "crm-prop-12345",
      "sandbox": false,
      "title": "Departamento 2D2B a pasos del Metro Manquehue",
      "description": null,
      "operationType": "SALE",
      "status": "DRAFT",
      "priceValue": 6250,
      "priceCurrency": "CLP",
      "propertyType": "departamento",
      "bedrooms": 2,
      "bathrooms": 2,
      "parkingSpaces": 1,
      "storageUnits": 1,
      "totalAreaM2": 35.2,
      "usefulAreaM2": 33.4,
      "terraceAreaM2": 1.8,
      "commonExpenses": 120000,
      "yearBuilt": 2015,
      "lat": -33.4072,
      "lng": -70.5681,
      "addressLine": "Av. Apoquindo 4501",
      "unitNumber": "1203",
      "commune": "Las Condes",
      "region": "Región Metropolitana",
      "reference": "A pasos del Metro Manquehue",
      "propertyRole": "123-45",
      "clubId": "clw2v8c4m0000u7w4mr9db4kn",
      "amenities": {
        "comfort": {
          "pool": true
        },
        "special": {
          "furnished": false
        }
      },
      "characteristics": {
        "orientation": "norte",
        "floorLevel": 12
      },
      "media": [
        {
          "id": "clw2v8c4m0001u7w4abcd1234",
          "url": "https://cdn.tu-crm.cl/propiedades/apt-123/principal.jpg",
          "type": "IMAGE",
          "sortOrder": 0,
          "altText": "Living comedor con vista al cerro"
        }
      ],
      "createdAt": "2026-10-05T14:03:00.000Z",
      "updatedAt": "2026-10-05T14:03:00.000Z"
    }
  ],
  "total": 42,
  "page": 1,
  "limit": 20
}

PublicPropertyMetricsTotalsDto

viewsnumberRequerido

Suma de visitas. Un aviso compartido entre Mercado Libre y Portal Inmobiliario se cuenta una sola vez.

contactsnumberRequerido

Suma de contactos de todos los portales.

clicksnumberRequerido

Suma de clics de todos los portales.

PortalCode

string

PublicPortalMetricsDto

portalCodePortalCodeRequerido

"MERCADO_LIBRE""PORTAL_INMOBILIARIO""YAPO""TOCTOC""ENLACE_INMOBILIARIO""CHILE_DEPTOS""DOOMOS""PROPPIT""INSTAGRAM""FACEBOOK_MARKETPLACE""META_ADS""TIKTOK_ADS""TIKTOK"

Ver campos

PortalCode

portalNamestringRequerido

viewsnumber | nullOpcional

Visitas acumuladas del aviso. null = el portal no la informa.

contactsnumber | nullOpcional

Contactos acumulados. null = el portal no lo informa.

clicksnumber | nullOpcional

Clics acumulados. null = el portal no lo informa.

sharedViewsWithPortalCode[]Requerido

measuredAtstringRequerido

Momento en que se leyó este dato del portal.

Ejemplo JSON

JSON

{
  "portalCode": "MERCADO_LIBRE",
  "portalName": "Mercado Libre",
  "views": 1240,
  "contacts": 12,
  "clicks": 80,
  "sharedViewsWith": [
    "PORTAL_INMOBILIARIO"
  ],
  "measuredAt": "2026-10-10T06:00:00.000Z"
}

PublicPropertyMetricsDto

propertyIdstringRequerido

externalIdstring | nullOpcional

totalsPublicPropertyMetricsTotalsDtoRequerido

Ver campos

viewsnumberRequerido

Suma de visitas. Un aviso compartido entre Mercado Libre y Portal Inmobiliario se cuenta una sola vez.

contactsnumberRequerido

Suma de contactos de todos los portales.

clicksnumberRequerido

Suma de clics de todos los portales.

portalsPublicPortalMetricsDto[]Requerido

Último dato por portal. Un portal sin estadísticas no aparece.

Ver campos del elemento

portalCodePortalCodeRequerido

"MERCADO_LIBRE""PORTAL_INMOBILIARIO""YAPO""TOCTOC""ENLACE_INMOBILIARIO""CHILE_DEPTOS""DOOMOS""PROPPIT""INSTAGRAM""FACEBOOK_MARKETPLACE""META_ADS""TIKTOK_ADS""TIKTOK"

Ver campos

PortalCode

portalNamestringRequerido

viewsnumber | nullOpcional

Visitas acumuladas del aviso. null = el portal no la informa.

contactsnumber | nullOpcional

Contactos acumulados. null = el portal no lo informa.

clicksnumber | nullOpcional

Clics acumulados. null = el portal no lo informa.

sharedViewsWithPortalCode[]Requerido

measuredAtstringRequerido

Momento en que se leyó este dato del portal.

Ejemplo JSON

JSON

{
  "propertyId": "clw2v8c4m0000u7w4mr9db4kn",
  "externalId": "crm-prop-12345",
  "totals": {
    "views": 1890,
    "contacts": 21,
    "clicks": 140
  },
  "portals": [
    {
      "portalCode": "MERCADO_LIBRE",
      "portalName": "Mercado Libre",
      "views": 1240,
      "contacts": 12,
      "clicks": 80,
      "sharedViewsWith": [
        "PORTAL_INMOBILIARIO"
      ],
      "measuredAt": "2026-10-10T06:00:00.000Z"
    }
  ]
}

UpdatePublicPropertyDto

titlestringOpcional

Título del aviso. Yapo exige al menos 10 caracteres; TocToc entre 10 y 70.

descriptionstringOpcional

Descripción del aviso en texto plano (si llega HTML se convierte a texto). TocToc exige al menos 50 caracteres.

operationTypeOperationTypeOpcional

SALE = venta, RENT = arriendo.

"SALE""RENT"

Ver campos

OperationType

Valores: "SALE" "RENT"

SALE = venta, RENT = arriendo.

priceValuenumberOpcional

Precio como entero. Los precios en UF también van como entero.

mín. 0

priceCurrencyPriceCurrencyOpcional

"CLP""UF"

Ver campos

PriceCurrency

Valores: "CLP" "UF"

propertyTypestringOpcional

Tipo de propiedad: departamento, casa, oficina, local, terreno, parcela, bodega, estacionamiento.

bedroomsnumberOpcional

Dormitorios.

mín. 0

bathroomsnumberOpcional

Baños.

mín. 0

parkingSpacesnumberOpcional

Estacionamientos.

mín. 0

storageUnitsnumberOpcional

Bodegas.

mín. 0

totalAreaM2numberOpcional

Superficie total en m². En casas, parcelas y terrenos es la superficie del terreno. Admite decimales.

mín. 0

usefulAreaM2numberOpcional

Superficie útil en m². Yapo y TocToc la publican como superficie construida; si falta, Yapo usa la superficie total. Admite decimales.

mín. 0

terraceAreaM2numberOpcional

Superficie de terraza en m². Admite decimales.

mín. 0

commonExpensesnumber | nullOpcional

Gastos comunes mensuales en CLP. Omitirlos o enviar 0 significa "no informado": los portales no muestran gastos comunes. En PATCH, null borra el valor guardado.

yearBuiltnumberOpcional

Año de construcción.

latnumberOpcional

Latitud. Varios portales exigen la ubicación en el mapa.

lngnumberOpcional

Longitud.

addressLinestringOpcional

referencestringOpcional

Referencia de ubicación para el aviso.

propertyRolestringOpcional

Rol de avalúo (SII). TocToc lo lee.

unitNumberstringOpcional

Número de departamento u oficina.

communestringOpcional

Comuna, con tildes y ñ (ej. "Ñuñoa").

regionstringOpcional

amenitiesobjectOpcional

characteristicsobjectOpcional

Datos extra que algunos portales leen (orientation, floorLevel, videoTourUrl, contactName, contactPhone, contactEmail, ...). La clave "external" está reservada.

externalIdstringOpcional

Id estable de la propiedad en tu CRM.

Ejemplo JSON

JSON

{
  "title": "Departamento 2D2B a pasos del Metro Manquehue",
  "description": "Departamento luminoso con estacionamiento y bodega, orientación norte.",
  "operationType": "SALE",
  "priceValue": 6250,
  "priceCurrency": "UF",
  "propertyType": "departamento",
  "bedrooms": 2,
  "bathrooms": 2,
  "parkingSpaces": 1,
  "storageUnits": 1,
  "totalAreaM2": 35.2,
  "usefulAreaM2": 33.4,
  "terraceAreaM2": 1.8,
  "commonExpenses": 120000,
  "yearBuilt": 2015,
  "lat": -33.4072,
  "lng": -70.5681,
  "addressLine": "Av. Apoquindo 4501",
  "reference": "A pasos del Metro Manquehue",
  "propertyRole": "123-45",
  "unitNumber": "1203",
  "commune": "Las Condes",
  "region": "Región Metropolitana",
  "amenities": {
    "comfort": {
      "pool": true,
      "gym": true
    },
    "security": {
      "elevator": true
    },
    "special": {
      "furnished": false
    }
  },
  "characteristics": {
    "orientation": "norte",
    "floorLevel": 12
  },
  "externalId": "crm-prop-12345"
}

AddPublicPropertyMediaDto

mediaCreatePublicPropertyMediaDto[]Requerido

1 elementos mín.30 elementos máx.

Ver campos del elemento

typePropertyMediaTypeOpcional

Tipo de archivo. Solo las IMAGE cuentan para el mínimo de 3 fotos.

Por defecto: "IMAGE"

"IMAGE""VIDEO""TOUR_360""DOCUMENT"

Ver campos

PropertyMediaType

Valores: "IMAGE" "VIDEO" "TOUR_360" "DOCUMENT"

Tipo de archivo. Solo las IMAGE cuentan para el mínimo de 3 fotos.

urlstringRequerido

URL pública (HTTPS) de la foto. Los portales la descargan tal cual: debe ser accesible sin autenticación.

sortOrdernumberOpcional

Orden de la foto; la de menor orden es la portada.

mín. 0

altTextstringOpcional

Ejemplo JSON

JSON

{
  "media": [
    {
      "type": "IMAGE",
      "url": "https://cdn.tu-crm.cl/propiedades/apt-123/principal.jpg",
      "sortOrder": 0,
      "altText": "Living comedor con vista al cerro"
    }
  ]
}

UpdatePublicPropertyMediaDto

sortOrdernumberOpcional

Nuevo orden; la de menor orden es la portada.

mín. 0

altTextstringOpcional

PublicPortalQuotaDto

activenumberRequerido

Avisos activos (SUCCESS) de la corredora en este portal.

limitnumber | nullOpcional

Máximo de avisos activos según el plan. null = sin límite; 0 = el plan no incluye el portal.

remainingnumber | nullOpcional

Cupos libres. null = sin límite.

PublicPortalSyncDto

inProgressnumberRequerido

Publicaciones en cola o en proceso (QUEUED, RUNNING, RETRYING).

failednumberRequerido

Publicaciones con error definitivo (FAILED). Consulta el detalle por propiedad.

statsLastSyncedAtstring | nullOpcional

Última lectura exitosa de estadísticas de este portal. null = nunca.

statsLastAttemptAtstring | nullOpcional

Último intento de leer estadísticas, exitoso o no.

statsLastErrorstring | nullOpcional

Error del último intento si falló; null si fue exitoso.

PublicPortalDto

codePortalCodeRequerido

"MERCADO_LIBRE""PORTAL_INMOBILIARIO""YAPO""TOCTOC""ENLACE_INMOBILIARIO""CHILE_DEPTOS""DOOMOS""PROPPIT""INSTAGRAM""FACEBOOK_MARKETPLACE""META_ADS""TIKTOK_ADS""TIKTOK"

Ver campos

PortalCode

namestringRequerido

availablebooleanRequerido

true si se puede publicar en este portal ahora mismo.

statusstringRequerido

"AVAILABLE""QUOTA_EXHAUSTED""MISSING_CREDENTIALS""NOT_IN_PLAN""PLAN_INACTIVE"

statusDescriptionstringRequerido

credentialSourcestring | nullOpcional

Cuenta que se usa para publicar: la propia de la corredora o la de TochiHub. null = ninguna.

"BROKER""PLATFORM"

credentialValidatedAtstring | nullOpcional

Última validación exitosa de esa cuenta.

quotaPublicPortalQuotaDtoRequerido

Ver campos

activenumberRequerido

Avisos activos (SUCCESS) de la corredora en este portal.

limitnumber | nullOpcional

Máximo de avisos activos según el plan. null = sin límite; 0 = el plan no incluye el portal.

remainingnumber | nullOpcional

Cupos libres. null = sin límite.

syncPublicPortalSyncDtoRequerido

Ver campos

inProgressnumberRequerido

Publicaciones en cola o en proceso (QUEUED, RUNNING, RETRYING).

failednumberRequerido

Publicaciones con error definitivo (FAILED). Consulta el detalle por propiedad.

statsLastSyncedAtstring | nullOpcional

Última lectura exitosa de estadísticas de este portal. null = nunca.

statsLastAttemptAtstring | nullOpcional

Último intento de leer estadísticas, exitoso o no.

statsLastErrorstring | nullOpcional

Error del último intento si falló; null si fue exitoso.

Ejemplo JSON

JSON

{
  "code": "MERCADO_LIBRE",
  "name": "Mercado Libre",
  "available": true,
  "status": "AVAILABLE",
  "statusDescription": "Disponible para publicar.",
  "credentialSource": "BROKER",
  "credentialValidatedAt": "2026-10-01T12:00:00.000Z",
  "quota": {
    "active": 37,
    "limit": 100,
    "remaining": 63
  },
  "sync": {
    "inProgress": 2,
    "failed": 1,
    "statsLastSyncedAt": "2026-10-10T06:00:00.000Z",
    "statsLastAttemptAt": "2026-10-10T06:00:00.000Z",
    "statsLastError": null
  }
}

ValidatePropertyDto

propertyIdstringOpcional

Valida una propiedad ya creada. Usa esto o property.

propertyCreatePublicPropertyDtoOpcional

Valida un payload sin crearlo (mismo formato que POST /v1/properties).

Ver campos

titlestringRequerido

Título del aviso. Yapo exige al menos 10 caracteres; TocToc entre 10 y 70.

descriptionstringOpcional

Descripción del aviso en texto plano (si llega HTML se convierte a texto). TocToc exige al menos 50 caracteres.

operationTypeOperationTypeRequerido

SALE = venta, RENT = arriendo.

"SALE""RENT"

Ver campos

OperationType

Valores: "SALE" "RENT"

SALE = venta, RENT = arriendo.

priceValuenumberRequerido

Precio como entero. Los precios en UF también van como entero.

mín. 0

priceCurrencyPriceCurrencyRequerido

"CLP""UF"

Ver campos

PriceCurrency

Valores: "CLP" "UF"

propertyTypestringOpcional

Tipo de propiedad: departamento, casa, oficina, local, terreno, parcela, bodega, estacionamiento.

bedroomsnumberOpcional

Dormitorios.

mín. 0

bathroomsnumberOpcional

Baños.

mín. 0

parkingSpacesnumberOpcional

Estacionamientos.

mín. 0

storageUnitsnumberOpcional

Bodegas.

mín. 0

totalAreaM2numberOpcional

Superficie total en m². En casas, parcelas y terrenos es la superficie del terreno. Admite decimales.

mín. 0

usefulAreaM2numberOpcional

Superficie útil en m². Yapo y TocToc la publican como superficie construida; si falta, Yapo usa la superficie total. Admite decimales.

mín. 0

terraceAreaM2numberOpcional

Superficie de terraza en m². Admite decimales.

mín. 0

commonExpensesnumber | nullOpcional

Gastos comunes mensuales en CLP. Omitirlos o enviar 0 significa "no informado": los portales no muestran gastos comunes. En PATCH, null borra el valor guardado.

yearBuiltnumberOpcional

Año de construcción.

latnumberOpcional

Latitud. Varios portales exigen la ubicación en el mapa.

lngnumberOpcional

Longitud.

addressLinestringOpcional

referencestringOpcional

Referencia de ubicación para el aviso.

propertyRolestringOpcional

Rol de avalúo (SII). TocToc lo lee.

unitNumberstringOpcional

Número de departamento u oficina.

communestringOpcional

Comuna, con tildes y ñ (ej. "Ñuñoa").

regionstringOpcional

amenitiesobjectOpcional

characteristicsobjectOpcional

Datos extra que algunos portales leen (orientation, floorLevel, videoTourUrl, contactName, contactPhone, contactEmail, ...). La clave "external" está reservada.

externalIdstringOpcional

Id estable de la propiedad en tu CRM. Úsalo para encontrarla después con GET /v1/properties?externalId=.

clubIdstringOpcional

Id de una colección (club) de la corredora o global.

statusstringOpcional

Obsoleto: se ignora. El estado se calcula solo (READY cuando tiene título, precio y al menos 3 fotos).

"DRAFT""READY"

mediaCreatePublicPropertyMediaDto[]Opcional

Fotos por URL.

Ver campos del elemento

typePropertyMediaTypeOpcional

Tipo de archivo. Solo las IMAGE cuentan para el mínimo de 3 fotos.

Por defecto: "IMAGE"

"IMAGE""VIDEO""TOUR_360""DOCUMENT"

Ver campos

PropertyMediaType

Valores: "IMAGE" "VIDEO" "TOUR_360" "DOCUMENT"

Tipo de archivo. Solo las IMAGE cuentan para el mínimo de 3 fotos.

urlstringRequerido

URL pública (HTTPS) de la foto. Los portales la descargan tal cual: debe ser accesible sin autenticación.

sortOrdernumberOpcional

Orden de la foto; la de menor orden es la portada.

mín. 0

altTextstringOpcional

portalsPortalCode[]Opcional

Portales a validar. Por defecto, los habilitados para tu corredora.

Ejemplo JSON

JSON

{
  "propertyId": "clw2v8c4m0000u7w4mr9db4kn",
  "property": {
    "title": "Departamento 2D2B a pasos del Metro Manquehue",
    "description": "Departamento luminoso con estacionamiento y bodega, orientación norte.",
    "operationType": "SALE",
    "priceValue": 6250,
    "priceCurrency": "UF",
    "propertyType": "departamento",
    "bedrooms": 2,
    "bathrooms": 2,
    "parkingSpaces": 1,
    "storageUnits": 1,
    "totalAreaM2": 35.2,
    "usefulAreaM2": 33.4,
    "terraceAreaM2": 1.8,
    "commonExpenses": 120000,
    "yearBuilt": 2015,
    "lat": -33.4072,
    "lng": -70.5681,
    "addressLine": "Av. Apoquindo 4501",
    "reference": "A pasos del Metro Manquehue",
    "propertyRole": "123-45",
    "unitNumber": "1203",
    "commune": "Las Condes",
    "region": "Región Metropolitana",
    "amenities": {
      "comfort": {
        "pool": true,
        "gym": true
      },
      "security": {
        "elevator": true
      },
      "special": {
        "furnished": false
      }
    },
    "characteristics": {
      "orientation": "norte",
      "floorLevel": 12
    },
    "externalId": "crm-prop-12345",
    "clubId": "clw2v8c4m0000u7w4mr9db4kn",
    "status": "DRAFT",
    "media": [
      {
        "type": "IMAGE",
        "url": "https://cdn.tu-crm.cl/propiedades/apt-123/principal.jpg",
        "sortOrder": 0,
        "altText": "Living comedor con vista al cerro"
      }
    ]
  },
  "portals": [
    "MERCADO_LIBRE"
  ]
}

PublicationIssueDto

messagestringRequerido

Mensaje original del portal o de la validación.

descriptionstringRequerido

Explicación en español, lista para mostrar.

PortalValidationDto

portalCodePortalCodeRequerido

"MERCADO_LIBRE""PORTAL_INMOBILIARIO""YAPO""TOCTOC""ENLACE_INMOBILIARIO""CHILE_DEPTOS""DOOMOS""PROPPIT""INSTAGRAM""FACEBOOK_MARKETPLACE""META_ADS""TIKTOK_ADS""TIKTOK"

Ver campos

PortalCode

validbooleanRequerido

errorsPublicationIssueDto[]Requerido

Ver campos del elemento

messagestringRequerido

Mensaje original del portal o de la validación.

descriptionstringRequerido

Explicación en español, lista para mostrar.

Ejemplo JSON

JSON

{
  "portalCode": "MERCADO_LIBRE",
  "valid": false,
  "errors": [
    {
      "message": "Yapo requires the built area (square, m²) on the property.",
      "description": "Falta la superficie construida (m²)."
    }
  ]
}

PropertyValidationResultDto

validbooleanRequerido

true solo si pasa en todos los portales pedidos.

portalsPortalValidationDto[]Requerido

Ver campos del elemento

portalCodePortalCodeRequerido

"MERCADO_LIBRE""PORTAL_INMOBILIARIO""YAPO""TOCTOC""ENLACE_INMOBILIARIO""CHILE_DEPTOS""DOOMOS""PROPPIT""INSTAGRAM""FACEBOOK_MARKETPLACE""META_ADS""TIKTOK_ADS""TIKTOK"

Ver campos

PortalCode

validbooleanRequerido

errorsPublicationIssueDto[]Requerido

Ver campos del elemento

messagestringRequerido

Mensaje original del portal o de la validación.

descriptionstringRequerido

Explicación en español, lista para mostrar.

Ejemplo JSON

JSON

{
  "valid": false,
  "portals": [
    {
      "portalCode": "MERCADO_LIBRE",
      "valid": false,
      "errors": [
        {
          "message": "Yapo requires the built area (square, m²) on the property.",
          "description": "Falta la superficie construida (m²)."
        }
      ]
    }
  ]
}

PublicationStatus

string

Valores: "PENDING" "QUEUED" "RUNNING" "SUCCESS" "FAILED" "RETRYING" "CANCELED" "UNPUBLISHED"

QUEUED/RUNNING/RETRYING: en curso. SUCCESS: activa. FAILED: falló (ver lastErrorDescription). UNPUBLISHED: dada de baja.

PublicationStatusDto

portalCodePortalCodeRequerido

"MERCADO_LIBRE""PORTAL_INMOBILIARIO""YAPO""TOCTOC""ENLACE_INMOBILIARIO""CHILE_DEPTOS""DOOMOS""PROPPIT""INSTAGRAM""FACEBOOK_MARKETPLACE""META_ADS""TIKTOK_ADS""TIKTOK"

Ver campos

PortalCode

portalNamestringRequerido

statusPublicationStatusRequerido

QUEUED/RUNNING/RETRYING: en curso. SUCCESS: activa. FAILED: falló (ver lastErrorDescription). UNPUBLISHED: dada de baja.

"PENDING""QUEUED""RUNNING""SUCCESS""FAILED""RETRYING""CANCELED""UNPUBLISHED"

Ver campos

PublicationStatus

Valores: "PENDING" "QUEUED" "RUNNING" "SUCCESS" "FAILED" "RETRYING" "CANCELED" "UNPUBLISHED"

QUEUED/RUNNING/RETRYING: en curso. SUCCESS: activa. FAILED: falló (ver lastErrorDescription). UNPUBLISHED: dada de baja.

externalUrlstring | nullOpcional

lastErrorstring | nullOpcional

Mensaje original del portal.

lastErrorDescriptionstring | nullOpcional

El mismo error explicado en español.

updatedAtstringRequerido

Ejemplo JSON

JSON

{
  "portalCode": "MERCADO_LIBRE",
  "portalName": "Yapo",
  "status": "PENDING",
  "externalUrl": "https://www.yapo.cl/...",
  "lastError": null,
  "lastErrorDescription": null,
  "updatedAt": "2026-10-05T14:03:00.000Z"
}

PublishPortalsDto

portalsPortalCode[]Requerido

Portales destino. Usa GET /v1/portals para ver los habilitados para tu corredora.

PublicationRequestResultDto

portalCodePortalCodeRequerido

"MERCADO_LIBRE""PORTAL_INMOBILIARIO""YAPO""TOCTOC""ENLACE_INMOBILIARIO""CHILE_DEPTOS""DOOMOS""PROPPIT""INSTAGRAM""FACEBOOK_MARKETPLACE""META_ADS""TIKTOK_ADS""TIKTOK"

Ver campos

PortalCode

acceptedbooleanRequerido

true si el portal quedó encolado (producción) o simulado con éxito (sandbox).

statusPublicationStatusOpcional

QUEUED/RUNNING/RETRYING: en curso. SUCCESS: activa. FAILED: falló (ver lastErrorDescription). UNPUBLISHED: dada de baja.

"PENDING""QUEUED""RUNNING""SUCCESS""FAILED""RETRYING""CANCELED""UNPUBLISHED"

Ver campos

PublicationStatus

Valores: "PENDING" "QUEUED" "RUNNING" "SUCCESS" "FAILED" "RETRYING" "CANCELED" "UNPUBLISHED"

QUEUED/RUNNING/RETRYING: en curso. SUCCESS: activa. FAILED: falló (ver lastErrorDescription). UNPUBLISHED: dada de baja.

errorPublicationIssueDtoOpcional

Ver campos

messagestringRequerido

Mensaje original del portal o de la validación.

descriptionstringRequerido

Explicación en español, lista para mostrar.

Ejemplo JSON

JSON

{
  "portalCode": "MERCADO_LIBRE",
  "accepted": true,
  "status": "QUEUED",
  "error": {
    "message": "Yapo requires the built area (square, m²) on the property.",
    "description": "Falta la superficie construida (m²)."
  }
}

PublicUsagePlanDto

namestringRequerido

activebooleanRequerido

false si el plan está suspendido: no se pueden crear ni publicar propiedades.

PublicUsagePropertiesDto

activenumberRequerido

Propiedades que cuentan para el cupo (todas menos las archivadas).

limitnumber | nullOpcional

Máximo de propiedades del plan. null = sin límite.

remainingnumber | nullOpcional

Propiedades que aún puedes crear. null = sin límite.

PublicUsageDto

planPublicUsagePlanDtoRequerido

Ver campos

namestringRequerido

activebooleanRequerido

false si el plan está suspendido: no se pueden crear ni publicar propiedades.

propertiesPublicUsagePropertiesDtoRequerido

Ver campos

activenumberRequerido

Propiedades que cuentan para el cupo (todas menos las archivadas).

limitnumber | nullOpcional

Máximo de propiedades del plan. null = sin límite.

remainingnumber | nullOpcional

Propiedades que aún puedes crear. null = sin límite.

portalsNotestringRequerido

Ejemplo JSON

JSON

{
  "plan": {
    "name": "Growth",
    "active": true
  },
  "properties": {
    "active": 187,
    "limit": 200,
    "remaining": 13
  },
  "portalsNote": "Los avisos activos y el cupo de cada portal están en GET /v1/portals."
}

PublicLeadDto

idstringRequerido

Identificador del lead.

propertyIdstringRequerido

Propiedad consultada.

channelstringRequerido

"MANUAL""INTERNAL_FORM""WHATSAPP""PORTAL_CONTACT"

portalCodestring | nullRequerido

Código del portal, si corresponde.

contactNamestring | nullRequerido

contactPhonestring | nullRequerido

contactEmailstring | nullRequerido

messagestring | nullRequerido

respondedAtstring | nullRequerido

Fecha de respuesta registrada.

createdAtstringRequerido

Ejemplo JSON

JSON

{
  "id": "cm1lead0000000000000000",
  "propertyId": "cm1prop0000000000000000",
  "channel": "PORTAL_CONTACT",
  "portalCode": "YAPO",
  "contactName": "Camila Rojas",
  "contactPhone": "+56912345678",
  "contactEmail": "camila@example.com",
  "message": "¿Sigue disponible?",
  "respondedAt": null,
  "createdAt": "2026-10-05T14:03:00.000Z"
}

PublicLeadListDto

itemsPublicLeadDto[]Requerido

Ver campos del elemento

idstringRequerido

Identificador del lead.

propertyIdstringRequerido

Propiedad consultada.

channelstringRequerido

"MANUAL""INTERNAL_FORM""WHATSAPP""PORTAL_CONTACT"

portalCodestring | nullRequerido

Código del portal, si corresponde.

contactNamestring | nullRequerido

contactPhonestring | nullRequerido

contactEmailstring | nullRequerido

messagestring | nullRequerido

respondedAtstring | nullRequerido

Fecha de respuesta registrada.

createdAtstringRequerido

totalnumberRequerido

pagenumberRequerido

limitnumberRequerido

Ejemplo JSON

JSON

{
  "items": [
    {
      "id": "cm1lead0000000000000000",
      "propertyId": "cm1prop0000000000000000",
      "channel": "PORTAL_CONTACT",
      "portalCode": "YAPO",
      "contactName": "Camila Rojas",
      "contactPhone": "+56912345678",
      "contactEmail": "camila@example.com",
      "message": "¿Sigue disponible?",
      "respondedAt": null,
      "createdAt": "2026-10-05T14:03:00.000Z"
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 20
}

Webhook_LEAD_CREATED

idstringRequerido

Id estable para deduplicar.

eventstringRequerido

"LEAD_CREATED"

livemodebooleanRequerido

createdAtstringRequerido

date-time

dataobjectRequerido

Ver campos

leadIdstringRequerido

propertyIdstringRequerido

channelstringRequerido

contactNamestring | nullOpcional

contactPhonestring | nullOpcional

contactEmailstring | nullOpcional

messagestring | nullOpcional

createdAtstringRequerido

Ejemplo JSON

JSON

{
  "id": "delivery-ejemplo",
  "event": "LEAD_CREATED",
  "livemode": false,
  "createdAt": "2026-10-05T14:03:00.000Z",
  "data": {
    "leadId": "cm1lead0000000000000000",
    "propertyId": "cm1prop0000000000000000",
    "channel": "PORTAL_CONTACT",
    "contactName": "Camila Rojas",
    "contactPhone": "+56912345678",
    "contactEmail": "camila@example.com",
    "message": "Hola, ¿sigue disponible el departamento?",
    "createdAt": "2026-10-05T14:03:00.000Z"
  }
}

Webhook_PROPERTY_CREATED

idstringRequerido

Id estable para deduplicar.

eventstringRequerido

"PROPERTY_CREATED"

livemodebooleanRequerido

createdAtstringRequerido

date-time

dataobjectRequerido

Ver campos

propertyIdstringRequerido

externalIdstringRequerido

titlestringRequerido

operationTypestringRequerido

statusstringRequerido

createdAtstringRequerido

Ejemplo JSON

JSON

{
  "id": "delivery-ejemplo",
  "event": "PROPERTY_CREATED",
  "livemode": false,
  "createdAt": "2026-10-05T14:03:00.000Z",
  "data": {
    "propertyId": "cm1prop0000000000000000",
    "externalId": "crm-prop-12345",
    "title": "Departamento 2D2B en Providencia",
    "operationType": "SALE",
    "status": "DRAFT",
    "createdAt": "2026-10-05T14:03:00.000Z"
  }
}

Webhook_PROPERTY_PUBLICATION_COMPLETED

idstringRequerido

Id estable para deduplicar.

eventstringRequerido

"PROPERTY_PUBLICATION_COMPLETED"

livemodebooleanRequerido

createdAtstringRequerido

date-time

dataobjectRequerido

Ver campos

propertyIdstringRequerido

externalIdstringRequerido

portalCodestringRequerido

actionstringRequerido

succeededbooleanRequerido

errorMessagestring | nullOpcional

errorDescriptionstring | nullOpcional

Ejemplo JSON

JSON

{
  "id": "delivery-ejemplo",
  "event": "PROPERTY_PUBLICATION_COMPLETED",
  "livemode": false,
  "createdAt": "2026-10-05T14:03:00.000Z",
  "data": {
    "propertyId": "cm1prop0000000000000000",
    "externalId": "crm-prop-12345",
    "portalCode": "YAPO",
    "action": "PUBLISH",
    "succeeded": false,
    "errorMessage": "Yapo requires the built area (square, m²) on the property.",
    "errorDescription": "Falta la superficie construida (m²)."
  }
}

Webhook_PROPERTY_UPDATED

idstringRequerido

Id estable para deduplicar.

eventstringRequerido

"PROPERTY_UPDATED"

livemodebooleanRequerido

createdAtstringRequerido

date-time

dataobjectRequerido

Ver campos

propertyIdstringRequerido

externalIdstringRequerido

statusstringRequerido

updatedAtstringRequerido

Ejemplo JSON

JSON

{
  "id": "delivery-ejemplo",
  "event": "PROPERTY_UPDATED",
  "livemode": false,
  "createdAt": "2026-10-05T14:03:00.000Z",
  "data": {
    "propertyId": "cm1prop0000000000000000",
    "externalId": "crm-prop-12345",
    "status": "PUBLISHED",
    "updatedAt": "2026-10-05T14:03:00.000Z"
  }
}

Webhook_PROPERTY_STATUS_CHANGED

idstringRequerido

Id estable para deduplicar.

eventstringRequerido

"PROPERTY_STATUS_CHANGED"

livemodebooleanRequerido

createdAtstringRequerido

date-time

dataobjectRequerido

Ver campos

propertyIdstringRequerido

externalIdstringRequerido

previousStatusstringRequerido

statusstringRequerido

changedAtstringRequerido

Ejemplo JSON

JSON

{
  "id": "delivery-ejemplo",
  "event": "PROPERTY_STATUS_CHANGED",
  "livemode": false,
  "createdAt": "2026-10-05T14:03:00.000Z",
  "data": {
    "propertyId": "cm1prop0000000000000000",
    "externalId": "crm-prop-12345",
    "previousStatus": "PUBLISHED",
    "status": "PAUSED",
    "changedAt": "2026-10-05T14:03:00.000Z"
  }
}

Webhook_INBOX_MESSAGE_RECEIVED

idstringRequerido

Id estable para deduplicar.

eventstringRequerido

"INBOX_MESSAGE_RECEIVED"

livemodebooleanRequerido

createdAtstringRequerido

date-time

dataobjectRequerido

Ver campos

conversationIdstring | nullOpcional

messageIdstringRequerido

channelstringRequerido

contactNamestring | nullOpcional

contactPhonestring | nullOpcional

bodystring | nullOpcional

Ejemplo JSON

JSON

{
  "id": "delivery-ejemplo",
  "event": "INBOX_MESSAGE_RECEIVED",
  "livemode": false,
  "createdAt": "2026-10-05T14:03:00.000Z",
  "data": {
    "conversationId": "cm1conv0000000000000000",
    "messageId": "cm1msg00000000000000000",
    "channel": "WHATSAPP",
    "contactName": "Camila Rojas",
    "contactPhone": "+56912345678",
    "body": "¿Puedo visitar el depto el sábado?"
  }
}

Webhook_TICKET_CREATED

idstringRequerido

Id estable para deduplicar.

eventstringRequerido

"TICKET_CREATED"

livemodebooleanRequerido

createdAtstringRequerido

date-time

dataobjectRequerido

Ver campos

ticketIdstringRequerido

titlestringRequerido

prioritystringRequerido

sourcestringRequerido

conversationIdstring | nullOpcional

Ejemplo JSON

JSON

{
  "id": "delivery-ejemplo",
  "event": "TICKET_CREATED",
  "livemode": false,
  "createdAt": "2026-10-05T14:03:00.000Z",
  "data": {
    "ticketId": "cm1tick0000000000000000",
    "title": "Cliente pide visita el sábado",
    "priority": "MEDIUM",
    "source": "BOT_FALLBACK",
    "conversationId": "cm1conv0000000000000000"
  }
}