EntrataLeads

Create Lead: Entrata

Create Lead: Entrata | Method | |---| | leads/sendLeads |

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
first_namestringRequired
The first name associated with the lead
last_namestringRequired
The last name associated with the lead
unit_idstringOptional
The Propexo unique identifier for the unit
lease_period_idstringOptional
The Propexo unique identifier for the lease period
employee_idstringOptional
The Propexo unique identifier for the employee
phone_1stringOptional
Primary phone number associated with the lead. This is often required, but this is configurable to be optional by the property manager. Make sure this is being provided if it's configured to be required for your customer.
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:
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_datestringOptionalformat: "date-time"

The move-in date associated with the lead

desired_max_rent_in_centsintegerOptional
The maximum rent cost the lead is looking to pay, in cents
desired_min_rent_in_centsintegerOptional
The minimum rent cost the lead is looking to pay, in cents
desired_num_bathroomsdoubleOptional
The desired number of bathrooms
desired_num_bedroomsdoubleOptional
The desired number of bedrooms
number_of_occupantsintegerOptional
The number of occupants living in the unit
notesstringOptional
Notes associated with the lead
eventslist of objectsOptionalDeprecated

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

Response

Successful response
metaobject
resultobject

Errors