Edit a Prospect

PUT

/api/partners/v1/community/{community_id}/prospects/{prospect_id}

TODO

Authorizations

• BasicAuth
• BearerAuth

Parameters

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

Funnel Community Syndication ID

The community’s Funnel syndcation ID. An ID in this format is often provided in Funnel feeds to ILS partners.

P1234-567

Partner ID

The ID of the community in the partner system. This needs to have been previously provided to Funnel and setup.

partner-id:apts123

prospect_id

required

string

The client’s funnel id (often referred to as client id or funnel renter id), this will look like ‘12345’.

Example

12345

Query Parameters

exclude_moved_out

boolean

Exclude persons of the household if they have moved out in the people attribute of the response.

exclude_minors

boolean

Exclude persons of the household if they’re a minor in the people attribute of the response.

Request Body

object

people

required

Array<object>

>= 1 items

object

first_name

string

nullable

last_name

string

nullable

is_primary

boolean

nullable

phone_1

string

nullable

phone_2

string

nullable

email

string

move_in_date

YYYY-MM-DD (ISO 8601 date format)

• Prospect’s desired move-in date

string

nullable

2022-06-25

price_floor

The prospect’s price floor

string

nullable

price_ceiling

The prospect’s price ceiling

string

nullable

discovery_source

Funnel Discovery Source ID.

• Valid values can be retrieved from the /discovery_sources endpoint for a given customer.
• Most vendors typically only send a value for lead_source, not discovery_source.

string

nullable

123

lead_source

Funnel Discovery Source ID.

• Valid values can be retrieved from the /discovery_sources endpoint for a given customer.
• Most vendors typically only send a value for lead_source, not discovery_source.

string

nullable

123

medium

string

nullable

Allowed values: Direct/Manual Appointment Scheduler Lead Capture Widget API Phone Text Guest Card Funnel Website PMS Import ILS Integrations Email Facebook Messenger Chatbot Call Center

agents

• Any agents that are associated with the prospect

Array<string>

nullable

parking

PARKING_ANY = 10 PARKING_OFF_STREET = 20 PARKING_GARAGE = 30 PARKING_ATTACHED_GARAGE = 35 PARKING_DETACHED_GARAGE = 40 PARKING_COVERED = 45 PARKING_STREET = 50

• Prospect’s desired parking options

integer format: int32

nullable

Allowed values: 10 20 30 35 40 45 50

doorman

DOORMAN_NONE = -10 DOORMAN_ANY = 10 DOORMAN_FULL_TIME = 20

• Prospect’s desired doorman options

integer format: int32

nullable

Allowed values: -10 10 20

group

Funnel Employee group ID

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

elevator

• Prospect’s desired elevator options

boolean

nullable

pets

PETS_NO_PETS = 10 PETS_ALLOWED = 20 PETS_CATS_ONLY = 30

• Prospect’s desired pet options

Array<integer>

nullable

Allowed values: 10 20 30

laundry

LAUNDRY_IN_UNIT = 10 LAUNDRY_IN_BUILDING = 20 [UNUSED / UNKNOWN — do not use] = 30

• Prospect’s desired laundry options
• Value 30 is not currently supported or clearly defined; do not use it in production.

Array<integer>

nullable

Allowed values: 10 20

outdoor_space

OUTDOOR_SPACE_PRIVATE = 10 OUTDOOR_SPACE_PUBLIC = 20 [UNUSED / UNKNOWN — do not use] = 30

• Prospect’s desired outdoor space options
• Value 30 is not currently supported or clearly defined; do not use it in production.

Array<integer>

nullable

Allowed values: 10 20

layout

• Prospect’s desired layout options.

Array<string>

nullable

Allowed values: Loft Studio 1br 2br 3br 4+br

notes

This field should be used for any message submitted by the prospect. This will appear as a message in the receiving system.

string

nullable

neighborhoods

Array<string>

nullable

third_party_vla_handling

boolean

nullable

broker_company

string

nullable

broker_first_name

string

nullable

broker_last_name

string

nullable

broker_phone

string

nullable

current_postal_code

string

nullable

client_referral

string

nullable

marketing_email_opt_in

boolean

nullable

source_type

string

nullable

broker_email

string

nullable

device

string

nullable

campaign_id

string

nullable

campaign_info

string

nullable

website_session_id

string

nullable

website_app_id

string

nullable

website_user_id

string

nullable

Responses

200

Client successfully created/updated.

400

401

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

A community or prospect with this ID does not exist.

object

error_type

string

ProspectNotFound

message

string

Could not find prospect with prospect ID.