Prospects

Create Prospect

Create a prospect for an integration.

post/crm/v1/prospects/

Request

  • Base URL: https://api.propexo.com
  • URL: https://api.propexo.com/crm/v1/prospects/
  • Auth: HTTP bearer

Request body

integration_idstring required
community_idstring

The Propexo unique identifier for the community

prospect_sourcestring

The name of the source of the lead

email_1string

The primary email address associated with the prospect

phone_1string

Primary phone number associated with the prospect

first_namestring

The first name associated with the prospect

last_namestring

The last name associated with the prospect

rent_minimum_in_centsinteger

The minimum rent of the prospect

rent_maximum_in_centsinteger

The maximum rent of the prospect

notesstring

Notes associated with the prospect

desired_num_bedroomsinteger[]

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.

lease_term_in_monthsinteger

The amount of months for the lease term

phone_2string

Secondary phone number associated with the prospect

petsCrmV1ProspectsPostInputPetsItems[]

A list of pets related to the prospect

attribution_idstring

The Propexo unique identifier for the attribution

agent_idstring

The Propexo unique identifier for the agent

address_1string

The first address line associated with the prospect

citystring

The city associated with the prospect

statestring

The state associated with the prospect

zipstring

The zip code associated with the prospect

number_of_occupantsinteger

The number of occupants living in the unit

subscribeboolean

Whether or not to subscribe the prospect to automated Rentcafe email messaging.

first_contact_type'CALL' | 'CHAT' | 'EMAIL' | 'FACEBOOK' | 'FORM' | 'INTERNET' | 'KNOCK_SCHEDULE' | 'SMS' | 'WALK_IN'

The type of initial contact with the prospect

middle_namestring

The middle name associated with the prospect

address_2string

The second address line associated with the prospect

countrystring

The country associated with the prospect

preferred_contact_method'NONE' | 'CALL' | 'TEXT' | 'EMAIL'

The way the prospect prefers to be contacted

Response

Successful response

job_idstring required

The ID of the job created to handle this operation

dataCrmV1ProspectsPostOutputData required

Changes

No recorded changes to this operation across all 1 revision of this API.