v6

OpenAPI 3.1.02026-08-0331136162.2 KB

Prospect

Create Prospect Endpoint

Note: Additional event types or fields may be added

post/v1/prospect

Request body

first_namestring

last_namestring

emailstring

Valid email address

phonestring

Phone number in E.164 format (e.g. +12025550179)

move_in_datestring date

bedroomsinteger

Number of bedrooms prospect is interested in

bathroomsinteger

Number of bathrooms prospect is interested in

minimum_budgetinteger

Minimum monthly rent budget in USD

maximum_budgetinteger

Maximum monthly rent budget in USD

min_lease_lengthinteger

Minimum desired lease term in months

max_lease_lengthinteger

Maximum desired lease term in months

vendor_prospect_idstring

External vendor prospect IDIf provided, subsequent webhook events will include this ID.Vendor source is attributed to ID from API credentials

vendor_sourcestring

Vendor prospect id source.Field can only be set by internal EliseApi user, otherwise it is inferred through API credentials

unit_preferencestring[]

List of preferred unit numbers.

floorplan_preferencestring[]

List of preferred floorplan names.

tracking_urlstring

Tracking URL for marketing attribution

elise_prospect_idstring

Unique identifier for the prospect in Elise's system.

property_idstring

Unique identifier for the property in Elise's system. Required for vendors

sourcestring

The source or channel through which the prospect was acquired. Required for all, but pass-through for PMS and third-party property management companies.

external_prospect_idstring

External prospect ID from property management system. Only allowed when request is sent from a PMS or third-party property management company. If provided, subsequent webhook events will include this ID.

external_property_idstring

External property ID from property management system. Only allowed when request is sent from a PMS or third-party property management company.

statusstring

[DEPRECATED] Current status of the prospect in the application/leasing process. This should be updated by passing Status events.

agent_notesstring

Notes about this prospect to include within EliseAI's Conversation View

Example request

{
  "email": "john.doe@example.com",
  "phone": "+12025550179",
  "bedrooms": 2,
  "bathrooms": 2,
  "minimum_budget": 1500,
  "maximum_budget": 2500,
  "min_lease_length": 12,
  "max_lease_length": 18,
  "vendor_prospect_id": "etS123456",
  "unit_preference": [
    "101",
    "202",
    "305"
  ],
  "floorplan_preference": [
    "A1",
    "B2",
    "Studio"
  ],
  "new_inquiry_source_data": [
    {
      "name": "Google Ads",
      "session_time": "2026-02-22T21:25:37.797Z"
    }
  ],
  "elise_prospect_id": "c21b94e2-0280-415d-9d1e-091b547a0061",
  "property_id": "c21b94e2-0280-415d-9d1e-091b547a0061",
  "source": "Zillow",
  "external_prospect_id": "PMS123456",
  "external_property_id": "property123",
  "status": "ApplicationStarted",
  "events": [
    {
      "provider": "checkpoint",
      "expiration_date": "2025-12-31T23:59:59Z",
      "verification_id": "chk_12345abcde"
    }
  ]
}

Response

Successful Response

elise_prospect_idstring required