Update a property (Beta)

patch https://api.easybroker.com/v1/properties/{property_id}

Updates an existing property in your EasyBroker account. This endpoint is still in beta, please contact our support team if you have any problem or want to share any feedback.

Path Params

property_id

string

required

The public or internal ID of the specified property

Body Params

property_type

string

required

The name of the property type. You can get the full list of property types from the property_types endpoint.

title

string

required

The property listing title.

description

string

required

The property listing description.

status

string

required

The property status

private_description

string

A private description visible only to your team.

operations

array

required

operations*

agent

string

The EasyBroker account email of the agent assigned to the property.

show_prices

boolean

An option that allows you to show or hide the EB listing prices.

bedrooms

integer

The number of bedrooms.

bathrooms

integer

The number of bathrooms.

half_bathrooms

integer

The number of half bathrooms.

parking_spaces

integer

The number of parking spaces.

age

string

One of "under_construction", "new_construction" or the year the property was built.

floor

string

The floor number in which the property is located, useful for apartments. It can be set to a custom value such as 'Penthouse'

floors

integer

The number of floors in the building.

expenses

string

The monthly expenses of the property.

internal_id

string

A unique id used in your organization. It can only contain letters, numbers and a small set of special characters (- _ , . & /)

location

object

required

tags

array of strings

An array of strings, each one is a tag that will be associated with the property.

tags

features

array of strings

An array with the names of all the features for this property. You can get the full list of features from the features endpoint.

features

share_commission

boolean

An option to specify whether your agency is willing to share the commission with other agencies in the EasyBroker agency network.

collaboration_notes

string

Notes on conditions or details for collaborations.

images

array of objects

An array of ojects, each one contains an image url and a title. Note: Images are processed asynchronously and might take some time to appear in your listing.

images

videos

array of strings

An array of strings, each one is a youtube video link that will be associated with the property.

videos

virtual_tour

string

A link to a virtual tour of the property.

show_exact_location

boolean

Set it to 'true' to show the exact address location and map location or 'false' to hide it.

construction_size

number

In square meters

lot_size

number

In square meters

lot_length

integer

In meters

lot_width

integer

In meters

covered_space

number

In square meters. Not Available in Mexico.

exclusive

boolean | null

Indicates whether the listing is exclusive. Set to null if not specified.

shared_commission_percentage

number | null

Indicates the percentage of the agency fee that is shared. At the moment, it can only be set to 50% or null if not specified.

Responses

Response body

object

public_id

string

title

string

property_images

array of objects

deprecated

Note: Images are processed asynchronously and might take some time to appear in your listing. Deprecated, you should use the "images" attribute instead.

property_images

object

url

string

title

string

images

array of objects

Note: Images are processed asynchronously and might take some time to appear in your listing.

images

object

url

string

title

string

description

string

bedrooms

integer

bathrooms

integer

half_bathrooms

integer

parking_spaces

integer

lot_size

number

In square meters

construction_size

number

In square meters

lot_length

integer

lot_width

integer

covered_space

number

In square meters. Not Available in Mexico.

floors

integer

floor

integer

age

string

One of "under_construction", "new" or the year the building was built

internal_id

string

A user defined property ID

expenses

string

property_type

string

agent

object

integer

name

string

full_name

string

mobile_phone

string

profile_image_url

string

created_at

date-time

updated_at

date-time

published_at

date-time

features

array of objects

features

object

name

string

tags

array of strings

tags

show_prices

boolean

share_commission

boolean

operations

array

operations

200The property was updated successfully

401API key is missing or invalid

404No property was found with the provided ID

422The property couldn't be updated because it is invalid