RentCafeProspects

Create Prospect: Rentcafe

Create Prospect: Rentcafe

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
first_namestringRequired
The first name associated with the prospect
last_namestringRequired
The last name associated with the prospect
email_1stringRequired
The primary email address associated with the prospect
agent_idstringOptional
The Propexo unique identifier for the agent
middle_namestringOptional
The middle name associated with the prospect
phone_1stringOptional
Primary phone number associated with the prospect
notesstringOptional
Notes associated with the prospect
address_1stringOptional<=40 characters
The first address line associated with the prospect
address_2stringOptional<=40 characters
The second 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
countrystringOptional<=2 characters
The country associated with the prospect
move_in_datestringOptional

The move-in date associated with the prospect

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.
preferred_contact_methodenumOptional
The way the prospect prefers to be contacted
Allowed values:
subscribebooleanOptional
Whether or not to subscribe the prospect to automated Rentcafe email messaging.
prospect_sourcestringOptional
The name of the source of the lead

Response

Successful response
metaobject
resultobject

Errors