> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.propexo.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.propexo.com/_mcp/server. # Update Lease: Yardi PUT https://api.propexo.com/v1/leases/yardi/{lease_id} Content-Type: application/json Update Lease: Yardi | Interface | Method | |---|---| | ILS Guest Card | ImportYardiGuest_Login | | ILS Guest Card | ImportApplication_Login | Reference: https://docs.propexo.com/api-reference/yardi/leases/update-lease-yardi ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Servers - `https://api.propexo.com` (Production, default) - `https://api.sandbox.propexo.com` (Sandbox) ## Request ### Path parameters - `lease_id` (string, required) — The Propexo unique identifier for the lease ### Body (application/json) This endpoint expects a _v1_leases_yardi_{lease_id}_put_input. - `resident_id` (string, required) — The Propexo unique identifier for the resident - `first_name` (string, optional) — The first name associated with the applicant - `last_name` (string, optional) — The last name associated with the applicant - `middle_name` (string, optional) — The middle name associated with the applicant - `maiden_name` (string, optional) — The maiden name associated with the applicant - `email_1` (string, optional) — The primary email address associated with the applicant - `phone_1` (string, optional) — Primary phone number associated with the applicant - `phone_1_type` (enum, optional) — Type of the primary phone number - Allowed values: `FAX`, `HOME`, `MOBILE`, `WORK` - `phone_2` (string, optional) — Secondary phone number associated with the applicant - `phone_2_type` (enum, optional) — Type of the secondary phone number - Allowed values: `FAX`, `HOME`, `MOBILE`, `WORK` - `move_in_date` (V1LeasesYardiLeaseIdPutInputMoveInDate, optional) — The desired move-in date to the unit listed in the application - `move_out_date` (V1LeasesYardiLeaseIdPutInputMoveOutDate, optional) — The desired move-out date to the unit listed in the application - `desired_lease_term_in_months` (string, optional) — The desired lease term in months of the applicant - `date_of_birth` (V1LeasesYardiLeaseIdPutInputDateOfBirth, optional) — The date of birth associated with the applicant - `notes` (string, optional) — Notes associated with the applicant - `is_evicted` (boolean, optional) — Whether the applicant has been evicted - `is_felony` (boolean, optional) — Whether the applicant has a felony - `is_criminal_charge` (boolean, optional) — Whether the applicant has a criminal charge - `eviction_description` (string, optional) — The description of the eviction - `felony_description` (string, optional) — The description of the felony - `criminal_charge_description` (string, optional) — The description of the criminal charge - `marital_status` (enum, optional) — The marital status of the applicant - Allowed values: `SINGLE`, `MARRIED` - `identification_number` (string, optional) — The social security number of the applicant - `drivers_license_number` (string, optional) — The driver's license number of the applicant - `address_history` (list of V1LeasesYardiLeaseIdPutInputAddressHistoryItems, optional) — The address history of the applicant - `emergency_contacts` (list of V1LeasesYardiLeaseIdPutInputEmergencyContactsItems, optional) — A list of emergency contacts for the applicant - `employment_history` (list of V1LeasesYardiLeaseIdPutInputEmploymentHistoryItems, optional) — The employment history of the applicant - `other_income` (list of V1LeasesYardiLeaseIdPutInputOtherIncomeItems, optional) — A list of other income sources for the applicant - `vehicles` (list of V1LeasesYardiLeaseIdPutInputVehiclesItems, optional) — A list of vehicles for the application - `pets` (list of V1LeasesYardiLeaseIdPutInputPetsItems, optional) — A list of applicant pets - `concession_fees` (list of V1LeasesYardiLeaseIdPutInputConcessionFeesItems, optional) — A list of concession fees for the application - `application_fees` (list of V1LeasesYardiLeaseIdPutInputApplicationFeesItems, optional) — A list of application fees for the application - `other_occupants` (list of V1LeasesYardiLeaseIdPutInputOtherOccupantsItems, optional) — A list of other occupants for the application ## Response ### 200 Successful response - `meta` (V1LeasesYardiLeaseIdPutOutputMeta, required) - `result` (V1LeasesYardiLeaseIdPutOutputResult, required) ## Errors ### 400 Bad Request Error Bad Request - `error` (ErrorResponseError, required) ## Types ### V1LeasesYardiLeaseIdPutInputMoveInDate The desired move-in date to the unit listed in the application ### V1LeasesYardiLeaseIdPutInputMoveOutDate The desired move-out date to the unit listed in the application ### V1LeasesYardiLeaseIdPutInputDateOfBirth The date of birth associated with the applicant ### V1LeasesYardiLeaseIdPutInputAddressHistoryItems - `address_1` (string, required) — The first address line associated with the applicant's historical address - `city` (string, required) — The city associated with the applicant's historical address - `state` (enum, required) — The state associated with the applicant - Allowed values: `AA`, `AE`, `AK`, `AL`, `AP`, `AR`, `AS`, `AZ`, `CA`, `CO`, `CT`, `DC`, `DE`, `FL`, `FM`, `GA`, `GU`, `HI`, `IA`, `ID`, `IN`, `KS`, `KY`, `LA`, `MA`, `MD`, `ME`, `MH`, `MI`, `MN`, `MO`, `MP`, `MS`, `MT`, `NC`, `NE`, `NL`, `NJ`, `NM`, `NV`, `NY`, `OH`, `OK`, `OR`, `PA`, `PR`, `SD`, `TN`, `TX`, `UT`, `VA`, `VI`, `VT`, `WA`, `WI`, `WV`, `WY`, `AB`, `BC`, `MB`, `NB`, `NL`, `NT`, `NS`, `NU`, `ON`, `PE`, `QC`, `SK`, `YT` - `zip` (string, required) — The zip code associated with the applicant's historical address - `notice_provided` (boolean, required) — Whether notice has been given to the applicant's historical address - `move_in_date` (V1LeasesYardiLeaseIdPutInputAddressHistoryItemsMoveInDate, required) — The date when the applicant moved into their historical address - `country` (enum, optional) — The country associated with the applicant's historical address. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help - Allowed values: `US`, `CA` - `property_name` (string, optional) — The property name of the applicant's historical address - `reason_for_leaving` (string, optional) — The reason the applicant left their historical address - `monthly_payment_in_cents` (integer, optional) — For the applicant's historical address, the applicant's monthly payment for rent or mortgage in cents - `move_out_date` (V1LeasesYardiLeaseIdPutInputAddressHistoryItemsMoveOutDate, optional) — The date when the applicant moved out of their historical address. If this is the applicant's current address, omit this field - `manager_phone` (string, optional) — The phone number of a property manager who works at this address - `manager_email` (string, optional) — The email of a property manager who works at this address - `management_company` (string, optional) — The name of the company who owns the property at this address ### V1LeasesYardiLeaseIdPutInputEmergencyContactsItems - `first_name` (string, required) — The first name of the emergency contact - `last_name` (string, required) — The last name of the emergency contact - `relationship` (enum, required) — The relationship of the emergency contact to the applicant - Allowed values: `DAUGHTER`, `FRIEND`, `HUSBAND`, `SON`, `WIFE`, `OTHER` - `address_1` (string, optional) — The first line of the address of the emergency contact - `city` (string, optional) — The city of the address of the emergency contact - `state` (enum, optional) — The state of the address of the emergency contact - Allowed values: `AA`, `AE`, `AK`, `AL`, `AP`, `AR`, `AS`, `AZ`, `CA`, `CO`, `CT`, `DC`, `DE`, `FL`, `FM`, `GA`, `GU`, `HI`, `IA`, `ID`, `IN`, `KS`, `KY`, `LA`, `MA`, `MD`, `ME`, `MH`, `MI`, `MN`, `MO`, `MP`, `MS`, `MT`, `NC`, `NE`, `NL`, `NJ`, `NM`, `NV`, `NY`, `OH`, `OK`, `OR`, `PA`, `PR`, `SD`, `TN`, `TX`, `UT`, `VA`, `VI`, `VT`, `WA`, `WI`, `WV`, `WY`, `AB`, `BC`, `MB`, `NB`, `NL`, `NT`, `NS`, `NU`, `ON`, `PE`, `QC`, `SK`, `YT` - `zip` (string, optional) — The zip code of the address of the emergency contact - `country` (enum, optional) — The country of the address of the emergency contact. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help - Allowed values: `US`, `CA` - `phone_1` (string, optional) — The phone number of the emergency contact ### V1LeasesYardiLeaseIdPutInputEmploymentHistoryItems - `is_current_employer` (boolean, required) — Whether this employment history entry is for a current employer - `name` (string, required) — The name of the employer - `start_date` (V1LeasesYardiLeaseIdPutInputEmploymentHistoryItemsStartDate, required) — The start date of the applicant's employment at this employer - `monthly_income_in_cents` (integer, required) — The monthly income of the applicant at this employer in cents - `end_date` (V1LeasesYardiLeaseIdPutInputEmploymentHistoryItemsEndDate, optional) — The end date of the applicant's employment at this employer. Ignore this field if is_current_employer is set to true - `address_1` (string, optional) — The first line of the address of the employer - `city` (string, optional) — The city of the address of the employer - `state` (enum, optional) — The state of the address of the employer - Allowed values: `AA`, `AE`, `AK`, `AL`, `AP`, `AR`, `AS`, `AZ`, `CA`, `CO`, `CT`, `DC`, `DE`, `FL`, `FM`, `GA`, `GU`, `HI`, `IA`, `ID`, `IN`, `KS`, `KY`, `LA`, `MA`, `MD`, `ME`, `MH`, `MI`, `MN`, `MO`, `MP`, `MS`, `MT`, `NC`, `NE`, `NL`, `NJ`, `NM`, `NV`, `NY`, `OH`, `OK`, `OR`, `PA`, `PR`, `SD`, `TN`, `TX`, `UT`, `VA`, `VI`, `VT`, `WA`, `WI`, `WV`, `WY`, `AB`, `BC`, `MB`, `NB`, `NL`, `NT`, `NS`, `NU`, `ON`, `PE`, `QC`, `SK`, `YT` - `zip` (string, optional) — The zip code of the address of the employer - `phone` (string, optional) — The phone number of the employer - `supervisor_first_name` (string, optional) — The first name of the applicant's supervisor at this employer - `supervisor_last_name` (string, optional) — The last name of the applicant's supervisor at this employer - `position` (string, optional) — The position held at this employer, or the job description of the applicant ### V1LeasesYardiLeaseIdPutInputOtherIncomeItems - `source` (string, required) — The source of the income for the applicant - `monthly_income_in_cents` (integer, required) — The monthly income from this income source in cents ### V1LeasesYardiLeaseIdPutInputVehiclesItems - `make` (string, required) — The make of the vehicle - `model` (string, optional) — The model of the vehicle - `year` (integer, optional) — The year the vehicle was made - `color` (string, optional) — The color of the vehicle - `license_plate_number` (string, optional) — The license plate number of the vehicle - `license_plate_state` (string, optional) — The issuing state of the license plate ### V1LeasesYardiLeaseIdPutInputPetsItems - `type` (string, required) — The type associated with the applicant pet - `name` (string, optional) — The name associated with the applicant pet - `age_in_years` (integer, optional) — The age in years of the applicant pet - `weight_in_pounds` (integer, optional) — The weight in pounds of the applicant pet - `breed` (string, optional) — The breed of the applicant pet - `color` (string, optional) — The color of the applicant pet - `gender` (string, optional) — The raw value for the gender of the applicant pet - `is_fixed` (boolean, optional) — Whether the applicant pet is fixed - `is_service_animal` (boolean, optional) — Whether the applicant pet is a service animal ### V1LeasesYardiLeaseIdPutInputConcessionFeesItems - `start_date` (V1LeasesYardiLeaseIdPutInputConcessionFeesItemsStartDate, required) — The start date of the applicant's recurring concession fee - `end_date` (V1LeasesYardiLeaseIdPutInputConcessionFeesItemsEndDate, required) — The end date of the applicant's recurring concession fee - `concession_id` (string, required) — The Propexo unique identifier for the concession. This concession must be associated with the unit that the applicant is applying for ### V1LeasesYardiLeaseIdPutInputApplicationFeesItems - `charge_code_id` (string, required) — The Propexo unique identifier for the charge code. This must be an application fee charge code - `amount_in_cents` (integer, required) — The application fee amount in cents - `description` (string, optional) — Description of the application fee ### V1LeasesYardiLeaseIdPutInputOtherOccupantsItems - `relationship` (enum, required) — The relationship of the occupant to the applicant - Allowed values: `ROOMMATE`, `SPOUSE`, `GUARANTOR`, `OTHER` - `first_name` (string, required) — The first name associated with the occupant - `last_name` (string, required) — The last name associated with the occupant - `third_party_id` (string, required) — A unique ID you would like to associate with the occupant. This is not the Yardi occupant ID - `organization_name` (string, required) — The name of your organization. Yardi uses this for associating an occupant - `email_1` (string, optional) — The primary email address associated with the occupant - `phone_1` (string, optional) — Primary phone number associated with the occupant - `phone_1_type` (enum, optional) — Type of the primary phone number - Allowed values: `FAX`, `HOME`, `MOBILE`, `WORK` - `phone_2` (string, optional) — Secondary phone number associated with the occupant - `phone_2_type` (enum, optional) — Type of the secondary phone number - Allowed values: `FAX`, `HOME`, `MOBILE`, `WORK` - `address_1` (string, optional) — The first address line associated with the occupant - `city` (string, optional) — The city associated with the occupant - `state` (enum, optional) — The state associated with the occupant - Allowed values: `AA`, `AE`, `AK`, `AL`, `AP`, `AR`, `AS`, `AZ`, `CA`, `CO`, `CT`, `DC`, `DE`, `FL`, `FM`, `GA`, `GU`, `HI`, `IA`, `ID`, `IN`, `KS`, `KY`, `LA`, `MA`, `MD`, `ME`, `MH`, `MI`, `MN`, `MO`, `MP`, `MS`, `MT`, `NC`, `NE`, `NL`, `NJ`, `NM`, `NV`, `NY`, `OH`, `OK`, `OR`, `PA`, `PR`, `SD`, `TN`, `TX`, `UT`, `VA`, `VI`, `VT`, `WA`, `WI`, `WV`, `WY`, `AB`, `BC`, `MB`, `NB`, `NL`, `NT`, `NS`, `NU`, `ON`, `PE`, `QC`, `SK`, `YT` - `zip` (string, optional) — The zip code associated with the occupant ### V1LeasesYardiLeaseIdPutOutputMeta - `job_id` (string, required) ### V1LeasesYardiLeaseIdPutOutputResult - `lease_id` (string, required) — The Propexo unique identifier for the lease - `resident_id` (string, required) — The Propexo unique identifier for the resident - `first_name` (string, optional) — The first name associated with the applicant - `last_name` (string, optional) — The last name associated with the applicant - `middle_name` (string, optional) — The middle name associated with the applicant - `maiden_name` (string, optional) — The maiden name associated with the applicant - `email_1` (string, optional) — The primary email address associated with the applicant - `phone_1` (string, optional) — Primary phone number associated with the applicant - `phone_1_type` (enum, optional) — Type of the primary phone number - Allowed values: `FAX`, `HOME`, `MOBILE`, `WORK` - `phone_2` (string, optional) — Secondary phone number associated with the applicant - `phone_2_type` (enum, optional) — Type of the secondary phone number - Allowed values: `FAX`, `HOME`, `MOBILE`, `WORK` - `move_in_date` (V1LeasesYardiLeaseIdPutOutputResultMoveInDate, optional) — The desired move-in date to the unit listed in the application - `move_out_date` (V1LeasesYardiLeaseIdPutOutputResultMoveOutDate, optional) — The desired move-out date to the unit listed in the application - `desired_lease_term_in_months` (string, optional) — The desired lease term in months of the applicant - `date_of_birth` (V1LeasesYardiLeaseIdPutOutputResultDateOfBirth, optional) — The date of birth associated with the applicant - `notes` (string, optional) — Notes associated with the applicant - `is_evicted` (boolean, optional) — Whether the applicant has been evicted - `is_felony` (boolean, optional) — Whether the applicant has a felony - `is_criminal_charge` (boolean, optional) — Whether the applicant has a criminal charge - `eviction_description` (string, optional) — The description of the eviction - `felony_description` (string, optional) — The description of the felony - `criminal_charge_description` (string, optional) — The description of the criminal charge - `marital_status` (enum, optional) — The marital status of the applicant - Allowed values: `SINGLE`, `MARRIED` - `identification_number` (string, optional) — The social security number of the applicant - `drivers_license_number` (string, optional) — The driver's license number of the applicant - `address_history` (list of V1LeasesYardiLeaseIdPutOutputResultAddressHistoryItems, optional) — The address history of the applicant - `emergency_contacts` (list of V1LeasesYardiLeaseIdPutOutputResultEmergencyContactsItems, optional) — A list of emergency contacts for the applicant - `employment_history` (list of V1LeasesYardiLeaseIdPutOutputResultEmploymentHistoryItems, optional) — The employment history of the applicant - `other_income` (list of V1LeasesYardiLeaseIdPutOutputResultOtherIncomeItems, optional) — A list of other income sources for the applicant - `vehicles` (list of V1LeasesYardiLeaseIdPutOutputResultVehiclesItems, optional) — A list of vehicles for the application - `pets` (list of V1LeasesYardiLeaseIdPutOutputResultPetsItems, optional) — A list of applicant pets - `concession_fees` (list of V1LeasesYardiLeaseIdPutOutputResultConcessionFeesItems, optional) — A list of concession fees for the application - `application_fees` (list of V1LeasesYardiLeaseIdPutOutputResultApplicationFeesItems, optional) — A list of application fees for the application - `other_occupants` (list of V1LeasesYardiLeaseIdPutOutputResultOtherOccupantsItems, optional) ### ErrorResponseError - `code` (string, required) - `message` (string, required) - `details` (map from string to any, optional) ### V1LeasesYardiLeaseIdPutInputAddressHistoryItemsMoveInDate The date when the applicant moved into their historical address ### V1LeasesYardiLeaseIdPutInputAddressHistoryItemsMoveOutDate The date when the applicant moved out of their historical address. If this is the applicant's current address, omit this field ### V1LeasesYardiLeaseIdPutInputEmploymentHistoryItemsStartDate The start date of the applicant's employment at this employer ### V1LeasesYardiLeaseIdPutInputEmploymentHistoryItemsEndDate The end date of the applicant's employment at this employer. Ignore this field if is_current_employer is set to true ### V1LeasesYardiLeaseIdPutInputConcessionFeesItemsStartDate The start date of the applicant's recurring concession fee ### V1LeasesYardiLeaseIdPutInputConcessionFeesItemsEndDate The end date of the applicant's recurring concession fee ### V1LeasesYardiLeaseIdPutOutputResultMoveInDate The desired move-in date to the unit listed in the application ### V1LeasesYardiLeaseIdPutOutputResultMoveOutDate The desired move-out date to the unit listed in the application ### V1LeasesYardiLeaseIdPutOutputResultDateOfBirth The date of birth associated with the applicant ### V1LeasesYardiLeaseIdPutOutputResultAddressHistoryItems - `address_1` (string, required) — The first address line associated with the applicant's historical address - `city` (string, required) — The city associated with the applicant's historical address - `state` (enum, required) — The state associated with the applicant - Allowed values: `AA`, `AE`, `AK`, `AL`, `AP`, `AR`, `AS`, `AZ`, `CA`, `CO`, `CT`, `DC`, `DE`, `FL`, `FM`, `GA`, `GU`, `HI`, `IA`, `ID`, `IN`, `KS`, `KY`, `LA`, `MA`, `MD`, `ME`, `MH`, `MI`, `MN`, `MO`, `MP`, `MS`, `MT`, `NC`, `NE`, `NL`, `NJ`, `NM`, `NV`, `NY`, `OH`, `OK`, `OR`, `PA`, `PR`, `SD`, `TN`, `TX`, `UT`, `VA`, `VI`, `VT`, `WA`, `WI`, `WV`, `WY`, `AB`, `BC`, `MB`, `NB`, `NL`, `NT`, `NS`, `NU`, `ON`, `PE`, `QC`, `SK`, `YT` - `zip` (string, required) — The zip code associated with the applicant's historical address - `notice_provided` (boolean, required) — Whether notice has been given to the applicant's historical address - `move_in_date` (V1LeasesYardiLeaseIdPutOutputResultAddressHistoryItemsMoveInDate, required) — The date when the applicant moved into their historical address - `country` (enum, optional) — The country associated with the applicant's historical address. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help - Allowed values: `US`, `CA` - `property_name` (string, optional) — The property name of the applicant's historical address - `reason_for_leaving` (string, optional) — The reason the applicant left their historical address - `monthly_payment_in_cents` (integer, optional) — For the applicant's historical address, the applicant's monthly payment for rent or mortgage in cents - `move_out_date` (V1LeasesYardiLeaseIdPutOutputResultAddressHistoryItemsMoveOutDate, optional) — The date when the applicant moved out of their historical address. If this is the applicant's current address, omit this field - `manager_phone` (string, optional) — The phone number of a property manager who works at this address - `manager_email` (string, optional) — The email of a property manager who works at this address - `management_company` (string, optional) — The name of the company who owns the property at this address ### V1LeasesYardiLeaseIdPutOutputResultEmergencyContactsItems - `first_name` (string, required) — The first name of the emergency contact - `last_name` (string, required) — The last name of the emergency contact - `relationship` (enum, required) — The relationship of the emergency contact to the applicant - Allowed values: `DAUGHTER`, `FRIEND`, `HUSBAND`, `SON`, `WIFE`, `OTHER` - `address_1` (string, optional) — The first line of the address of the emergency contact - `city` (string, optional) — The city of the address of the emergency contact - `state` (enum, optional) — The state of the address of the emergency contact - Allowed values: `AA`, `AE`, `AK`, `AL`, `AP`, `AR`, `AS`, `AZ`, `CA`, `CO`, `CT`, `DC`, `DE`, `FL`, `FM`, `GA`, `GU`, `HI`, `IA`, `ID`, `IN`, `KS`, `KY`, `LA`, `MA`, `MD`, `ME`, `MH`, `MI`, `MN`, `MO`, `MP`, `MS`, `MT`, `NC`, `NE`, `NL`, `NJ`, `NM`, `NV`, `NY`, `OH`, `OK`, `OR`, `PA`, `PR`, `SD`, `TN`, `TX`, `UT`, `VA`, `VI`, `VT`, `WA`, `WI`, `WV`, `WY`, `AB`, `BC`, `MB`, `NB`, `NL`, `NT`, `NS`, `NU`, `ON`, `PE`, `QC`, `SK`, `YT` - `zip` (string, optional) — The zip code of the address of the emergency contact - `country` (enum, optional) — The country of the address of the emergency contact. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help - Allowed values: `US`, `CA` - `phone_1` (string, optional) — The phone number of the emergency contact ### V1LeasesYardiLeaseIdPutOutputResultEmploymentHistoryItems - `is_current_employer` (boolean, required) — Whether this employment history entry is for a current employer - `name` (string, required) — The name of the employer - `start_date` (V1LeasesYardiLeaseIdPutOutputResultEmploymentHistoryItemsStartDate, required) — The start date of the applicant's employment at this employer - `monthly_income_in_cents` (integer, required) — The monthly income of the applicant at this employer in cents - `end_date` (V1LeasesYardiLeaseIdPutOutputResultEmploymentHistoryItemsEndDate, optional) — The end date of the applicant's employment at this employer. Ignore this field if is_current_employer is set to true - `address_1` (string, optional) — The first line of the address of the employer - `city` (string, optional) — The city of the address of the employer - `state` (enum, optional) — The state of the address of the employer - Allowed values: `AA`, `AE`, `AK`, `AL`, `AP`, `AR`, `AS`, `AZ`, `CA`, `CO`, `CT`, `DC`, `DE`, `FL`, `FM`, `GA`, `GU`, `HI`, `IA`, `ID`, `IN`, `KS`, `KY`, `LA`, `MA`, `MD`, `ME`, `MH`, `MI`, `MN`, `MO`, `MP`, `MS`, `MT`, `NC`, `NE`, `NL`, `NJ`, `NM`, `NV`, `NY`, `OH`, `OK`, `OR`, `PA`, `PR`, `SD`, `TN`, `TX`, `UT`, `VA`, `VI`, `VT`, `WA`, `WI`, `WV`, `WY`, `AB`, `BC`, `MB`, `NB`, `NL`, `NT`, `NS`, `NU`, `ON`, `PE`, `QC`, `SK`, `YT` - `zip` (string, optional) — The zip code of the address of the employer - `phone` (string, optional) — The phone number of the employer - `supervisor_first_name` (string, optional) — The first name of the applicant's supervisor at this employer - `supervisor_last_name` (string, optional) — The last name of the applicant's supervisor at this employer - `position` (string, optional) — The position held at this employer, or the job description of the applicant ### V1LeasesYardiLeaseIdPutOutputResultOtherIncomeItems - `source` (string, required) — The source of the income for the applicant - `monthly_income_in_cents` (integer, required) — The monthly income from this income source in cents ### V1LeasesYardiLeaseIdPutOutputResultVehiclesItems - `make` (string, required) — The make of the vehicle - `model` (string, optional) — The model of the vehicle - `year` (integer, optional) — The year the vehicle was made - `color` (string, optional) — The color of the vehicle - `license_plate_number` (string, optional) — The license plate number of the vehicle - `license_plate_state` (string, optional) — The issuing state of the license plate ### V1LeasesYardiLeaseIdPutOutputResultPetsItems - `type` (string, required) — The type associated with the applicant pet - `name` (string, optional) — The name associated with the applicant pet - `age_in_years` (integer, optional) — The age in years of the applicant pet - `weight_in_pounds` (integer, optional) — The weight in pounds of the applicant pet - `breed` (string, optional) — The breed of the applicant pet - `color` (string, optional) — The color of the applicant pet - `gender` (string, optional) — The raw value for the gender of the applicant pet - `is_fixed` (boolean, optional) — Whether the applicant pet is fixed - `is_service_animal` (boolean, optional) — Whether the applicant pet is a service animal ### V1LeasesYardiLeaseIdPutOutputResultConcessionFeesItems - `start_date` (V1LeasesYardiLeaseIdPutOutputResultConcessionFeesItemsStartDate, required) — The start date of the applicant's recurring concession fee - `end_date` (V1LeasesYardiLeaseIdPutOutputResultConcessionFeesItemsEndDate, required) — The end date of the applicant's recurring concession fee - `concession_id` (string, required) — The Propexo unique identifier for the concession. This concession must be associated with the unit that the applicant is applying for ### V1LeasesYardiLeaseIdPutOutputResultApplicationFeesItems - `charge_code_id` (string, required) — The Propexo unique identifier for the charge code. This must be an application fee charge code - `amount_in_cents` (integer, required) — The application fee amount in cents - `description` (string, optional) — Description of the application fee ### V1LeasesYardiLeaseIdPutOutputResultOtherOccupantsItems - `relationship` (enum, required) — The relationship of the occupant to the applicant - Allowed values: `ROOMMATE`, `SPOUSE`, `GUARANTOR`, `OTHER` - `first_name` (string, required) — The first name associated with the occupant - `last_name` (string, required) — The last name associated with the occupant - `third_party_id` (string, required) — A unique ID you would like to associate with the occupant. This is not the Yardi occupant ID - `organization_name` (string, required) — The name of your organization. Yardi uses this for associating an occupant - `email_1` (string, optional) — The primary email address associated with the occupant - `phone_1` (string, optional) — Primary phone number associated with the occupant - `phone_1_type` (enum, optional) — Type of the primary phone number - Allowed values: `FAX`, `HOME`, `MOBILE`, `WORK` - `phone_2` (string, optional) — Secondary phone number associated with the occupant - `phone_2_type` (enum, optional) — Type of the secondary phone number - Allowed values: `FAX`, `HOME`, `MOBILE`, `WORK` - `address_1` (string, optional) — The first address line associated with the occupant - `city` (string, optional) — The city associated with the occupant - `state` (enum, optional) — The state associated with the occupant - Allowed values: `AA`, `AE`, `AK`, `AL`, `AP`, `AR`, `AS`, `AZ`, `CA`, `CO`, `CT`, `DC`, `DE`, `FL`, `FM`, `GA`, `GU`, `HI`, `IA`, `ID`, `IN`, `KS`, `KY`, `LA`, `MA`, `MD`, `ME`, `MH`, `MI`, `MN`, `MO`, `MP`, `MS`, `MT`, `NC`, `NE`, `NL`, `NJ`, `NM`, `NV`, `NY`, `OH`, `OK`, `OR`, `PA`, `PR`, `SD`, `TN`, `TX`, `UT`, `VA`, `VI`, `VT`, `WA`, `WI`, `WV`, `WY`, `AB`, `BC`, `MB`, `NB`, `NL`, `NT`, `NS`, `NU`, `ON`, `PE`, `QC`, `SK`, `YT` - `zip` (string, optional) — The zip code associated with the occupant ### V1LeasesYardiLeaseIdPutOutputResultAddressHistoryItemsMoveInDate The date when the applicant moved into their historical address ### V1LeasesYardiLeaseIdPutOutputResultAddressHistoryItemsMoveOutDate The date when the applicant moved out of their historical address. If this is the applicant's current address, omit this field ### V1LeasesYardiLeaseIdPutOutputResultEmploymentHistoryItemsStartDate The start date of the applicant's employment at this employer ### V1LeasesYardiLeaseIdPutOutputResultEmploymentHistoryItemsEndDate The end date of the applicant's employment at this employer. Ignore this field if is_current_employer is set to true ### V1LeasesYardiLeaseIdPutOutputResultConcessionFeesItemsStartDate The start date of the applicant's recurring concession fee ### V1LeasesYardiLeaseIdPutOutputResultConcessionFeesItemsEndDate The end date of the applicant's recurring concession fee ## Examples **Request** ```json { "resident_id": "res-1234567890abcdef" } ``` **Response** ```json { "meta": { "job_id": "job-9876543210fedcba" }, "result": { "lease_id": "lease-abcdef1234567890", "resident_id": "res-1234567890abcdef", "first_name": "Emily", "last_name": "Johnson", "middle_name": "Grace", "maiden_name": "Smith", "email_1": "emily.johnson@example.com", "phone_1": "4155551234", "phone_1_type": "MOBILE", "phone_2": "4155555678", "phone_2_type": "HOME", "move_in_date": "2023-08-01T14:00:00Z", "move_out_date": "2024-08-01T14:00:00Z", "desired_lease_term_in_months": "12", "date_of_birth": "1990-05-15", "notes": "Applicant prefers a ground floor unit.", "is_evicted": false, "is_felony": false, "is_criminal_charge": false, "eviction_description": "", "felony_description": "", "criminal_charge_description": "", "marital_status": "MARRIED", "identification_number": "123-45-6789", "drivers_license_number": "D1234567", "address_history": [ { "address_1": "123 Maple Street", "city": "San Francisco", "state": "CA", "zip": "94107", "notice_provided": true, "move_in_date": "2020-06-01", "country": "US", "property_name": "Maple Apartments", "reason_for_leaving": "Relocation for new job", "monthly_payment_in_cents": 250000, "move_out_date": "2023-07-15", "manager_phone": "4155557890", "manager_email": "manager@mapleapts.com", "management_company": "Maple Property Management" } ], "emergency_contacts": [ { "first_name": "Sarah", "last_name": "Johnson", "relationship": "WIFE", "address_1": "123 Maple Street", "city": "San Francisco", "state": "CA", "zip": "94107", "country": "US", "phone_1": "4155554321" } ], "employment_history": [ { "is_current_employer": true, "name": "Tech Solutions Inc.", "start_date": "2021-01-10", "monthly_income_in_cents": 850000, "end_date": "", "address_1": "456 Market Street", "city": "San Francisco", "state": "CA", "zip": "94105", "phone": "4155556789", "supervisor_first_name": "John", "supervisor_last_name": "Doe", "position": "Software Engineer" } ], "other_income": [ { "source": "Freelance Consulting", "monthly_income_in_cents": 150000 } ], "vehicles": [ { "make": "Toyota", "model": "Camry", "year": 2018, "color": "Blue", "license_plate_number": "7ABC123", "license_plate_state": "CA" } ], "pets": [ { "type": "Dog", "name": "Buddy", "age_in_years": 3, "weight_in_pounds": 45, "breed": "Labrador Retriever", "color": "Yellow", "gender": "Male", "is_fixed": true, "is_service_animal": false } ], "concession_fees": [ { "start_date": "2023-08-01", "end_date": "2024-07-31", "concession_id": "concession-001" } ], "application_fees": [ { "charge_code_id": "appfee-123", "amount_in_cents": 5000, "description": "Standard application fee" } ], "other_occupants": [ { "relationship": "ROOMMATE", "first_name": "Michael", "last_name": "Smith", "third_party_id": "occ-789", "organization_name": "Propexo", "email_1": "michael.smith@example.com", "phone_1": "4155559876", "phone_1_type": "MOBILE", "phone_2": "4155556543", "phone_2_type": "WORK", "address_1": "789 Pine Street", "city": "San Francisco", "state": "CA", "zip": "94108" } ] } } ``` **SDK Code** ```python import requests url = "https://api.propexo.com/v1/leases/yardi/lease_id" payload = { "resident_id": "res-1234567890abcdef" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.put(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.propexo.com/v1/leases/yardi/lease_id'; const options = { method: 'PUT', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"resident_id":"res-1234567890abcdef"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.propexo.com/v1/leases/yardi/lease_id" payload := strings.NewReader("{\n \"resident_id\": \"res-1234567890abcdef\"\n}") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.propexo.com/v1/leases/yardi/lease_id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Put.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"resident_id\": \"res-1234567890abcdef\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.put("https://api.propexo.com/v1/leases/yardi/lease_id") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"resident_id\": \"res-1234567890abcdef\"\n}") .asString(); ``` ```php request('PUT', 'https://api.propexo.com/v1/leases/yardi/lease_id', [ 'body' => '{ "resident_id": "res-1234567890abcdef" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.propexo.com/v1/leases/yardi/lease_id"); var request = new RestRequest(Method.PUT); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"resident_id\": \"res-1234567890abcdef\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["resident_id": "res-1234567890abcdef"] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.propexo.com/v1/leases/yardi/lease_id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PUT" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```