For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
How It WorksKnowledge BaseOnboardingVideo TutorialsPMS GuidanceAPI ReferenceRelease Notes
    • Overview
    • PMS Generic APIs
    • CRM Generic APIs
    • PMS APIs
        • GETGet all leases
        • GETGet a lease by ID
        • GETGet all Lease Transfers
        • GETGet Lease Transfer by ID
        • PUTUpdate Lease: Yardi
        • POSTCreate Lease: Yardi
        • POSTCreate Lease file: Yardi - Not Supported
    • CRM APIs
    • Download OpenAPI Spec
Dashboard
LogoLogo
Yardi (Legacy)Leases

Create Lease: Yardi

POST
/v1/leases/yardi/
POST
/v1/leases/yardi/
$curl -X POST https://api.propexo.com/v1/leases/yardi/ \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "integration_id": "intg-987654321",
>  "property_id": "prop-123456789",
>  "unit_id": "unit-456789123"
>}'
1{
2  "meta": {
3    "job_id": "job-20240615-001"
4  },
5  "result": {
6    "integration_id": "intg-987654321",
7    "property_id": "prop-123456789",
8    "unit_id": "unit-456789123",
9    "lead_id": "lead-654321987",
10    "employee_id": "emp-321654987",
11    "lead_source_id": "source-789123456",
12    "third_party_id": "applicant-20240615-01",
13    "organization_name": "Sunset Property Management",
14    "first_name": "Emily",
15    "last_name": "Johnson",
16    "middle_name": "Grace",
17    "maiden_name": "Smith",
18    "email_1": "emily.johnson@example.com",
19    "phone_1": "4155551234",
20    "phone_1_type": "MOBILE",
21    "phone_2": "4155555678",
22    "phone_2_type": "HOME",
23    "move_in_date": "2024-07-01T10:00:00Z",
24    "move_out_date": "2025-06-30T10:00:00Z",
25    "desired_lease_term_in_months": "12",
26    "date_of_birth": "1990-04-15",
27    "notes": "Applicant prefers a unit with a balcony.",
28    "is_evicted": false,
29    "is_felony": false,
30    "is_criminal_charge": false,
31    "eviction_description": "",
32    "felony_description": "",
33    "criminal_charge_description": "",
34    "marital_status": "SINGLE",
35    "identification_number": "123-45-6789",
36    "drivers_license_number": "D1234567",
37    "address_history": [
38      {
39        "address_1": "123 Maple Street",
40        "city": "San Francisco",
41        "state": "CA",
42        "zip": "94107",
43        "notice_provided": true,
44        "move_in_date": "2020-06-01",
45        "country": "US",
46        "property_name": "Maple Apartments",
47        "reason_for_leaving": "Lease ended",
48        "monthly_payment_in_cents": 250000,
49        "move_out_date": "2024-05-31",
50        "manager_phone": "4155557890",
51        "manager_email": "manager@mapleapts.com",
52        "management_company": "Maple Property Group"
53      }
54    ],
55    "emergency_contacts": [
56      {
57        "first_name": "Michael",
58        "last_name": "Johnson",
59        "relationship": "HUSBAND",
60        "address_1": "456 Oak Avenue",
61        "city": "San Francisco",
62        "state": "CA",
63        "zip": "94110",
64        "country": "US",
65        "phone_1": "4155554321"
66      }
67    ],
68    "employment_history": [
69      {
70        "is_current_employer": true,
71        "name": "Tech Solutions Inc.",
72        "start_date": "2018-09-01",
73        "monthly_income_in_cents": 850000,
74        "end_date": "",
75        "address_1": "789 Market Street",
76        "city": "San Francisco",
77        "state": "CA",
78        "zip": "94103",
79        "phone": "4155556789",
80        "supervisor_first_name": "Sarah",
81        "supervisor_last_name": "Lee",
82        "position": "Software Engineer"
83      }
84    ],
85    "other_income": [
86      {
87        "source": "Freelance Consulting",
88        "monthly_income_in_cents": 150000
89      }
90    ],
91    "vehicles": [
92      {
93        "make": "Toyota",
94        "model": "Camry",
95        "year": 2018,
96        "color": "Blue",
97        "license_plate_number": "7ABC123",
98        "license_plate_state": "CA"
99      }
100    ],
101    "pets": [
102      {
103        "type": "Dog",
104        "name": "Buddy",
105        "age_in_years": 3,
106        "weight_in_pounds": 45,
107        "breed": "Labrador Retriever",
108        "color": "Yellow",
109        "gender": "Male",
110        "is_fixed": true,
111        "is_service_animal": false
112      }
113    ],
114    "concession_fees": [
115      {
116        "start_date": "2024-07-01",
117        "end_date": "2024-12-31",
118        "concession_id": "concession-001"
119      }
120    ],
121    "application_fees": [
122      {
123        "charge_code_id": "fee-application-01",
124        "amount_in_cents": 5000,
125        "description": "Standard application fee"
126      }
127    ],
128    "other_occupants": [
129      {
130        "relationship": "ROOMMATE",
131        "first_name": "Alex",
132        "last_name": "Martinez",
133        "third_party_id": "occupant-20240615-01",
134        "organization_name": "Sunset Property Management",
135        "email_1": "alex.martinez@example.com",
136        "phone_1": "4155558765",
137        "phone_1_type": "MOBILE",
138        "phone_2": "4155554322",
139        "phone_2_type": "WORK",
140        "address_1": "123 Maple Street",
141        "city": "San Francisco",
142        "state": "CA",
143        "zip": "94107"
144      }
145    ]
146  }
147}
Create Lease: Yardi | Interface | Method | |---|---| | ILS Guest Card | ImportYardiGuest_Login | | ILS Guest Card | ImportApplication_Login | <Note title="Notice">This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately.</Note>
Was this page helpful?
Previous

Create Lease file: Yardi - Not Supported

Next
Built with

Create Lease: Yardi

InterfaceMethod
ILS Guest CardImportYardiGuest_Login
ILS Guest CardImportApplication_Login
Notice
This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
integration_idstringRequired
The Propexo unique identifier for the integration
property_idstringRequired
The Propexo unique identifier for the property
unit_idstringRequired
The Propexo unique identifier for the unit
lead_idstringOptional
The Propexo unique identifier for the lead. The lead will be converted to an applicant
employee_idstringOptional

The Propexo unique identifier for the employee. Employee must have a role of LEASING_AGENT. Required if lead_id is not specified

lead_source_idstringOptional

The Propexo unique identifier for the lead source. Required if lead_id is not specified

third_party_idstringOptional>=1 character

A unique ID you would like to associate with the applicant. This is not the Yardi applicant ID. Required if lead_id is not specified

organization_namestringOptional

The name of your organization. Yardi uses this for associating an applicant. Required if lead_id is not specified

first_namestringOptional

The first name associated with the applicant. Required if lead_id is not specified

last_namestringOptional

The last name associated with the applicant. Required if lead_id is not specified

middle_namestringOptional
The middle name associated with the applicant
maiden_namestringOptional
The maiden name associated with the applicant
email_1stringOptionalformat: "email"
The primary email address associated with the applicant
phone_1stringOptionalformat: "^\d{10}$"
Primary phone number associated with the applicant
phone_1_typeenumOptional
Type of the primary phone number
Allowed values:
phone_2stringOptionalformat: "^\d{10}$"
Secondary phone number associated with the applicant
phone_2_typeenumOptional
Type of the secondary phone number
Allowed values:
move_in_datestringOptional

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

move_out_datestringOptional

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

desired_lease_term_in_monthsstringOptional
The desired lease term in months of the applicant
date_of_birthstringOptional
The date of birth associated with the applicant
notesstringOptional
Notes associated with the applicant
is_evictedbooleanOptional
Whether the applicant has been evicted
is_felonybooleanOptional
Whether the applicant has a felony
is_criminal_chargebooleanOptional
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_statusenumOptional
The marital status of the applicant
Allowed values:
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
metaobject
resultobject

Errors

400
Bad Request Error