Skip to content
Funnel Leasing

Book an appointment

POST
/api/partners/v1/community/{community_id}/appointments/

TODO

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
community_id
required
string

The Community ID, this will look like either ‘1234’ or ‘P1234-567’. Alternatively, if you prefix this value with partner-id:, for example partner-id:apts123 you can use your own community, as long as you have previously provided that ID to Funnel.

Examples

Funnel Community ID

The raw integer Funnel ID of a community.

1234

Request Body

Section titled “Request Body ”
object
prospect
required
object
price_floor
string
nullable
layout
Array<string>
nullable
Allowed values: Loft Studio 1br 2br 3br 4+br
people
required
Array<object>
>= 1 items
object
first_name
string
nullable
last_name
string
nullable
is_primary
boolean
nullable
phone_2
string
nullable
email
string
phone_1
string
nullable
sms_opted_in

If you explicitly collect SMS Opt-in consent in a TCPA compliant way, pass true to this field, otherwise leave it out of your submission.

boolean
price_ceiling
string
nullable
move_in_date
string format: date
nullable
appointment
required
object
start
required
string
message
string
Looking forward to my appointment
tour_type
string
default: guided
Allowed values: guided self-guided video
pms_unit_ids
Array<string>
[
  "123",
  "5678"
]

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Appointment successfully created.

400

Section titled “400 ”

401

Section titled “401 ”

403

Section titled “403 ”

We were unable to authenticate your request with the provided API key.

object
error_type
string
CommunityNotFound
message
string
Could not find community with corresponding ID.

404

Section titled “404 ”

A community with this ID does not exist.

object
error_type
string
CommunityNotFound
message
string
Could not find community with corresponding ID.