API ReferenceLeads

Create lead

Create a lead for an integration.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
integration_idstringRequired
property_idstringOptional
The Propexo unique identifier for the property
first_namestringOptional
The first name associated with the lead
last_namestringOptional
The last name associated with the lead
employee_idstringOptional
The Propexo unique identifier for the employee
desired_unit_idslist of stringsOptional
An array of the Propexo unit IDs that the lead is interested in
unit_idstringOptional
The Propexo unique identifier for the unit
number_of_additional_occupantsintegerOptional>=0
The number of additional occupants associated with the lead
desired_num_bathroomsdoubleOptional>=0
The desired number of bathrooms
desired_num_bedroomsdoubleOptional
The desired number of bedrooms
credit_scorestringOptional
The credit score of the lead
target_move_in_datedatetime or stringOptional

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

email_1stringOptional
The primary email address associated with the lead
has_catsbooleanOptionalDefaults to false
Whether or not the lead has cats
has_dogsbooleanOptionalDefaults to false
Whether or not the lead has dogs
has_other_petsbooleanOptionalDefaults to false
Whether or not the lead has pets that aren't dogs or cats
desired_max_rent_in_centsdoubleOptional>=0
The maximum rent cost the lead is looking to pay, in cents
monthly_income_in_centsintegerOptional>=0
The monthly income of the lead, in cents
middle_initialstringOptional=1 character
The middle initial of the lead
phone_1stringOptional
Primary phone number associated with the lead
lead_sourcestringOptional
The name of the source of the lead
statusenumOptional
The status associated with the lead
Allowed values:
lead_source_idstringOptional
The Propexo unique identifier for the lead source
lease_period_idstringOptional
The Propexo unique identifier for the lease period
phone_1_typeenumOptional
Type of the primary phone number
Allowed values:
middle_namestringOptional
The middle name associated with the lead
phone_2stringOptional
Secondary phone number associated with the lead
phone_2_typeenumOptional
Type of the secondary phone number
Allowed values:
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
desired_min_rent_in_centsdoubleOptional
The minimum rent cost the lead is looking to pay, in cents
number_of_occupantsintegerOptional
The number of occupants living in the unit
notesstringOptional
Notes associated with the lead
address_type_idstringOptional
The Propexo unique identifier for the address type
desired_lease_term_in_monthsstringOptional
The amount of months for the lease term
applicant_statusenumOptional
The applicant status of the lead. This is optional and defaults to APPLICANT.
Allowed values:
countrystringOptional
The country associated with the lead
status_rawstringOptional
The raw status associated with the lead
desired_unit_typestringOptional
The desired type of unit
lead_relationship_idstringOptional
The Propexo unique identifier for the lead relationship
date_of_birthdatetime or stringOptional
The date of birth associated with the lead
floor_plan_idstringOptional
The Propexo unique identifier for the floor plan
organization_namestringOptional
The name of your organization. Sample1 uses this for associating a prospect
third_party_idstringOptional
Any unique ID you would like to associate with a lead.
desired_move_in_datedatetime or stringOptionalDeprecated

Deprecated. Use target_move_in_date instead.

desired_bathroomsstringOptionalDeprecated

Deprecated. Use desired_num_bathrooms instead.

desired_bedroomsintegerOptional>=0Deprecated

Deprecated. Use desired_num_bedrooms instead.

eventslist of objectsOptionalDeprecated

DEPRECATED: Please use /events endpoints to write events. Array of events associated with this lead

Response

Successful response
job_idstring
The ID of the job created to handle this operation
dataobject

Errors