AppfolioLeads

Create Lead: AppFolio

Create Lead: AppFolio | Method | Interface | |---|---| | POST /v0/leads | Leads |

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
first_namestringRequired
The first name associated with the lead
last_namestringRequired
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. If desired_unit_ids is not provided, this will be used as the unit ID. This is inteded to help unify the request payload across all PMSs

number_of_additional_occupantsintegerOptional>=0
The number of additional occupants associated with the lead
desired_num_bathroomsstringOptional
The desired number of bathrooms
desired_num_bedroomsintegerOptional>=0
The desired number of bedrooms
credit_scorestringOptional
The credit score of the lead
target_move_in_datestringOptional
The target move in date associated with the lead
email_1stringOptional
The primary email address associated with the lead
has_catsbooleanOptional
Whether or not the lead has cats
has_dogsbooleanOptional
Whether or not the lead has dogs
has_other_petsbooleanOptional
Whether or not the lead has pets that aren't dogs or cats
desired_max_rent_in_centsintegerOptional>=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:
desired_move_in_datestringOptionalDeprecated

Deprecated. Use target_move_in_date instead.

desired_bathroomsstringOptionalDeprecated

Deprecated. Use desired_num_bathrooms instead.

desired_bedroomsintegerOptional>=0Deprecated

Deprecated. Use desired_num_bedrooms instead.

Response

Successful response
metaobject
resultobject

Errors