Remove a unit of interest
Removes a unit from the list the applicant is applying for. Requires the rental_applications:write permission.
Authorization
AuthorizationstringrequiredBearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.
Path parameters
applicationIdstringrequiredThe rental application to work with. A Snowflake id, sent as a decimal string.
example: 1830472847398404096
idstringrequiredThe interest record to work with. A Snowflake id, sent as a decimal string.
example: 1831560192837465600
Response
200 · The interest was removed. The response has no body.
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 interest record with this id exists on this rental application, or the rental application itself was not found.
Allowed in every application status
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.
This is the interest id, not the unit id
Take it from interestedUnits[].interestId on the rental application, or from the response to Add a unit of interest.