Create Lead: RealPage Partner Exchange

POSThttps://api.propexo.com/v1/leads/realpage_rpx/

Method	Interface
InsertProspect	Prospect Management

Notice

Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync.

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

property_idstringrequired

The Propexo unique identifier for the property

lead_relationship_idstringrequired

The Propexo unique identifier for the lead relationship

first_namestringrequired

The first name associated with the lead

Possible values: <= 30 characters

last_namestringrequired

The last name associated with the lead

Possible values: <= 30 characters

middle_namestring

The middle name associated with the lead

date_of_birthstring<date-time>

The date of birth associated with the lead

employee_idstring

The Propexo unique identifier for the employee

lead_source_idstring

The Propexo unique identifier for the lead source

phone_1string

Primary phone number associated with the lead

phone_1_typestring
Type of the primary phone number
Show 5 enum values
FAXHOMEMOBILEOTHERWORK
phone_2string

Secondary phone number associated with the lead

phone_2_typestring
Type of the secondary phone number
Show 5 enum values
FAXHOMEMOBILEOTHERWORK
email_1string

The primary email address associated with the lead

address_1string

The first address line associated with the lead

address_2string

The second address line associated with the lead

citystring

The city associated with the lead

statestring

The state associated with the lead

zipstring

The zip code associated with the lead

countrystring

The country associated with the lead

target_move_in_datestring<date-time>

The move-in date associated with the lead

desired_lease_term_in_monthsnumber

The amount of months for the lease term

desired_max_rent_in_centsinteger

The maximum rent cost the lead is looking to pay, in cents

number_of_occupantsinteger

The number of occupants living in the unit

unit_idstring

The Propexo unique identifier for the unit

Response

Successful response

meta objectrequired
job_idstringrequired
result objectrequired

integration_idstringrequired

The Propexo unique identifier for the integration

property_idstringrequired

The Propexo unique identifier for the property

lead_relationship_idstringrequired

The Propexo unique identifier for the lead relationship

first_namestringrequired

The first name associated with the lead

Possible values: <= 30 characters

last_namestringrequired

The last name associated with the lead

Possible values: <= 30 characters

middle_namestring | nullnullablerequired

The middle name associated with the lead

date_of_birth(string | null)<date-time>nullablerequired

The date of birth associated with the lead

employee_idstring | nullnullablerequired

The Propexo unique identifier for the employee

lead_source_idstring | nullnullablerequired

The Propexo unique identifier for the lead source

phone_1string | nullnullablerequired

Primary phone number associated with the lead

phone_1_typestring | nullnullablerequired

Type of the primary phone number

Show 5 enum values

FAXHOMEMOBILEOTHERWORK

phone_2string | nullnullablerequired

Secondary phone number associated with the lead

phone_2_typestring | nullnullablerequired

Type of the secondary phone number

Show 5 enum values

FAXHOMEMOBILEOTHERWORK

email_1string | nullnullablerequired

The primary email address associated with the lead

address_1string | nullnullablerequired

The first address line associated with the lead

address_2string | nullnullablerequired

The second address line associated with the lead

citystring | nullnullablerequired

The city associated with the lead

statestring | nullnullablerequired

The state associated with the lead

zipstring | nullnullablerequired

The zip code associated with the lead

countrystring | nullnullablerequired

The country associated with the lead

target_move_in_date(string | null)<date-time>nullablerequired

The move-in date associated with the lead

desired_lease_term_in_monthsnumber | nullnullablerequired

The amount of months for the lease term

desired_max_rent_in_centsinteger | nullnullablerequired

The maximum rent cost the lead is looking to pay, in cents

number_of_occupantsinteger | nullnullablerequired

The number of occupants living in the unit

unit_idstring | nullnullablerequired

The Propexo unique identifier for the unit

Errors

• 400Bad Request

  error objectrequired
  codestringrequired
  Example: invalid_request
  messagestringrequired
  Example: invalid request
  details object
  property name*any
  Example: {"details":{"issues":[{"code":"unrecognized_keys","keys":["foo"],"path":[],"message":"Unrecognized key(s) in object: 'foo'"}],"name":"ZodError"}}

POST /v1/leads/realpage_rpx/

curl -X POST https://api.propexo.com/v1/leads/realpage_rpx/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "string",
  "property_id": "string",
  "lead_relationship_id": "string",
  "first_name": "string",
  "last_name": "string"
}'

200 Successful response

{
  "meta": {
    "job_id": "string"
  },
  "result": {
    "integration_id": "string",
    "property_id": "string",
    "lead_relationship_id": "string",
    "first_name": "string",
    "last_name": "string",
    "middle_name": "string",
    "date_of_birth": "2024-07-29T15:51:28.071Z",
    "employee_id": "string",
    "lead_source_id": "string",
    "phone_1": "string",
    "phone_1_type": "FAX",
    "phone_2": "string",
    "phone_2_type": "FAX",
    "email_1": "string",
    "address_1": "string",
    "address_2": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "string",
    "target_move_in_date": "2024-07-29T15:51:28.071Z",
    "desired_lease_term_in_months": 0,
    "desired_max_rent_in_cents": 0,
    "number_of_occupants": 0,
    "unit_id": "string"
  }
}