Property Tools

Create Property

Create a property. Requires address, city, state, neighborhood, property_type, and at least one of sale_value or rental_value. Put apartment, suite, block, or room details in address_complement and send monetary values as numbers. When no responsible broker is provided, assigns the requesting user. Write operation: creates a property.

post/v1/mcp/tool/properties

Request

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

Request body

addressstring required

Street name and number, for example 'Avenida das Nações Unidas, 18.801'. Put suite, block, apartment, or room details in address_complement.

citystring required

Property city, for example 'São Paulo' or 'Curitiba'.

statestring required

Two-letter uppercase Brazilian state code, such as SP, RJ, MG, or SC. Convert a full state name to its code, for example 'São Paulo' to SP.

neighborhoodstring required

Property neighborhood, for example 'Vila Almeida', 'Pinheiros', or 'Ipanema'.

property_typestring required

Property type from the account-specific catalog, for example 'Apartamento', 'Casa de Condomínio', or 'Chácara'. The tool accepts registered labels, normalized names, and common Portuguese or English aliases. An unknown type returns needs_user_input with the registered options.

countrystring

Property country. Defaults to Brasil.

sale_valuenumber nullable

Sale price as a number without a currency symbol or thousands separator. Map 'R$ 1.100.000' to 1100000 and 'R$ 850 mil' to 850000. Provide this field for a sale or purchase listing.

rental_valuenumber nullable

Monthly rental price as a number without a currency symbol. Map 'R$ 3.000' or 'três mil reais' to 3000. Provide this field for a rental listing.

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

Initial property status. Defaults to available. Values include available='disponível', pending='pendente', rented='alugado', reserved='reservado', solded='vendido', with_proposal='com proposta', solded_by_third_parties, rented_by_third_parties, and suspended.

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

Usage classification: residential, commercial, or rural. Omit it unless the user states it; the tool uses the finality associated with the resolved property type, with a legacy inference only when the type catalog is unavailable.

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

Transaction hint: buy for 'venda/compra', rent for 'aluguel/locação', or vacation_rental for 'temporada'. This value is not stored as a separate commercial-interest field: vacation_rental sets vacation_rental=true, while buy or rent sets it to false unless explicitly provided.

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

Construction situation: used='usado', new='novo', under_construction='em construção', off_plan='lançamento/na planta', or semi_new='seminovo'. Omit it when the user does not state the situation.

descriptionstring nullable

Internal property description. Omit it when the user provides no descriptive text.

address_complementstring nullable

Suite, block, apartment, or room information kept separate from address. Examples: 'Conjunto 309', 'Apto 141', or 'Bloco A - Sala 5'.

zipcodestring nullable

Property postal code (CEP).

bedroominteger nullable

Total number of bedrooms, including suites. Map '3 quartos sendo 1 suíte' to bedroom=3 and suite=1.

bathroominteger nullable

Total number of bathrooms, including powder rooms and suite bathrooms.

suiteinteger nullable

Number of bedrooms with a private bathroom. Suites are already included in the bedroom total. Map '1 suíte' to suite=1.

garageinteger nullable

Number of garage or parking spaces.

areanumber nullable

Total property area in square meters. Use for 'área total', 'área construída', or an unspecified area such as '85 m²'; send 85 as a number.

useful_areanumber nullable

Usable area in square meters. Use it when the user explicitly says 'área útil'; use area for an unspecified area value.

lot_areanumber nullable

Lot area in square meters for houses, land, or properties with a stated yard or garden.

measure_typestring nullable

Area measurement unit. The tool automatically defaults to m²; omit this field unless needed.

latitudenumber nullable

Property geographic latitude.

longitudenumber nullable

Property geographic longitude.

vacation_rentalboolean nullable

Whether the property is offered as a vacation rental.

site_publishboolean nullable

Whether the property is published on the website.

site_publish_priceboolean nullable

Whether the property price is displayed on the website.

site_titlestring nullable

Property title used for website publication.

site_urlstring nullable

Friendly URL slug for the property website page.

privateboolean nullable

Whether the property is private.

activeboolean nullable

Whether the property is active. Defaults to true.

alternative_codestring nullable

Alternative property code.

visit_only_realtorboolean nullable

Whether property visits require a broker.

visit_timestring nullable

Preferred time or schedule for property visits.

stagestring nullable

Internal property stage.

user_namestring nullable

Name of the listing broker to assign. Omit user_name and user_email to assign the requesting user.

user_emailstring nullable

Email of the listing broker to assign. Prefer this over user_name for precision. Omit both fields to assign the requesting user.

Response

Successful Response

unknown required

Changes

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