API ReferenceEvents

Create event for a lead

Create a lead event for an integration.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
integration_idstringRequired
lead_idstringOptional
The Propexo unique identifier for the lead
event_type_idstringOptional
The Propexo unique identifier for the event type
event_result_idstringOptional
The Propexo unique identifier for the event result
event_sub_type_idstringOptional
The Propexo unique identifier for the event sub type
employee_idstringOptional
The Propexo unique identifier for the employee
unit_idstringOptional
The Propexo unique identifier for the unit. Only some PMS events use this, including "Show" and "Appointment"
event_datetimedatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z
The date when the event will occur
reasons_for_eventstringOptional
The reasons for the event
notesstringOptional
Notes associated with the event
appointment_datetimedatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z
The date when the appointment will occur
time_fromstringOptional
time_tostringOptional
titlestringOptional
The title associated with the event
call_phone_number_fromstringOptional
The phone number that the call was made from. Required for call event types.
call_phone_number_tostringOptional
The phone number that the call was received on. Required for call event types.
call_statusenumOptional
The status of the call. Required for call event types.
call_durationintegerOptional>=0<=86400
The duration of the call in seconds. Required for call event types.
email_bodystringOptional
The body of the email.
email_subjectstringOptional
The subject of the email.
email_fromstringOptional
The email address that the email was sent from. Required for email outgoing event types.
email_tostringOptional
The email address that the email was sent to. If specified, this must be the same email address as the lead's primary email address
email_ccstringOptional
The carbon copy email address that the email was sent to.
email_bccstringOptional
The blind carbon copy email address that the email was sent to.
email_sendbooleanOptionalDefaults to false
Whether the email should be sent.
statusenumOptional
The status associated with the event
Allowed values:
event_nameenumOptional
The name or type of event
lead_source_idstringOptional
The Propexo unique identifier for the lead source
agent_namestringOptional
The name of the leasing agent associated with the event

Response

Successful response
job_idstring
The ID of the job created to handle this operation
dataobject

Errors