---
title: "Create Prospect Endpoint"
method: POST
path: "/v1/prospect"
tags: ["Prospect"]
---

# Create Prospect Endpoint

`POST /v1/prospect`

Note: Additional event types or fields may be added

## Request body

- CreateProspectRequest
  - `first_name` string
  - `last_name` string
  - `email` string — Valid email address
  - `phone` string — Phone number in E.164 format (e.g. +12025550179)
  - `move_in_date` string, date
  - `bedrooms` integer — Number of bedrooms prospect is interested in
  - `bathrooms` integer — Number of bathrooms prospect is interested in
  - `minimum_budget` integer — Minimum monthly rent budget in USD
  - `maximum_budget` integer — Maximum monthly rent budget in USD
  - `min_lease_length` integer — Minimum desired lease term in months
  - `max_lease_length` integer — Maximum desired lease term in months
  - `vendor_prospect_id` string — External vendor prospect IDIf provided, subsequent webhook events will include this ID.Vendor source is attributed to ID from API credentials
  - `vendor_source` string — Vendor prospect id source.Field can only be set by internal EliseApi user, otherwise it is inferred through API credentials
  - `unit_preference` string[] — List of preferred unit numbers.
  - `floorplan_preference` string[] — List of preferred floorplan names.
  - `tracking_url` string — Tracking URL for marketing attribution
  - `new_inquiry_source_data` InquirySourceData[] — List of inquiry sources with session and tracking information
    - `name` string, required — Name of the inquiry source
    - `session_time` string, date-time, required — Timestamp of the session
    - `tracking_url` string — Tracking URL for marketing attribution
  - `elise_prospect_id` string — Unique identifier for the prospect in Elise's system.
  - `property_id` string — Unique identifier for the property in Elise's system. Required for vendors
  - `source` string — 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_id` string — 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_id` string — External property ID from property management system. Only allowed when request is sent from a PMS or third-party property management company.
  - `status` string — [DEPRECATED] Current status of the prospect in the application/leasing process. This should be updated by passing Status events.
  - `events` Event[] — List of events (appointments, notes, communications etc.) associated with this prospect creation
    - union — Note: Additional event types or fields may be added
      - AppointmentEvent
        - `event_id` string, required
        - `type` 'Appointment'
        - `event_date` string, date-time, required
        - `tour_type` 'sgt' | 'guided' | 'virtual', required — An enumeration.
        - `appointment_time` string, date-time, required
        - `appointment_id` string, required
        - `is_full_day` boolean
        - `virtual_tour_link` string
      - ShowEvent
        - `event_id` string, required
        - `type` 'Show'
        - `event_date` string, date-time, required
        - `appointment_id` string
        - `access_code` string
      - NoShowEvent
        - `event_id` string, required
        - `type` 'NoShow'
        - `event_date` string, date-time, required
        - `appointment_id` string, required
      - AppointmentCanceledEvent
        - `event_id` string, required
        - `type` 'AppointmentCanceled'
        - `event_date` string, date-time, required
        - `appointment_id` string, required
      - LeadNoteEvent
        - `event_id` string, required
        - `type` 'LeadNote'
        - `event_date` string, date-time, required
        - `note` string, required
      - EmailEvent
        - `event_id` string, required
        - `type` 'Email'
        - `event_date` string, date-time, required
        - `sender` 'lead' | 'elise' | 'agent' | 'vendor', required — An enumeration.
        - `subject` string, required
        - `message` string, required
        - `to_addresses` string[]
        - `cc_addresses` string[]
        - `from_address` string
      - TextEvent
        - `event_id` string, required
        - `type` 'Text'
        - `event_date` string, date-time, required
        - `sender` 'lead' | 'elise' | 'agent' | 'vendor', required — An enumeration.
        - `message` string, required
        - `to_phone_number` string
        - `from_phone_number` string
      - VoiceEvent
        - `event_id` string, required
        - `type` 'Voice'
        - `event_date` string, date-time, required
        - `sender` string, required
        - `summary` string, required
      - StatusUpdatedEvent
        - `event_id` string, required
        - `type` 'StatusUpdated'
        - `event_date` string, date-time, required
        - `status` 'ApplicationStarted' | 'ApplicationCompleted' | 'ApplicationApproved' | 'ApplicationRejected' | 'ApplicationCanceled' | 'LeaseStarted' | 'LeaseApproved' | 'LeasePartiallyCompleted' | 'LeaseCompleted', required — An enumeration.
      - AgentTakeoverEvent
        - `event_id` string, required
        - `type` 'AgentTakeover'
        - `event_date` string, date-time, required
        - `reason` string
      - EliseReactivatedEvent
        - `event_id` string, required
        - `type` 'EliseReactivated'
        - `event_date` string, date-time, required
      - OptOutEvent
        - `event_id` string, required
        - `type` 'OptOut'
        - `event_date` string, date-time, required
        - `mediums` ConversationMedium[], required
      - OptInEvent
        - `event_id` string, required
        - `type` 'OptIn'
        - `event_date` string, date-time, required
        - `mediums` ConversationMedium[], required
      - WebchatEvent
        - `event_id` string, required
        - `type` 'Webchat'
        - `event_date` string, date-time, required
        - `sender` string, required
        - `message` string, required
      - SurveyLinkEvent
        - `event_id` string, required
        - `type` 'SurveyLink'
        - `event_date` string, date-time, required
        - `survey_link` string, required
        - `survey_link_type` 'PostTourSurvey', required — An enumeration.
      - IdVerificationStatusEvent
        - `event_id` string, required
        - `type` 'IdVerificationStatus'
        - `event_date` string, date-time, required
        - `status` 'NOT_STARTED' | 'STARTED' | 'FAILED' | 'SUCCESSFUL' | 'ERROR' | 'EXPIRED' | 'CANCELLED' | 'PENDING_REVIEW', required — status of an id verification attempt. Currently, mirroring Plaid's status
        - `provider` string, required — The ID verification provider that performed the verification
        - `expiration_date` string, date-time — When the verification expires (if applicable)
        - `verification_id` string — External verification ID from the provider
        - `metadata` object — Provider-specific metadata and additional verification details
  - `agent_notes` string — Notes about this prospect to include within EliseAI's Conversation View

## Response `200`

Successful Response

- CreateProspectResponse
  - `elise_prospect_id` string, required

## Other responses

- `401` — Not Authorized for this endpoint
- `404` — Not found
- `422` — Validation Error

---

[API](https://skmtc.net/eliseai/apis/elise-api.md) · [All operations](https://skmtc.net/eliseai/apis/elise-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eliseai/elise-api/revisions/a75af086c674/schema)