KnockProspects

Create Prospect: Knock

Create Prospect: Knock

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
attribution_idstringRequired
The Propexo unique identifier for the attribution
agent_idstringOptional
The Propexo unique identifier for the agent
email_1stringOptional

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

phone_1stringOptional

Primary phone number associated with the prospect. 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
address_1stringOptional
The first address line associated with the prospect
citystringOptional
The city associated with the prospect
statestringOptional
The state associated with the prospect
zipstringOptional
The zip code associated with the prospect
move_in_datestringOptional

The move-in date associated with the prospect

number_of_occupantsintegerOptional
The number of occupants living in the unit
lease_term_in_monthsintegerOptional1-18
The amount of months for the lease term
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. 0 represents a studio unit. 3 represents three or more bedrooms.
petslist of enumsOptional
A list of pets related to the prospect
Allowed values:
subscribebooleanOptionalDefaults to true
Whether or not to subscribe the prospect to automated Knock messaging. Verify with your customer that they have legal consent to send email messages to this customer
first_contact_typeenumOptional
The type of initial contact with the prospect

Response

Successful response
metaobject
resultobject

Errors