Skip to main content

UpdateForRentProduct

achived_at object
anyOf
string
category object

The type of the property (e.g., house, apartment).

anyOf
string

Possible values: [house, apartment, land, commercial, other, prestige]

title object

The title or headline for the property listing.

anyOf
string
description object

A detailed description of the property.

anyOf
string
reference object

A reference number or code for the property.

anyOf
string
availableAvailable (boolean)

Indicates whether the property is currently available.

Default value: true
availability object

The date from which the property will be available.

anyOf
string
exclusivity object

Indicates whether the property is listed exclusively.

anyOf
boolean
disable_spontaneous_applications object

If disabled, the public link to send an application will stop accepting applications.

anyOf
boolean
managersstring[]
Default value: []
metaMeta

Additional metadata about the property.

Default value: {}
address object

The address of the property, including street, city, state, zip code, and country.

anyOf
street object

The street address, including any necessary street number, street name, and additional details like apartment or suite numbers.

anyOf
string
city object

The city or locality of the address. This field specifies the urban area or town.

anyOf
string
state object

The state, province, or region of the address. This field identifies the larger administrative area or region.

anyOf
string
zip_code object

The postal code for the address, which is used for mail delivery purposes. It can be numerical or alphanumeric, depending on the country's postal system.

anyOf
string
country object

The country of the address, specified in uppercase letters as per the ISO 3166-1 alpha-2 or alpha-3 country codes or full country name.

anyOf
string
location object
anyOf
typeType (string)
Default value: Point
coordinatesarrayrequired

Possible values: >= 2, <= 2

formatFormat (string)

Possible values: [EPSG:2154, EPSG:4326]

Default value: EPSG:2154
owner object

Identifier of the property owner in the 'contact API'.

anyOf
string
building_information object

Information about the building including construction date, renovation date, and other details.

anyOf
construction_date object

The date when the building was constructed. This field is optional and can be None.

anyOf
string
renovation_date object

The date when the building was last renovated. This field is optional and can be None.

anyOf
string
energy_grade object

The energy grade of the building, indicating its energy efficiency. This field is optional.

anyOf
string
surface object

The surface area of the building in square meters. This field is optional and can be None.

anyOf
number

Possible values: > 0

floor object

The floor number of the main unit in the building. For example, 0 for ground floor, 1 for first floor, etc.

anyOf
integer
floors object

The total number of floors in the building. This field is optional and can be None.

anyOf
integer

Possible values: >= 0

heating_systemHeating System (string)

The type of heating system used in the building. Defaults to 'other'.

Default value: other
rooms object[]

A list of specifications for the rooms in the building. Each entry represents a different room. The list is empty if no rooms are specified.

  • Array [
    • name object

    The name or description of the room, such as 'Living Room' or 'Child's Room'.

    anyOf
    string
    surfaceSurface (number)required

    The surface area of the room in square meters.

    Possible values: > 0

    orientation object

    The orientation of the room relative to cardinal directions. This field is optional.

    anyOf
    string
    type object

    The type of room, such as 'living_room', 'kitchen', etc. This field is optional.

    anyOf
    string
    floor object

    The floor on which the room is located. For example, 0 for ground floor, 1 for first floor, etc.

    anyOf
    integer
  • ]
    • property_facilities object

    Facilities available in the property such as air conditioning, pool, and garden details.

    anyOf
    air_conditioning object

    Details about the air conditioning system in the property. This field is optional and can be None if there is no air conditioning or if the details are not known.

    anyOf
    installation_date object

    The date when the air conditioning system was installed. This field is optional and can be None if the installation date is not known.

    anyOf
    string
    split_numberSplit Number (integer)

    The number of splits in the air conditioning system. A split refers to the separate sections of the system. The default is 1.

    Default value: 1
    units_numberUnits Number (integer)

    The number of individual units in the air conditioning system. The default is 1.

    Default value: 1
    last_maintenance_date object

    The date of the last maintenance performed on the air conditioning system. This field is optional and can be None if the last maintenance date is not known.

    anyOf
    string
    pool object

    Details about the pool in the property. This field is optional and can be None if there is no pool or if the details are not known.

    anyOf
    typeType (string)required

    Possible values: [in-ground, above-ground]

    length object
    anyOf
    number
    width object
    anyOf
    number
    depth object
    anyOf
    number
    shape object
    anyOf
    string
    materials object
    anyOf
    string
    heating_system object
    anyOf
    string
    construction_date object
    anyOf
    string
    indoorIndoor (boolean)
    Default value: false
    safety_complianceSafety Compliance (boolean)
    Default value: false
    garage object[]

    A list of specifications for the property's garage(s). Each entry in the list represents a different garage. The list is empty if there are no garages.

  • Array [
    • name object

    The name or description of the room, such as 'Living Room' or 'Child's Room'.

    anyOf
    string
    surfaceSurface (number)required

    The surface area of the room in square meters.

    Possible values: > 0

    orientation object

    The orientation of the room relative to cardinal directions. This field is optional.

    anyOf
    string
    type object

    The type of room, such as 'living_room', 'kitchen', etc. This field is optional.

    anyOf
    string
    floor object

    The floor on which the room is located. For example, 0 for ground floor, 1 for first floor, etc.

    anyOf
    integer
  • ]
    • terraces object[]

    A list of specifications for the property's terrace(s). Each entry in the list represents a different terrace. The list is empty if there are no terraces.

  • Array [
    • name object

    The name or description of the room, such as 'Living Room' or 'Child's Room'.

    anyOf
    string
    surfaceSurface (number)required

    The surface area of the room in square meters.

    Possible values: > 0

    orientation object

    The orientation of the room relative to cardinal directions. This field is optional.

    anyOf
    string
    type object

    The type of room, such as 'living_room', 'kitchen', etc. This field is optional.

    anyOf
    string
    floor object

    The floor on which the room is located. For example, 0 for ground floor, 1 for first floor, etc.

    anyOf
    integer
  • ]
    • cellars object[]

    A list of specifications for the property's cellar(s). Each entry in the list represents a different cellar. The list is empty if there are no cellars.

  • Array [
    • name object

    The name or description of the room, such as 'Living Room' or 'Child's Room'.

    anyOf
    string
    surfaceSurface (number)required

    The surface area of the room in square meters.

    Possible values: > 0

    orientation object

    The orientation of the room relative to cardinal directions. This field is optional.

    anyOf
    string
    type object

    The type of room, such as 'living_room', 'kitchen', etc. This field is optional.

    anyOf
    string
    floor object

    The floor on which the room is located. For example, 0 for ground floor, 1 for first floor, etc.

    anyOf
    integer
  • ]
    • gardens object[]

    A list of specifications for the property's garden(s). Each entry in the list represents a different garden. The list is empty if there are no gardens.

  • Array [
    • name object

    The name or description of the room, such as 'Living Room' or 'Child's Room'.

    anyOf
    string
    surfaceSurface (number)required

    The surface area of the room in square meters.

    Possible values: > 0

    orientation object

    The orientation of the room relative to cardinal directions. This field is optional.

    anyOf
    string
    type object

    The type of room, such as 'living_room', 'kitchen', etc. This field is optional.

    anyOf
    string
    floor object

    The floor on which the room is located. For example, 0 for ground floor, 1 for first floor, etc.

    anyOf
    integer
  • ]
    • internet_access object

    The type of internet access available at the property. It can be 'unknown', 'fiber', or 'copper'. This field is optional and can be None if the information is not known

    anyOf
    string

    Possible values: [unknown, fiber, copper]

    others object[]

    A list of other equipment available in the property. Each entry in the list represents a different piece of equipment. The list is empty if there are no additional equipment details.

  • Array [
    • nameName (string)required

    The name of the equipment, such as 'Washing Machine' or 'Coffee Maker'.

    descriptionDescription (string)required

    A description of the equipment and its function.

  • ]
    • intercom object

    Indicates whether the property has an intercom system. The default is None.

    anyOf
    boolean
    elevator object

    Indicates whether the property has an elevator. This field is optional and can be None if the presence of an elevator is not known. The default is False.

    anyOf
    boolean
    parkingParking (integer)

    The number of parking spaces available at the property. The default is 0.

    Default value: 0
    security_facilities object

    Security features available in the property such as cameras and alarm systems.

    anyOf
    concierge object

    Indicates whether a concierge service is available at the property. This field is optional and can be None if the presence of a concierge is not known.

    anyOf
    boolean
    security_guard object

    Indicates whether a security guard is present at the property. This field is optional and can be None if the presence of a security guard is not known.

    anyOf
    boolean
    camera object

    Indicates whether there are security cameras installed at the propertyThis field is optional and can be None if the presence of cameras is not known.

    anyOf
    boolean
    alarm_system object

    Indicates whether an alarm system is installed at the property. This field is optional and can be None if the presence of an alarm system is not known.

    anyOf
    boolean
    armored_door object

    Indicates whether the property has armored doors. This field is optional and can be None if the presence of armored doors is not known

    anyOf
    boolean
    internal_information object
    anyOf
    access_code object

    Access code for the property, if applicable. Can be None if not available.

    anyOf
    string
    note object

    Additional notes or comments about the property. Can be None if there are no notes.

    anyOf
    string
    mandate_typeMandate Type (string)

    The type of mandate for the property.

    Default value: management
    rent_amount object

    The monthly rent amount.

    anyOf
    number
    monthly_charges object

    The monthly charges in addition to rent.

    anyOf
    number
    furnishedFurnished (boolean)

    Indicates whether the property is furnished.

    Default value: false
    warranty_amount object

    The total deposit for warranty.

    anyOf
    number
    agency_fees object

    The amount of fees applyied by the agency for this product.

    anyOf
    number
    unpaid_rent_insurance object

    Whether or not this product is insured against unpaid rent.

    anyOf
    boolean
    UpdateForRentProduct
    {
      "achived_at": "2024-07-29T15:51:28.071Z",
      "category": "house",
      "title": "string",
      "description": "string",
      "reference": "string",
      "available": true,
      "availability": "2024-07-29",
      "exclusivity": true,
      "disable_spontaneous_applications": true,
      "managers": [
        "string"
      ],
      "address": {
        "street": "string",
        "city": "string",
        "state": "string",
        "zip_code": "string",
        "country": "string",
        "location": {
          "type": "Point",
          "coordinates": [
            null
          ],
          "format": "EPSG:2154"
        }
      },
      "owner": "string",
      "building_information": {
        "construction_date": "2024-07-29",
        "renovation_date": "2024-07-29",
        "energy_grade": "string",
        "surface": 0,
        "floor": 0,
        "floors": 0,
        "heating_system": "other",
        "rooms": [
          {
            "name": "string",
            "surface": 0,
            "orientation": "string",
            "type": "string",
            "floor": 0
          }
        ]
      },
      "property_facilities": {
        "air_conditioning": {
          "installation_date": "2024-07-29",
          "split_number": 1,
          "units_number": 1,
          "last_maintenance_date": "2024-07-29"
        },
        "pool": {
          "type": "in-ground",
          "length": 0,
          "width": 0,
          "depth": 0,
          "shape": "string",
          "materials": "string",
          "heating_system": "string",
          "construction_date": "2024-07-29",
          "indoor": false,
          "safety_compliance": false
        },
        "garage": [
          {
            "name": "string",
            "surface": 0,
            "orientation": "string",
            "type": "string",
            "floor": 0
          }
        ],
        "terraces": [
          {
            "name": "string",
            "surface": 0,
            "orientation": "string",
            "type": "string",
            "floor": 0
          }
        ],
        "cellars": [
          {
            "name": "string",
            "surface": 0,
            "orientation": "string",
            "type": "string",
            "floor": 0
          }
        ],
        "gardens": [
          {
            "name": "string",
            "surface": 0,
            "orientation": "string",
            "type": "string",
            "floor": 0
          }
        ],
        "internet_access": "unknown",
        "others": [
          {
            "name": "string",
            "description": "string"
          }
        ],
        "intercom": true,
        "elevator": true,
        "parking": 0,
        "security_facilities": {
          "concierge": true,
          "security_guard": true,
          "camera": true,
          "alarm_system": true,
          "armored_door": true
        }
      },
      "internal_information": {
        "access_code": "string",
        "note": "string"
      },
      "mandate_type": "management",
      "rent_amount": 0,
      "monthly_charges": 0,
      "furnished": false,
      "warranty_amount": 0,
      "agency_fees": 0,
      "unpaid_rent_insurance": true
    }