Update Lead: AppFolio
Update Lead: AppFolio
| Method | Interface |
|---|---|
| PATCH /v0/leads | Leads |
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
lead_id
The ID of the resource.
Request
This endpoint expects an object.
employee_id
The Propexo unique identifier for the employee
desired_unit_ids
An array of the Propexo unit IDs that the lead is interested in
unit_id
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
first_name
The first name associated with the lead
last_name
The last name associated with the lead
number_of_additional_occupants
The number of additional occupants associated with the lead
desired_num_bathrooms
The desired number of bathrooms
desired_num_bedrooms
The desired number of bedrooms
credit_score
The credit score of the lead
target_move_in_date
The target move in date associated with the lead
email_1
The primary email address associated with the lead
has_cats
Whether or not the lead has cats
has_dogs
Whether or not the lead has dogs
has_other_pets
Whether or not the lead has pets that aren't dogs or cats
desired_max_rent_in_cents
The maximum rent cost the lead is looking to pay, in cents
monthly_income_in_cents
The monthly income of the lead, in cents
middle_initial
The middle initial of the lead
phone_1
Primary phone number associated with the lead
lead_source
The name of the source of the lead
status
The status associated with the lead
Allowed values:
inactive_reason
The reason the lead is inactive
desired_move_in_dateDeprecated
Deprecated. Use target_move_in_date instead.
desired_bathroomsDeprecated
Deprecated. Use desired_num_bathrooms instead.
desired_bedroomsDeprecated
Deprecated. Use desired_num_bedrooms instead.
Response
Successful response
meta
result
