CRM Generic APIsProspects

Create Prospect

Create a prospect for an integration.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
integration_idstringRequired
community_idstringOptional
The Propexo unique identifier for the community
email_1stringOptional
The primary email address associated with the prospect
phone_1stringOptional
Primary phone number associated with the prospect
phone_2stringOptional
Secondary phone number associated with the prospect
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
Notes associated with the prospect
petslist of enumsOptional
A list of pets related to the prospect
Allowed values:
attribution_idstringOptional
The Propexo unique identifier for the attribution
agent_idstringOptional
The Propexo unique identifier for the agent
address_1stringOptional<=40 characters
The first address line associated with the prospect
citystringOptional<=30 characters
The city associated with the prospect
statestringOptional<=4 characters
The state associated with the prospect
zipstringOptional<=12 characters
The zip code 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
desired_num_bedroomslist of integersOptional
The number of bedrooms associated with the prospect. RentCafe only takes a single value for the desired bedrooms. All values other than the first are ignored. This is for compatibility with the other CRM endpoints.
subscribebooleanOptional
Whether or not to subscribe the prospect to automated Rentcafe email messaging.
first_contact_typeenumOptional
The type of initial contact with the prospect
middle_namestringOptional
The middle name associated with the prospect
address_2stringOptional<=40 characters
The second address line associated with the prospect
countrystringOptional<=2 characters
The country associated with the prospect
preferred_contact_methodenumOptional
The way the prospect prefers to be contacted
Allowed values:
prospect_sourcestringOptional
The name of the source of the lead

Response

Successful response
job_idstring
The ID of the job created to handle this operation
dataobject

Errors