Leads

Create lead

Create a lead for an integration.

post/v1/leads/

Request

  • Base URL: https://api.propexo.com
  • URL: https://api.propexo.com/v1/leads/
  • Auth: HTTP bearer

Request body

integration_idstring required
property_idstring

The Propexo unique identifier for the property

first_namestring

The first name associated with the lead

last_namestring

The last name associated with the lead

employee_idstring

The Propexo unique identifier for the employee

desired_unit_idsstring[]

An array of the Propexo unit IDs that the lead is interested in

unit_idstring

The Propexo unique identifier for the unit

number_of_additional_occupantsinteger

The number of additional occupants associated with the lead

desired_num_bathroomsnumber double

The desired number of bathrooms

desired_num_bedroomsnumber double

The desired number of bedrooms

credit_scorestring

The credit score of the lead

email_1string

The primary email address associated with the lead

has_catsboolean

Whether or not the lead has cats

has_dogsboolean

Whether or not the lead has dogs

has_other_petsboolean

Whether or not the lead has pets that aren't dogs or cats

desired_max_rent_in_centsinteger

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

monthly_income_in_centsinteger

The monthly income of the lead, in cents

middle_initialstring

The middle initial of the lead

phone_1string

Primary phone number associated with the lead

lead_sourcestring

The name of the source of the lead

status'ACTIVE' | 'COLD' | 'INACTIVE' | 'WAITLISTED'

The status associated with the lead

desired_bathroomsstring

Deprecated. Use desired_num_bathrooms instead.

desired_bedroomsinteger

Deprecated. Use desired_num_bedrooms instead.

lead_source_idstring

The Propexo unique identifier for the lead source

lease_period_idstring

The Propexo unique identifier for the lease period

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

Type of the primary phone number

middle_namestring

The middle name associated with the lead

phone_2string

Secondary phone number associated with the lead

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

Type of the secondary phone number

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

desired_min_rent_in_centsnumber double nullable

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

number_of_occupantsinteger

The number of occupants living in the unit

notesstring

Notes associated with the lead

address_type_idstring

The Propexo unique identifier for the address type

desired_lease_term_in_monthsstring

The amount of months for the lease term

applicant_status'APPLICANT' | 'CO_APPLICANT' | 'OCCUPANT'

The applicant status of the lead. This is optional and defaults to APPLICANT.

countrystring

The country associated with the lead

status_rawstring

The raw status associated with the lead

desired_unit_typestring

The desired type of unit

lead_relationship_idstring

The Propexo unique identifier for the lead relationship

floor_plan_idstring

The Propexo unique identifier for the floor plan

third_party_idstring

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

organization_namestring

The name of your organization. Yardi uses this for associating a lead

Response

Successful response

job_idstring required

The ID of the job created to handle this operation

dataV1LeadsPostOutputData required

Changes

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