Skip to Content
PortfolioOverview

Portfolio Overview

The Portfolio API manages the inventory the AI leasing agent works from: properties, their floorplans, and their units.

Units usually belong to a floorplan, but can also sit directly on a property, which is useful for single-family homes or one-off units. Availability and pricing you write here is what the agent quotes to leads, effective immediately.

The hierarchy

Property ├── Floorplan │ └── Unit │ └── Unit └── Unit ← units can also sit directly on a property
  • Properties are a building or address, with amenities, pet policy, and images.
  • Floorplans are a reusable layout under a property (bedrooms, bathrooms, rent range).
  • Units are an individual rentable unit, with its own availability and pricing.

All three support the same four standard operations.

Shared rules

Parent links are fixed. A floorplan’s propertyId, and a unit’s propertyId / floorplanId, are set on create and cannot be changed.

Deletes are guarded. A property or floorplan must be empty before it can be deleted:

  • 409 Property not empty
  • 409 Floorplan not empty

PMS-synced records are read-only. If your portfolio syncs from a property management system such as Yardi, the integration stays authoritative and writes return 409 Managed by integration.

Last updated on