Estates

Update estate

Update an estate's properties, including the ability to change its place association.

Key Features:

  • Allows changing the place_id to move an estate to a different place
  • Validates that the new place_id exists and belongs to the same tenant
  • Returns a 404 error if the new place doesn't exist or belongs to another tenant

Update Behavior:

  • Field absent: Existing value is preserved (no modification)
  • Field present with null: Value is removed (set to NULL in database)
  • Field present with value: Value is updated

Special Fields:

  • place_id: Can be updated to change the estate's place association. The new place must exist and belong to the same tenant.
  • number_of_room: Can be set to null to remove the value

Example: To move an estate to a different place, include place_id in the request body:

{
  "place_id": "new-place-uuid-here"
}
put/estates/{id}

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/estates/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

The UUID of the estate to update

Request body

namestring nullable

Property name

place_idstring uuid nullable

Identifier of the place to which the property is associated.

Changing place:

  • This field can be modified to move a property to another place
  • Use the flat route PUT /estates/{id} to change this field
  • The new place_id must exist and belong to the same tenant
  • If the new place does not exist or belongs to another tenant, a 404 error will be returned
  • If this field is absent from the request, the existing value is preserved
estate_type_idstring uuid nullable
areanumber nullable
number_of_roominteger nullable

Number of rooms.

Update behavior:

  • Field absent: the existing value is preserved
  • null: the value is removed (set to NULL in database)
  • Integer: the value is updated
orientationstring nullable
buildingstring nullable
floorinteger nullable
lot_numberstring nullable
fiscal_identifierstring nullable

Property tax identifier

housing_taxnumber nullable
property_taxnumber nullable
acquisition_pricenumber nullable
rent_amountnumber nullable

Reference rent amount for the property (in euros).

Update behavior:

  • Field absent: the existing value is preserved
  • Field present with null: the value is removed (set to NULL)
  • Field present with value: the value is updated

Note: Directly modifying this field does not affect existing leases. Active leases retain their rent. This field serves as the default value for future leases.

construction_datestring date-time nullable
renovation_datestring date-time nullable
addressstring nullable
other_detailstring nullable
rental_status'VACANT' | 'RENTED' | 'NOTICE'

Rental status of a property.

  • VACANT: Vacant property, no active lease
  • RENTED: Rented property, at least one active lease
  • NOTICE: Property under notice period, at least one lease under notice (without an active lease)

This status is automatically synchronized with the status of associated leases when statuses change (ACTIVE, NOTICE, TERMINATED).

Example request

{
  "name": "3-bedroom apartment - Rue de la Paix",
  "place_id": "550e8400-e29b-41d4-a716-446655440000",
  "fiscal_identifier": "1234567890123",
  "rent_amount": 1200,
  "rental_status": "RENTED"
}

Response

OK - Estate updated successfully

idstring uuid nullable
namestring nullable

Property name

place_idstring uuid nullable
estate_type_idstring uuid nullable
areanumber nullable
number_of_roominteger nullable
orientationstring nullable
buildingstring nullable
floorinteger nullable
owner_idstring uuid nullable
previous_owner_idstring uuid nullable
lot_numberstring nullable
fiscal_identifierstring nullable

Property tax identifier (required)

housing_taxnumber nullable
property_taxnumber nullable
acquisition_pricenumber nullable
rent_amountnumber nullable

Reference rent amount for the property (in euros). Automatically synchronized with active leases.

rental_status'VACANT' | 'RENTED' | 'NOTICE'

Rental status of a property.

  • VACANT: Vacant property, no active lease
  • RENTED: Rented property, at least one active lease
  • NOTICE: Property under notice period, at least one lease under notice (without an active lease)

This status is automatically synchronized with the status of associated leases when statuses change (ACTIVE, NOTICE, TERMINATED).

construction_datestring date-time nullable
renovation_datestring date-time nullable
addressstring nullable
other_detailstring nullable
created_atstring date-time nullable
updated_atstring date-time nullable

Example response

{
  "name": "3-bedroom apartment - Rue de la Paix",
  "fiscal_identifier": "1234567890123",
  "rent_amount": 1200,
  "rental_status": "RENTED"
}

Changes

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