Events

Create event for an applicant

Create an applicant event for an integration.

post/v1/events/applicants

Request

  • Base URL: https://api.propexo.com
  • URL: https://api.propexo.com/v1/events/applicants
  • Auth: HTTP bearer

Request body

integration_idstring required
applicant_idstring

The Propexo unique identifier for the applicant

event_type'Note'

The type of event

notesstring

Notes associated with the event

application_idstring

The Propexo unique identifier for the application

event_type_idstring

The Propexo unique identifier for the event type

event_result_idstring

The Propexo unique identifier for the event result

event_sub_type_idstring

The Propexo unique identifier for the event sub type

employee_idstring

The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT

unit_idstring

The Propexo unique identifier for the unit. Only some PMS events use this, including "Show" and "Appointment"

event_datetimestring date-time

The date when the event will occur

reasons_for_eventstring

The reasons for the event

appointment_datetimestring date-time

The date when the appointment will occur

time_fromstring
time_tostring
titlestring

The title associated with the event

call_phone_number_fromstring

The phone number that the call was made from. Required for call event types.

call_phone_number_tostring

The phone number that the call was received on. Required for call event types.

call_status'BUSY' | 'ABANDONED' | 'DISCONNECTED' | 'FAILURE_TO_CONNECT' | 'NO_ANSWER' | 'ANSWER' | 'VOICEMAIL'

The status of the call. Required for call event types.

call_durationinteger

The duration of the call in seconds. Required for call event types.

call_audio_linkstring uri

The URL of the audio file for the call. This can be any valid URL and doesn't necessarily need to link to a audio file. Required for call event types.

email_bodystring

The body of the email.

email_subjectstring

The subject of the email.

email_fromstring

The email address that the email was sent from. Required for email outgoing event types.

email_tostring

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_ccstring

The carbon copy email address that the email was sent to.

email_bccstring

The blind carbon copy email address that the email was sent to.

email_sendboolean

Whether the email should be sent.

status'COMPLETED' | 'OPEN' | 'REVIEW' | 'DENIED'

The raw status associated with the event

event_name'CallToProspect' | 'CallFromProspect' | 'Other' | 'WalkIn' | 'Chat' | 'Email' | 'Webservice' | 'Appointment' | 'Show' | 'Application' | 'SelfGuidedTour' | 'Application' | 'Approve' | 'CancelApplication' | 'ApplicationDenied' | 'Hold' | 'CancelAppointment' | 'LeaseSign' | 'Release' | 'ReturnVisit'

The name or type of event

agent_namestring

The name of the leasing agent associated with the event

rent_amount_in_centsnumber double

The rent amount in cents for the event. Required for LeaseSign event

Response

Successful response

job_idstring required

The ID of the job created to handle this operation

dataV1EventsApplicantsPostOutputData required

Changes

No recorded changes to this operation across all 1 revision of this API.