# Units

Webhook for unit changes (creates, updates, deletes).
Only the below fields are included in the record and old_record objects.


Endpoint: POST UnitsEvents
Version: 1.1.1
Security: ApiKeyAuth

## Request fields (application/json):

  - `record` (object)

  - `record.id` (integer)
    Unique identifier for the unit
    Example: 3318

  - `record.property_type` (string)
    Type of property
    Example: "TOWNHOUSE"

  - `record.highlighted_amenities` (array)
    Highlighted amenities

  - `record.bedrooms` (string)
    Number of bedrooms
    Example: "3"

  - `record.bathrooms` (string)
    Number of bathrooms
    Example: "2"

  - `record.sqft` (string)
    Square footage of the unit
    Example: "1378"

  - `record.furnished` (boolean)
    Whether the unit is furnished

  - `record.renovated` (string)
    Whether the unit has been renovated
    Example: "No"

  - `record.num_parking_spots` (string)
    Number of parking spots
    Example: "2"

  - `record.laundry` (string)
    Laundry options
    Example: "In Unit"

  - `record.target_rental_rate` (string)
    Target rental rate for the unit in dollars per month
    Example: "1925"

  - `record.is_occupied` (boolean)
    Whether the unit is currently occupied

  - `record.earliest_move_in_date` (string)
    Earliest date the unit is available for move-in
    Example: "2024-10-12"

  - `record.allow_cooperating_brokers` (boolean,null)
    Whether cooperating brokers are allowed
    Example: true

  - `record.desired_lease_duration_months` (array)
    Desired lease duration in months
    Example: [12]

  - `record.pets_allowed` (string,null)
    Pet policy
    Example: "Yes with pet fee"

  - `record.pet_restrictions` (string)
    Restrictions on pets
    Example: "A MINIMUM NON-REFUNDABLE pet fee in the amount of $300 per pet is required"

  - `record.hoa_app_required` (boolean,null)
    Whether HOA application is required
    Example: true

  - `record.hoa_app_fee` (number,null)
    HOA application fee in dollars
    Example: 100

  - `record.hoa_application_url` (string,null)
    URL for HOA application
    Example: "https://example.com/application"

  - `record.key_access` (string)
    Key access information
    Example: "I will add this later"

  - `record.structured_access_instructions` (object)
    Structured access instructions

  - `record.earliest_showing_date` (string)
    Earliest date the unit can be shown
    Example: "2024-10-12"

  - `record.min_resident_qualifications` (string)
    Minimum qualifications for residents

  - `record.utilities_included` (array)
    Utilities included in rent
    Example: ["Lawn Care","Trash"]

  - `record.parking_type` (array)
    Type of parking available
    Example: ["Assigned Spots"]

  - `record.status` (string)
    Current status of the unit
    Example: "Leased"

  - `record.extracted_from` (string)
    Source of the unit data
    Example: "f123abc"

  - `record.marketing_description` (string)
    Marketing description of the unit
    Example: "**AVAILABLE NOW** 3 Bedroom 2 Bathroom Townhome For Rent in Meadow Woods!"

  - `record.marketing_photos` (array)
    Photos of the unit

  - `record.marketing_photos.path` (string)

  - `record.marketing_photos.hidden` (boolean)

  - `record.marketing_photos.original` (string,null)

  - `record.commission_amount` (string)
    Commission amount
    Example: "1"

  - `record.commission_type` (string)
    Type of commission
    Example: "none"

  - `record.imported_by` (string,null)
    Who/what imported the unit
    Example: "Rentvine Sync"

  - `record.floor_number` (integer)
    Floor number of the unit
    Example: 1

  - `record.has_elevator` (boolean,null)
    Whether the building has an elevator

  - `record.hoa_details` (object)
    Details about the HOA

  - `record.account_id` (string)
    ID of the account that owns the unit
    Example: "269bf205-d876-42f5-988d-6f40891df58a"

  - `record.owner_emails` (array)
    Email addresses of the owners
    Example: ["rick@amgrents.com"]

  - `record.accepts_vouchers` (boolean,null)
    Whether the unit accepts housing vouchers.
    Example: true

  - `record.showing_method` (string,null)
    Method for showing the unit
    Example: "Remote Guided"

  - `record.amenities` (array)
    All amenities of the unit
    Example: ["Dishwasher","Stove","Range Oven","Refrigerator"]

  - `record.internal_notes` (string,null)
    Internal notes about the unit.
    Example: "Garage work scheduled for Monday."

  - `record.move_in_fees` (array,null)
    Fees required at move-in

  - `record.monthly_fees` (array,null)
    Monthly recurring fees

  - `record.multifamily_property_id` (string,null)
    ID of the multifamily property
    Example: "421e4567-e89b-12d3-a456-426614174000"

  - `record.floorplans_id` (string,null)
    ID of the floorplan
    Example: "451e4567-e89b-12d3-a456-426614174000"

  - `record.video_url` (string,null)
    URL of video tour
    Example: "https://www.youtube.com/watch?v=1234567890"

  - `record.subteam_id` (string,null)
    ID of the subteam managing the unit
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `record.prescreen_template_id` (string,null)
    ID of the prescreening template to use for this unit
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `record.enable_send_report` (boolean)
    Whether to enable sending reports
    Example: true

  - `record.security_deposit_amount` (number,null)
    Amount of security deposit in dollars
    Example: 1000.21

  - `record.require_last_month_rent` (boolean,null)
    Whether last month's rent is required upfront
    Example: true

  - `record.requires_voucher` (boolean,null)
    Whether a voucher is required

  - `record.custom_application_url` (string)
    URL for custom application
    Example: "https://app.findigs.com/apply/unitid=70f51c4c-d708-402e-9a5f-bb6fd60b6cf2"

  - `record.include_feedback_leasing_report` (boolean)
    Whether to include feedback in leasing reports
    Example: true

  - `record.year_built` (number,null)
    Year the property was built
    Example: 2020

  - `record.application_fee` (number,null)
    Application fee amount in dollars
    Example: 50

  - `record.created_at` (string)
    Timestamp when the unit was created
    Example: "2024-10-05T18:53:03.406168Z"

  - `record.updated_at` (string)
    Timestamp when the unit was last updated
    Example: "2024-10-05T18:53:03.406168Z"

  - `old_record` (object)

## Response 200 fields (application/json):

  - `success` (boolean)
    Example: true