Book an appointment (with prospect)

Creates a tour appointment in Funnel for the community using the submitted prospect and scheduling payload (start time, tour type, optional units, and related fields). When the renter is not specified in the URL, the service attempts to match an existing prospect in the company by contact information, or creates a new guest card if no match is found. The response returns the prospect and appointment identifiers.

POST

/api/partners/v1/community/:community_id/appointments/

Request

Example requestPOSTapplication/json

$ curl -X POST \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer YOUR_API_KEY" \
    -d '{ "prospect": { "price_floor": "string", "layout": [ "loft" ], "people": [ { "first_name": "string", "last_name": "string", "is_primary": false, "phone_2": "string", "email": "string", "phone_1": "string" } ], "sms_opted_in": false, "price_ceiling": "string", "move_in_date": "2023-01-01" }, "appointment": { "start": "string", "message": "Looking forward to my appointment", "tour_type": "string", "pms_unit_ids": [ "123", "5678" ] } }' \
    "https://api.funnelleasing.com/api/partners/v1/community/1234/appointments/"

Response

Example responseJSON200 · application/json

{}