Leases

Update lease

PUT
Update a lease for an integration.

Path parameters

lease_idstringRequired

Request

This endpoint expects an object.
unit_id
stringOptional
The Propexo unique identifier for the unit
type
enumOptional
The type associated with the lease
Allowed values: FixedFixedWithRolloverAtWill
start_date
datetimeOptional
The start date associated with the lease
end_date
datetimeOptional
The end date associated with the lease
is_eviction_pending
booleanOptional
Whether the lease has an eviction pending
automatically_move_out_residents
booleanOptional
Whether residents should be set to "past" status automatically at the expiration of the lease
property_id
stringOptional
The Propexo unique identifier for the property
resident_id
stringOptional
The Propexo unique identifier for the resident
scheduled_move_in_date
datetimeOptional
The move-in date associated with the lease
first_name
stringOptional
The first name associated with the resident
last_name
stringOptional
The last name associated with the resident
address_1
stringOptional
The first address line associated with the resident
address_2
stringOptional
The second address line associated with the resident
city
stringOptional
The city associated with the resident
state
stringOptional
The state associated with the resident
zip
stringOptional
The zip code associated with the resident
email_1
stringOptional
The primary email address associated with the resident
phone_1
stringOptional
Primary phone number associated with the resident
date_of_birth
datetimeOptional
The date of birth associated with the resident
primary_contact_id
stringOptional
The Propexo unique identifier of the primary contact. This must either be a lead, applicant, or resident in Propexo
tenants
list of objectsOptional
An array of Propexo lead, applicant, or resident IDs. This must also include the primary contact ID
scheduled_move_out_date
datetimeOptional
The scheduled move-out date associated with the lease
status
enumOptional
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_date
datetimeOptional
The move-in date associated with the lease
realized_move_out_date
datetimeOptional
The move-out date associated with the lease
id
stringOptional
The Propexo unique identifier for the lease
move_in_date
datetimeOptional
The move-in date associated with the lease
move_out_date
datetimeOptional
The move-out date associated with the lease

Response

This endpoint returns an object
job_id
string
The ID of the job created to handle this operation
data
object
Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.
PUT
1curl -X PUT https://api.propexo.com/v1/leases/lease_id \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{}'
200Updated
1{
2 "job_id": "clwh5uics000608me9v74du0a",
3 "data": {}
4}