YardiLeads

Create Lead: Yardi

Create Lead: Yardi. When creating an lead along with an event, Propexo will create a base event of type "Other" as an initial lead event. If the event is one of the valid "first contact" events in Yardi (such as Other, WalkIn, Chat, Email, Text, Webservice), then Propexo will create the lead with the associated "first contact" event type. | Interface | Method | |---|---| | ILS Guest Card | ImportYardiGuest_Login |

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
lead_source_idstringRequired
The Propexo unique identifier for the lead source
employee_idstringRequired
The Propexo unique identifier for the employee
third_party_idstringRequired>=1 character
A unique value provided to the PMS to uniquely identify the lead from your system.
first_namestringRequired
The first name associated with the lead
last_namestringRequired
The last name associated with the lead
organization_namestringRequired
The name of your organization. Yardi uses this for associating a lead
unit_idstringOptional
The Propexo unique identifier for the unit
phone_1stringOptional
Primary phone number associated with the lead
phone_1_typeenumOptional
Type of the primary phone number
Allowed values:
phone_2stringOptional
Secondary phone number associated with the lead
phone_2_typeenumOptional
Type of the secondary phone number
Allowed values:
email_1stringOptional
The primary email address associated with the lead
address_1stringOptional
The first address line associated with the lead
address_2stringOptional
The second address line associated with the lead
citystringOptional
The city associated with the lead
statestringOptional
The state associated with the lead
zipstringOptional
The zip code associated with the lead
target_move_in_datestringOptional

The move-in date associated with the lead. The timestamp will be stripped off and only the date will be used

desired_num_bedroomsdoubleOptional
The desired number of bedrooms
desired_lease_term_in_monthsstringOptional
The amount of months for the lease term
notesstringOptional
Notes associated with the lead
eventslist of objectsOptional
A list of events to create for the new lead
desired_max_rent_in_centsintegerOptional>=0
The maximum rent cost the lead is looking to pay, in cents

Response

Successful response
metaobject
resultobject

Errors