Units

A unit is an individual rentable space. Units usually belong to a floorplan, but floorplanId is optional, so a unit can sit directly on a property. Units carry their own bedrooms, bathrooms, and squareFeet; provide these especially when there is no floorplan to describe the unit.

Fields

Field	Type	Writable	Description
`id`	number	read-only	RentSimple identifier
`propertyId`	number	create-only	The property this unit belongs to
`floorplanId`	number	create-only	Optional; must be a floorplan under the same property
`unitNumber`	string	required	Unit label as shown to prospects (e.g. `204`)
`available`	boolean	optional	Whether the unit is on the market; defaults to `false`
`availableOn`	string	optional	ISO-8601 date, earliest move-in. Omit if available now
`rent`	number	optional	Advertised monthly rent in whole dollars. Without it, the agent cannot quote pricing for this unit
`bedrooms`	number	optional	Bedroom count (`0` for studio)
`bathrooms`	number	optional	Bathroom count (halves allowed)
`squareFeet`	number	optional	Interior size
`floor`	number	optional	Floor the unit is on
`description`	string	optional	Shown to prospects and used by the agent
`amenities`	string[]	optional	Unit features (e.g. `["Balcony", "Dishwasher"]`)
`images`	string[]	optional	Image URLs
`externalId`	string	optional	Your own identifier
`createdAt` / `updatedAt`	string	read-only	ISO-8601 timestamps

List filters:

propertyId
floorplanId
available (boolean)
availableBy (ISO-8601 date; available units with availableOn on or before this date)

Example: take a unit off the market

This is the call you will make most, flipping availability and adjusting pricing as things change on your side.

Request


curl -X PATCH https://rentsimple.ai/api/v1/units/90211 \
  -H "Authorization: Bearer $RENTSIMPLE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "available": false }'

Prefer PATCH over DELETE

Prefer PATCH over DELETE. Deletion removes the unit from the agent’s knowledge entirely, while an unavailable unit keeps its history and comes back with a single PATCH.