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

​
Lead Events

Some PMSs support events associated with a lead. In this case, consult the documentation for the specific PMS endpoint to see what fields and event types are available. Events often have varying payloads per PMS, so please see the vendor specific endpoint for details on the vendor specific requirements.

​
Body

integration_idrequired
string
last_name
string

The last name associated with the lead

first_name
string

The first name associated with the lead

email_1
string

The primary email address associated with the lead

phone_1
string

'Primary phone number associated with the lead. Defaults to the HOME phone type

phone_1_type
string

The type of the prospect's primary phone number. The value passed in here must be one of 'HOME', 'WORK', 'MOBILE', FAX'.

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

'Secondary phone number associated with the lead. Defaults to the MOBILE phone type

phone_2_type
string

The type of the prospect's secondary phone number. The value passed in here must be one of 'HOME', 'WORK', 'MOBILE', FAX'.

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

The first address line associated with the lead

address_2
string

Second line of the street address for the prospect.

city
string

The city associated with the lead

state
string

The state associated with the lead

zip
string

The zip code associated with the lead

country
string

The country associated with the lead

lead_source
string

The primary lead source. This is from a set list of values that you can get from the PMS for your specific integration.

property_id
string

The Propify unique identifier for the property

x_lead_source_id
string

The external ID of the lead source from the integration vendor

middle_name
string

The middle name associated with the lead

date_of_birth
string

The date of birth associated with the lead

notes
string

Notes associated with the lead

​
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.