Actualizar propiedad
PATCH
https://api.bydomu.com/v1/properties/{id}This reference is generated from the API’s code, so descriptions are in Spanish. Names, parameters and examples are the same in every language.
Actualiza solo los campos enviados. Cambiar price o status emite los eventos de dominio correspondientes (property.price_changed, property.status_changed).
Permission
properties:writeKeys
Secret only (server-side)
Headers
X-API-KeystringrequiredYour secret key.
Idempotency-KeystringClave única de la operación (8-128 caracteres de
[a-zA-Z0-9._:-]). Un reintento con la misma clave y el mismo cuerpo devuelve la respuesta original sin repetir la operación. Vive 24 horas. · 8–128 charsPath parameters
idstringrequiredID de la propiedad
Body (JSON)
titlestring5–200 chars
typestringAPARTMENTHOUSEOFFICECOMMERCIALLANDWAREHOUSEROOMFARMOTHERtransactionTypestringSALERENTSALE_OR_RENTrentalServiceTypestringBROKERAGEMANAGEMENT · nullableaddressstring≤ 300 chars
neighborhoodstring≤ 100 chars
citystring2–100 chars
statestring≤ 100 chars
countrystringdefault="CO"
zipCodestring≤ 20 chars
latitudenumber-90–90 · nullable
longitudenumber-180–180 · nullable
locationPrecisionstringEXACTAPPROXIMATEpricenumber≥ 0
currencystringCOPUSDEURMXNBRLARSBOBCADCLPCRCCUPDOPGBPGTQHNLNIOPENPYGUYUVES · default="COP"rentPricenumber≥ 0 · nullable
adminFeenumber≥ 0 · nullable
securityDepositnumber≥ 0 · nullable
bedroomsinteger≥ 0 · nullable
bathroomsinteger≥ 0 · nullable
halfBathroomsinteger≥ 0 · nullable
totalRoomsinteger≥ 0 · nullable
closetsinteger≥ 0 · nullable
parkingSpotsinteger≥ 0 · nullable
areanumber≥ 0 · nullable
builtAreanumber≥ 0 · nullable
floorintegernullable
totalFloorsinteger≥ 0 · nullable
yearBuiltinteger1900–2035 · nullable
stratuminteger1–6 · nullable
elevatorbooleanfurnishedstringUNFURNISHEDSEMI_FURNISHEDFURNISHED · nullableorientationstringNORTHSOUTHEASTWESTNORTHEASTNORTHWESTSOUTHEASTSOUTHWEST · nullablepetFriendlybooleangarageTypestringNONECOVEREDUNCOVEREDDOUBLEUNDERGROUND · nullableheatingTypestringNONECENTRALELECTRICGASRADIANT · nullablewaterHeaterbooleangasConnectionbooleanviewTypestringNONECITYMOUNTAINSEAGARDENPOOLINTERIORPANORAMIC · nullablesecurityLevelstringNONEBASICMEDIUMHIGHGATED_COMMUNITY · nullablepropertyConditionstringNEWEXCELLENTGOODFAIRNEEDS_RENOVATIONUNDER_CONSTRUCTIONPRE_SALE · nullablelegalStatusstringCLEARMORTGAGELIENIN_PROCESSINHERITANCE · nullableamenitiesstring[]customFieldsobjectdescriptionstring≤ 5000 chars
virtualTourUrlstring | stringtour3dUrlstring | stringvideoUrlstring | stringinternalNotesstring≤ 2000 chars
statusstringDRAFTACTIVERESERVEDSOLDRENTEDINACTIVE · default="DRAFT"agentIdstringcontactOwnerIdstringnullable
isFeaturedbooleanimagesobject[]Responses
200Propiedad actualizada
400Datos inválidos: el cuerpo o la query no cumplen el esquema, o `Idempotency-Key` está mal formada.
401
UNAUTHORIZED · Clave faltante, inválida, desactivada o vencida.402
PAYMENT_REQUIRED · Cuenta en modo solo lectura: se rechaza toda mutación.403
FORBIDDEN · La clave no puede usar esta operación: falta el scope, es una secreta en el navegador, el nivel de la cuenta no la permite, está suspendida o se alcanzó un tope del plan.404
NOT_FOUND · El recurso no existe en la organización.409
DUPLICATE · Choca con un dato existente o con el estado actual, o la `Idempotency-Key` ya se usó con otro cuerpo o sigue en curso.429
RATE_LIMITED · Límite de peticiones excedido: el de la clave (`RATE_LIMITED`), el de escrituras de la organización (`TENANT_RATE_LIMITED`) o bloqueo temporal de la IP por claves inválidas.500
INTERNAL_ERROR · Error interno del servidor.