API Reference

Create a property

post
https://api.easybroker.com/v1/properties

Creates a new property in your EasyBroker account, which will be published to all your connected apps.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The property type symbol returned by the property_types endpoint. Names remain accepted for backward compatibility.

string
required

The property listing title.

string
required

The property listing description.

string
enum
required

The property status

Allowed:
string

A private description visible only to your team.

operations
array of objects
required
operations*
string

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

boolean

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

integer

The number of bedrooms.

integer

The number of bathrooms.

integer

The number of half bathrooms.

integer

The number of parking spaces.

One of "under_construction", "new_construction" or the year the property was built. The year may be sent as an integer or a four-digit string.

string | null
enum

The condition of the property. Send null to leave it unspecified. Not available for building, commercial or land property types; the value is ignored for those.

Allowed:
string

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

integer

The number of floors in the building.

boolean | null

Indicates whether monthly maintenance is included in the rental price. Required when rental is active and maintenance_amount is provided; otherwise it is cleared to null when rental is inactive.

integer | null
1 to 2147483647

Monthly maintenance amount. When rental is active, rental_maintenance_included must be specified; the amount is required when that field is false.

string

Currency code for the maintenance amount. Defaults to the operation currency (rental, sale or temporary rental, in that order) when omitted.

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
boolean

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

string

Notes on conditions or details for collaborations.

images
array of objects

An array of objects, each one containing an image url and a title. Images are processed asynchronously and might take some time to appear in your listing. The API does not expose processing status; retrieve the property again and check its images array. For an existing listing, this array replaces the existing images. Image requirements: URL must be a valid HTTP/HTTPS URL with file extension (.jpg, .jpeg, .png, .gif, .heic, .webp), maximum 6MB per image, minimum 500px width or height, valid image MIME type, up to 50 images per 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
string

A link to a virtual tour of the property.

boolean

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

number

In square meters

number

In square meters

number

In meters

number

In meters

number

In square meters. Not Available in Mexico.

number

In square meters. Only available in Mexico and Argentina.

boolean | null

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

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

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?