Property Tools

Update Property

Update a property identified by property_code. If only its address or other details are known, use search_properties first to obtain the code required by the path. Only provided fields are changed; blank strings are ignored and do not clear existing values. Write operation: modifies a property.

put/v1/mcp/tool/property/{property_code}

Request

  • Base URL: https://api.imobzi.app
  • URL: https://api.imobzi.app/v1/mcp/tool/property/{property_code}
  • Auth: API key in header X-Imobzi-Secret

Path parameters

property_codestring required

Complete public code of the property to identify it for update or deletion. Preserve the value exactly, for example AP-001.

Request body

addressstring nullable

New primary property address. Blank strings are ignored.

address_complementstring nullable

New suite, block, apartment, or room information.

citystring nullable

New property city.

statestring nullable

New two-letter uppercase Brazilian state code.

neighborhoodstring nullable

New property neighborhood.

zipcodestring nullable

New property postal code (CEP).

countrystring nullable

New property country.

property_typestring nullable

New property type from the account-specific catalog. Registered labels, normalized names, and common Portuguese or English aliases are accepted. An unknown type returns needs_user_input with the registered options.

property_situation'used' | 'new' | 'under_construction' | 'off_plan' | 'semi_new' nullable

New construction situation: used, new, under_construction, off_plan, or semi_new.

status'available' | 'pending' | 'rented' | 'reserved' | 'solded' | 'with_proposal' | 'solded_by_third_parties' | 'rented_by_third_parties' | 'suspended' nullable

New property status.

finality'residential' | 'commercial' | 'rural' nullable

New usage classification: residential, commercial, or rural.

interest'buy' | 'rent' | 'vacation_rental' nullable

Transaction hint: buy or rent sets vacation_rental=false unless that field is explicitly provided; vacation_rental sets it to true. The interest value itself is not stored as a separate field.

descriptionstring nullable

New internal property description.

sale_valuenumber nullable

New sale price as a numeric value.

rental_valuenumber nullable

New monthly rental price as a numeric value.

bedroominteger nullable

New total number of bedrooms, including suites.

bathroominteger nullable

New total number of bathrooms.

suiteinteger nullable

New number of suites.

garageinteger nullable

New number of garage or parking spaces.

areanumber nullable

New total area.

useful_areanumber nullable

New usable area.

lot_areanumber nullable

New lot area.

measure_typestring nullable

New area measurement unit.

latitudenumber nullable

New geographic latitude.

longitudenumber nullable

New geographic longitude.

site_publishboolean nullable

Whether to publish the property on the website.

site_publish_priceboolean nullable

Whether to display the property price on the website.

site_titlestring nullable

New property title for website publication.

site_urlstring nullable

New friendly URL slug for the property website page.

privateboolean nullable

Whether the property is private.

activeboolean nullable

Whether the property is active.

vacation_rentalboolean nullable

Whether the property is offered as a vacation rental.

alternative_codestring nullable

New alternative property code.

visit_only_realtorboolean nullable

Whether property visits require a broker.

visit_timestring nullable

New preferred time or schedule for visits.

stagestring nullable

New internal property stage.

user_namestring nullable

Name of the new listing broker. Prefer user_email when available.

user_emailstring nullable

Email of the new listing broker for precise assignment.

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.