Create Lead: Yardi

POSThttps://api.propexo.com/v1/leads/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

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

lead_source_idstringrequired

The Propexo unique identifier for the lead source

employee_idstringrequired

The Propexo unique identifier for the employee

third_party_idstringrequired

A unique value provided to the PMS to uniquely identify the lead from your system.

Possible values: non-empty

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_idstring

The Propexo unique identifier for the unit

phone_1string

Primary phone number associated with the lead

phone_1_typestring
Type of the primary phone number
Show 4 enum values
FAXHOMEMOBILEWORK
phone_2string

Secondary phone number associated with the lead

phone_2_typestring
Type of the secondary phone number
Show 4 enum values
FAXHOMEMOBILEWORK
email_1string

The primary email address associated with the lead

address_1string

The first address line associated with the lead

address_2string

The second address line associated with the lead

citystring

The city associated with the lead

statestring

The state associated with the lead

zipstring

The zip code associated with the lead

target_move_in_datestring
The move-in date associated with the lead. The timestamp will be stripped off and only the date will be used
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
desired_num_bedroomsnumber

The desired number of bedrooms

desired_lease_term_in_monthsstring

The amount of months for the lease term

notesstring

Notes associated with the lead

events object[]
A list of events to create for the new lead
Array [
employee_idstringrequired
The Propexo unique identifier for the employee
lead_source_idstring
The Propexo unique identifier for the lead source
unit_idstring
The Propexo unique identifier for the unit. Only some events use this, including "Show" and "Appointment".
event_namestringrequired
The name or type of event. This has to be from a predefined set of events.
Show 13 enum values
CallToProspectCallFromProspectOtherWalkInChatEmailTextWebserviceAppointmentShowApplicationSelfGuidedTourApplication
event_datetimestring<date-time>required
The date when the event will occur
notesstring
Notes associated with the event
Possible values: <= 256 characters
reasons_for_eventstring
The reasons for the event
]
desired_max_rent_in_centsinteger

The maximum rent cost the lead is looking to pay, in cents

Possible values: >= 0

Response

Successful response

meta objectrequired
job_idstringrequired
result objectrequired

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

A unique value provided to the PMS to uniquely identify the lead from your system.

Possible values: non-empty

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_idstring | nullnullablerequired

The Propexo unique identifier for the unit

phone_1string | nullnullablerequired

Primary phone number associated with the lead

phone_1_typestring | nullnullablerequired

Type of the primary phone number

Show 4 enum values

FAXHOMEMOBILEWORK

phone_2string | nullnullablerequired

Secondary phone number associated with the lead

phone_2_typestring | nullnullablerequired

Type of the secondary phone number

Show 4 enum values

FAXHOMEMOBILEWORK

email_1string | nullnullablerequired

The primary email address associated with the lead

address_1string | nullnullablerequired

The first address line associated with the lead

address_2string | nullnullablerequired

The second address line associated with the lead

citystring | nullnullablerequired

The city associated with the lead

statestring | nullnullablerequired

The state associated with the lead

zipstring | nullnullablerequired

The zip code associated with the lead

target_move_in_datestring | nullnullablerequired

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

Show 2 variants

• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$

desired_num_bedroomsnumber | nullnullablerequired

The desired number of bedrooms

desired_lease_term_in_monthsstring | nullnullablerequired

The amount of months for the lease term

notesstring | nullnullablerequired

Notes associated with the lead

events object[]required

Array [

employee_idstringrequired

The Propexo unique identifier for the employee

lead_source_idstring

The Propexo unique identifier for the lead source

unit_idstring

The Propexo unique identifier for the unit. Only some events use this, including "Show" and "Appointment".

event_namestringrequired

The name or type of event. This has to be from a predefined set of events.

Show 13 enum values

CallToProspectCallFromProspectOtherWalkInChatEmailTextWebserviceAppointmentShowApplicationSelfGuidedTourApplication

event_datetimestring<date-time>required

The date when the event will occur

notesstring

Notes associated with the event

Possible values: <= 256 characters

reasons_for_eventstring

The reasons for the event

]

desired_max_rent_in_centsinteger | nullnullablerequired

The maximum rent cost the lead is looking to pay, in cents

Possible values: >= 0

Errors

• 400Bad Request

  error objectrequired
  codestringrequired
  Example: invalid_request
  messagestringrequired
  Example: invalid request
  details object
  property name*any
  Example: {"details":{"issues":[{"code":"unrecognized_keys","keys":["foo"],"path":[],"message":"Unrecognized key(s) in object: 'foo'"}],"name":"ZodError"}}

POST /v1/leads/yardi/

curl -X POST https://api.propexo.com/v1/leads/yardi/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "string",
  "property_id": "string",
  "lead_source_id": "string",
  "employee_id": "string",
  "third_party_id": "string",
  "first_name": "string",
  "last_name": "string",
  "organization_name": "string"
}'

200 Successful response

{
  "meta": {
    "job_id": "string"
  },
  "result": {
    "integration_id": "string",
    "property_id": "string",
    "lead_source_id": "string",
    "employee_id": "string",
    "third_party_id": "string",
    "first_name": "string",
    "last_name": "string",
    "organization_name": "string",
    "unit_id": "string",
    "phone_1": "string",
    "phone_1_type": "FAX",
    "phone_2": "string",
    "phone_2_type": "FAX",
    "email_1": "string",
    "address_1": "string",
    "address_2": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "target_move_in_date": "2024-07-29T15:51:28.071Z",
    "desired_num_bedrooms": 0,
    "desired_lease_term_in_months": "string",
    "notes": "string",
    "events": "Unknown Type: array,null",
    "desired_max_rent_in_cents": 0
  }
}