Add a unit of interest
Records that the applicant is applying for a particular unit. You send only the unit — the property and portfolio it sits in are looked up for you. Requires the rental_applications:write permission.
Authorization
AuthorizationstringrequiredPath parameters
applicationIdstringrequiredThe rental application to work with. A Snowflake id, sent as a decimal string.
Body
application/json
unitIdstringrequiredThe unit the applicant wants. A Snowflake id, sent as a decimal string. It must belong to the same company as the application.
Response
200 · The new interest, with the property and portfolio resolved from the unit.
idstringThe interest record. Pass this id to remove it.
portfolioIdstringThe portfolio the unit's property sits in, resolved server-side.
propertyIdstringThe property the unit sits in, resolved server-side.
unitIdstringThe unit the applicant is interested in.
400 · The unit belongs to a different company than the rental application.
401 · The access token is missing, expired, or not valid.
403 · The caller is authenticated but does not hold the `rental_applications:write` permission.
404 · No unit with this id exists on this rental application, or the rental application itself was not found.
This is not gated on the application's status — it works on a draft, on a submitted application, and on a retracted one. Only the applicant-facing portal locks an application once it is submitted.
Adding the same unit twice creates two interest records. Check interestedUnits on the rental application before adding if that matters to you.
This response carries the four ids only. interestedUnits on the rental application gives the same interests with the unit name, address, listed rent and deposit filled in.