Update lease

PUT
/v1/leases/:lease_id

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_datedatetime or stringOptional

The start date associated with the lease

end_datedatetime or stringOptional

The end date associated with the lease

is_eviction_pendingbooleanOptionalDefaults to false

Whether the lease has an eviction pending

automatically_move_out_residentsbooleanOptionalDefaults to false

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_datedatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The move-in date associated with the lease

first_namestringOptional

The first name associated with the applicant

last_namestringOptional

The last name associated with the applicant

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 applicant

phone_1stringOptionalformat: "^\d{10}$"

Primary phone number associated with the applicant

date_of_birthdatetime or stringOptional

The date of birth associated with the applicant

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_datedatetime or stringOptional

The scheduled move-out date associated with the lease

statusenumOptional
Allowed values: DraftActiveActive - Notice GivenTerminatedEviction

The status associated with the lease

tenant_idslist of stringsOptional

An array of Propexo lead, applicant, or resident IDs. This must also include the primary contact ID

move_in_datedatetime or stringOptional

The desired move-in date to the unit listed in the application

move_out_datedatetime or stringOptional

The desired move-out date to the unit listed in the application

rent_amount_in_centsintegerOptional>=0

The rent amount in cents for the lease

notesstringOptional

Notes associated with the applicant

signature_datedatetime or stringOptional

The signature date of the lease

deposit_amount_in_centsintegerOptional>=0

The deposit amount in cents associated with the lease

deposit_charge_datedatetime or stringOptional

The deposit date associated with the lease

realized_move_in_datedatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The move-in date associated with the lease

realized_move_out_datedatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The move-out date associated with the lease

middle_namestringOptional

The middle name associated with the applicant

maiden_namestringOptional

The maiden name associated with the applicant

phone_1_typeenumOptional
Allowed values: FAXHOMEMOBILEWORK

Type of the primary phone number

phone_2stringOptionalformat: "^\d{10}$"

Secondary phone number associated with the applicant

phone_2_typeenumOptional
Allowed values: FAXHOMEMOBILEWORK

Type of the secondary phone number

desired_lease_term_in_monthsstringOptional

The desired lease term in months of the applicant

is_evictedbooleanOptionalDefaults to false

Whether the applicant has been evicted

is_felonybooleanOptionalDefaults to false

Whether the applicant has a felony

is_criminal_chargebooleanOptionalDefaults to false

Whether the applicant has a criminal charge

eviction_descriptionstringOptional

The description of the eviction

felony_descriptionstringOptional

The description of the felony

criminal_charge_descriptionstringOptional

The description of the criminal charge

marital_status"SINGLE" or "MARRIED"Optional
Allowed values: SINGLEMARRIED

The marital status of the applicant

identification_numberstringOptional

The social security number of the applicant

drivers_license_numberstringOptional

The driver’s license number of the applicant

address_historylist of objectsOptional

The address history of the applicant

emergency_contactslist of objectsOptional

A list of emergency contacts for the applicant

employment_historylist of objectsOptional

The employment history of the applicant

other_incomelist of objectsOptional

A list of other income sources for the applicant

vehicleslist of objectsOptional

A list of vehicles for the application

petslist of objectsOptional

A list of applicant pets

concession_feeslist of objectsOptional

A list of concession fees for the application

application_feeslist of objectsOptional

A list of application fees for the application

other_occupantslist of objectsOptional

A list of other occupants for the application

Response

Successful response

job_idstring

The ID of the job created to handle this operation

dataobject

Errors