Units
Admin API for units — buzzer destinations and resident links.
Overview
A Unit is the entity visitors select at the intercom. It links to a property, optional virtual number (Twilio e164), and many resident users.
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /api/admin/units | List |
POST | /api/admin/units | Create |
GET | /api/admin/units/:id | Read |
PUT | /api/admin/units/:id | Update |
DELETE | /api/admin/units/:id | Delete |
Critical field: unitLabel
The human-visible apartment identifier is unitLabel. APIs and integrations must not use deprecated names like number or name.
Virtual numbers
virtualNumberId ties the unit to a pooled Twilio number. Releasing or quarantining numbers flows through /api/admin/virtual-numbers endpoints.
Residents
Residents associate through the many-to-many relation (UnitResidents). Updating occupancy typically means adjusting user ↔ unit links via the supported admin routes or internal scripts — do not hand-edit UUIDs in production without a migration plan.