{
  "job_id": "string",
  "data": {}
}

Path Parameters

idrequired
string

The ID of the resource.

idrequired
string

The ID of the resource.

Body

idrequired
string
last_name
string

The last name of the prospect.

first_name
string

The first name of the prospect.

email_1
string

The primary email address for the prospect.

phone_1
string

Prospect's primary phone number.

phone_1_type
string

The type of the prospect's primary phone number.

Available options:
FAX,
HOME,
MOBILE,
OTHER,
WORK
phone_2
string

Prospect's secondary phone number.

phone_2_type
string

The type of the prospect's secondary phone number.

Available options:
FAX,
HOME,
MOBILE,
OTHER,
WORK
address_1
string

First line of the street address for the prospect.

address_2
string

Second line of the street address for the prospect.

city
string

The city that the prospect lives in.

state
string

State of the prospect's primary address.

zip
string

Zip/Postal Code of the prospect's primary address.

country
string

Country of the prospect's primary address

lead_source
string

The source of the prospect lead.

lead_id
string

The Propify unique identifier for the lead

property_id
string

The Propify unique identifier for the property

unit_id
string

The Propify unique identifier for the unit

x_leasing_agent_id
string

The external ID of the leasing agent from the integration vendor

x_lead_source_id
string

The external ID of the lead source from the integration vendor

middle_name
string

The middle name of the prospect.

desired_lease_term_in_months
string

The desired lease term in months of the prospect.

target_move_in_date
string

The target move in date for the prospect.

desired_num_bedrooms
number

The desired number of bedrooms the prospect would like.

desired_num_bathrooms
number

The desired number of bathrooms the prospect would like.

desired_floor_plan_id
string

The PMS id for the floor plan of the desired unit.

desired_max_rent_in_cents
number | null

The maximum rent cost the prospect is looking at pay, in cents.

desired_min_rent_in_cents
number | null

The minimum rent cost the prospect is looking at pay, in cents.

number_of_occupants
number

The number of occupants the prospect is planning to reside with.

notes
string

General notes about the prospect.

events
array

Array of events associated with this lead.

desired_unit_number
string

The desired unit number of the prospect.

status
string

The status of the prospect

desired_unit_type
string

The desired unit type of the prospect.

Response

job_idrequired
string

The ID of the job created to handle this operation

datarequired
object

Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.