Update lease

PUT
Update a lease for an integration.

Path parameters

lease_idstringRequired
The ID of the resource.

Request

This endpoint expects an object.
unit_idstringOptional
The Propexo unique identifier for the unit
typeenumOptional
Allowed values: FixedFixedWithRolloverAtWill
The type associated with the lease
start_datedatetimeOptional
The start date associated with the lease
end_datedatetimeOptional
The end date associated with the lease
is_eviction_pendingbooleanOptional
Whether the lease has an eviction pending
automatically_move_out_residentsbooleanOptional
Whether residents should be set to "past" status automatically at the expiration of the lease
property_idstringOptional
The Propexo unique identifier for the property
resident_idstringOptional
The Propexo unique identifier for the resident
scheduled_move_in_datedatetimeOptional
The move-in date associated with the lease
first_namestringOptional
The first name associated with the resident
last_namestringOptional
The last name associated with the resident
address_1stringOptional
The first address line associated with the resident
address_2stringOptional
The second address line associated with the resident
citystringOptional
The city associated with the resident
statestringOptional
The state associated with the resident
zipstringOptional
The zip code associated with the resident
email_1stringOptional
The primary email address associated with the resident
phone_1stringOptional
Primary phone number associated with the resident
date_of_birthdatetimeOptional
The date of birth associated with the resident
primary_contact_idstringOptional
The Propexo unique identifier of the primary contact. This must either be a lead, applicant, or resident in Propexo
tenantslist of objectsOptional
An array of Propexo lead, applicant, or resident IDs. This must also include the primary contact ID
scheduled_move_out_datedatetimeOptional
The scheduled move-out date associated with the lease
statusenumOptional
The status associated with the lease. Must be one of "1" (Pending), "2" (Active), "3" (Notice Given), "4" (Vacated), "5" (Evicting), "6" (Closed), "7" (Moved Out), "8" (Evicted), or "9" (Lease Broken).
realized_move_in_datedatetimeOptional
The move-in date associated with the lease
realized_move_out_datedatetimeOptional
The move-out date associated with the lease
idstringOptional
The Propexo unique identifier for the lease
move_in_datedatetimeOptional
The move-in date associated with the lease
move_out_datedatetimeOptional
The move-out date associated with the lease

Response

This endpoint returns an object.
job_idstring
The ID of the job created to handle this operation
dataobject

Errors