Create Prospect: EliseAI

POST

/crm/v1/prospects/eliseai

POST

/crm/v1/prospects/eliseai

$ curl -X POST https://api.propexo.com/crm/v1/prospects/eliseai \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "integration_id": "intg_9f8b7c6d5e4a3b2c1d0e",
>   "community_id": "comm_1234567890abcdef",
>   "prospect_source": "Website Lead Form"
> }'

1 {
2   "meta": {
3     "job_id": "job_20240615_abcdef123456"
4   },
5   "result": {
6     "integration_id": "intg_9f8b7c6d5e4a3b2c1d0e",
7     "community_id": "comm_1234567890abcdef",
8     "prospect_source": "Website Lead Form",
9     "email_1": "jane.doe@example.com",
10     "phone_1": "+14155552671",
11     "first_name": "Jane",
12     "last_name": "Doe",
13     "move_in_date": "2024-07-01",
14     "rent_minimum_in_cents": 120000,
15     "rent_maximum_in_cents": 180000,
16     "notes": "Interested in a pet-friendly unit with parking included.",
17     "desired_num_bedrooms": [
18       2
19     ],
20     "lease_term_in_months": 12
21   }
22 }

Creates a prospect in EliseAI.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

integration_idstringRequired

The Propexo unique identifier for the integration

community_idstringRequired

The Propexo unique identifier for the community

prospect_sourcestringRequired

The name of the source of the lead

email_1stringOptional

The primary email address associated with the prospect. This field and/or the phone_1 field are required

phone_1stringOptionalformat: "^\+?\d{1,50}$"

Primary phone number associated with the prospect. Must be in E.164 format (e.g. +12025550179). This field and/or the email_1 field are required

first_namestringOptional

The first name associated with the prospect

last_namestringOptional

The last name associated with the prospect

move_in_datestringOptional

The move-in date associated with the prospect

rent_minimum_in_centsintegerOptional>=1

The minimum rent of the prospect

rent_maximum_in_centsintegerOptional>=1

The maximum rent of the prospect

notesstringOptional<=1000 characters

Notes associated with the prospect

desired_num_bedroomslist of integersOptional

The number of bedrooms associated with the prospect. Only the first value is sent to EliseAI. 0 represents a studio unit.

lease_term_in_monthsintegerOptional>=1

The amount of months for the lease term

Response

Successful response

metaobject

resultobject

Errors

400

Bad Request Error