Leases

Update lease

PUT
https://api.propexo.com/v1/leases/:lease_id
Update a lease for an integration.

Path parameters

lease_id
string

Request

This endpoint expects an object.
type
optional enum
The type associated with the lease
Allowed values: FixedFixedWithRolloverAtWill
x_unit_id
optional string
The external ID of the unit from the integration vendor
start_date
optional datetime
The start date associated with the lease
end_date
optional datetime
The end date associated with the lease
is_eviction_pending
optional boolean
Whether the lease has an eviction pending
automatically_move_out_residents
optional boolean
Whether residents should be set to "past" status automatically at the expiration of the lease
property_id
optional string
The Propexo unique identifier for the property
unit_id
optional string
The Propexo unique identifier for the unit
resident_id
optional string
The Propexo unique identifier for the resident
scheduled_move_in_date
optional datetime
The move-in date associated with the lease
first_name
optional string
The first name associated with the resident
last_name
optional string
The last name associated with the resident
address_1
optional string
The first address line associated with the resident
address_2
optional string
The second address line associated with the resident
city
optional string
The city associated with the resident
state
optional string
The state associated with the resident
zip
optional string
The zip code associated with the resident
email_1
optional string
The primary email address associated with the resident
phone_1
optional string
'Primary phone number associated with the resident
date_of_birth
optional datetime
The date of birth associated with the resident
scheduled_move_out_date
optional datetime
The move-out date associated with the lease
realized_move_in_date
optional datetime
The move-in date associated with the lease
realized_move_out_date
optional datetime
The move-out date associated with the lease
primary_contact_id
optional string
The Propexo unique identifier of the primary contact. This must either be a lead, applicant, or resident in Propexo
tenants
optional list of objects
An array of Propexo lead, applicant, or resident IDs. This must also include the primary contact ID
status
optional enum
The status associated with the lease
Allowed values: DraftActiveActive - Notice GivenTerminatedEviction

Response

This endpoint return 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
/v1/leases/:lease_id
curl -X PUT https://api.propexo.com/v1/leases/lease_id \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{}'
Response
{
"job_id": "job_id",
"data": {}
}