Skip to main content

Lease Transaction Unit Released

Overview

·Event key:
lease_transaction.unit_released

This event enables real-time tracking when units become available again after being reserved. Use it to update inventory systems, re-enable unit listings, trigger availability notifications, and synchronize your systems when reservations are released.

When This Event Triggers

This event fires in the following scenarios when a unit that was previously reserved becomes available again:

  • Application Denied — When a leasing agent denies an application, the unit that was being held for that applicant is released back to the market so other prospective residents can apply for it.
  • Application Canceled — When an application is canceled (either by the applicant or by a leasing agent), the reserved unit is released and becomes available for other applicants.
  • Pending Criminal Review — When an application moves to a "Pending Criminal Review" status due to screening results that require manual review, the unit is released while the review is in progress. This allows the property to continue marketing the unit rather than holding it indefinitely during the review period.
  • Transfer Completed — When a resident successfully completes a transfer to a new unit, their previous unit is released and becomes available for new residents.
  • Transfer Denied or Canceled — When a transfer request is denied or canceled, the new unit that was being held for the transfer is released back to the market.
  • Unit Change During Application — When an applicant or agent changes the selected unit during an active application, the previously reserved unit is released before the new unit is reserved.

Note: In all cases, the unit's status changes from "Reserved" to "Available," making it visible to other prospective residents and available for new applications.

Event Payload

Example payloadJSON200 · application/json
{
"id": "8cc87045-2222-4a16-a882-454044e6762a",
"event": "lease_transaction.unit_released",
"timestamp": "2024-10-09T13:49:31.658518+00:00",
"data": {
  "lease_transaction_id": 74825,
  "lease_transaction_type": "Application",
  "client_id": 12457534,
  "guestcard_pms_identifier": "p1234",
  "tenant_pms_identifier": "t1234",
  "unit_id": 4352,
  "unit_pms_identifier": "u1234",
  "unit_number": "101",
  "community_id": 435242,
  "community_pms_identifier": "c1234",
  "building_number": "123",
  "internal_building_number": "456"
}
}