Leases

Update lease

Update a lease for an integration.

put/v1/leases/{lease_id}

Request

  • Base URL: https://api.propexo.com
  • URL: https://api.propexo.com/v1/leases/{lease_id}
  • Auth: HTTP bearer

Path parameters

lease_idstring required

The ID of the resource.

Request body

unit_idstring

The Propexo unique identifier for the unit

type'Fixed' | 'FixedWithRollover' | 'AtWill'

The type associated with the lease

is_eviction_pendingboolean

Whether the lease has an eviction pending

automatically_move_out_residentsboolean

Whether residents should be set to "past" status automatically at the expiration of the lease

property_idstring

The Propexo unique identifier for the property

resident_idstring

The Propexo unique identifier for the resident

scheduled_move_in_datestring date-time

The move-in date associated with the lease

first_namestring

The first name associated with the applicant

last_namestring

The last name associated with the applicant

address_1string

The first address line associated with the applicant

address_2string

The second address line associated with the resident

citystring

The city associated with the applicant

statestring

The state associated with the applicant

zipstring

The zip code associated with the applicant

email_1string email

The primary email address associated with the applicant

phone_1string

Primary phone number associated with the applicant

primary_contact_idstring

The Propexo unique identifier of the primary contact. This must either be a lead, applicant, or resident in Propexo

status'PENDING' | 'APPROVED' | 'CANCELED' | 'DENIED' | 'SIGNED'

The status associated with the applicant

tenant_idsstring[]

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

rent_amount_in_centsinteger

The rent amount in cents for the lease

notesstring

Notes associated with the applicant

deposit_amount_in_centsinteger

The deposit amount in cents associated with the lease

realized_move_in_datestring date-time

The move-in date associated with the lease

realized_move_out_datestring date-time

The move-out date associated with the lease

applicant_idstring

The Propexo unique identifier for the applicant

phone_1_type'FAX' | 'HOME' | 'MOBILE' | 'WORK'

Type of the primary phone number

phone_2string

Secondary phone number associated with the applicant

phone_2_type'FAX' | 'HOME' | 'MOBILE' | 'WORK'

Type of the secondary phone number

rent_amount_market_in_centsinteger

The market rent amount in cents for the lease

middle_namestring

The middle name associated with the applicant

maiden_namestring

The maiden name associated with the applicant

desired_lease_term_in_monthsstring

The desired lease term in months of the applicant

is_evictedboolean

Whether the applicant has been evicted

is_felonyboolean

Whether the applicant has a felony

is_criminal_chargeboolean

Whether the applicant has a criminal charge

eviction_descriptionstring

The description of the eviction

felony_descriptionstring

The description of the felony

criminal_charge_descriptionstring

The description of the criminal charge

marital_status'SINGLE' | 'MARRIED'

The marital status of the applicant

identification_numberstring

The social security number of the applicant

drivers_license_numberstring

The driver's license number of the applicant

Response

Successful response

job_idstring required

The ID of the job created to handle this operation

dataV1LeasesLeaseIdPutOutputData required

Changes

No recorded changes to this operation across all 1 revision of this API.