Leads

Create Lead: MRI

Create a lead in MRI. This will create a prospect record in MRI with the applicant type.

Method
/mriapiservices/api.asp?$api=MRI_S-PMRM_GuestCardsBySiteID

<Note title="Notice">This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately.</Note>

post/v1/leads/mri/

Request

  • Base URL: https://api.propexo.com
  • URL: https://api.propexo.com/v1/leads/mri/
  • Auth: HTTP bearer

Request body

integration_idstring required

The Propexo unique identifier for the integration

property_idstring required

The Propexo unique identifier for the property

last_namestring required

The last name associated with the lead

address_type_idstring

The Propexo unique identifier for the address type

first_namestring

The first name associated with the lead

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

state'AA' | 'AE' | 'AK' | 'AL' | 'AP' | 'AR' | 'AS' | 'AZ' | 'CA' | 'CO' | 'CT' | 'DC' | 'DE' | 'FL' | 'FM' | 'GA' | 'GU' | 'HI' | 'IA' | 'ID' | 'IN' | 'KS' | 'KY' | 'LA' | 'MA' | 'MD' | 'ME' | 'MH' | 'MI' | 'MN' | 'MO' | 'MP' | 'MS' | 'MT' | 'NC' | 'NE' | 'NL' | 'NJ' | 'NM' | 'NV' | 'NY' | 'OH' | 'OK' | 'OR' | 'PA' | 'PR' | 'SD' | 'TN' | 'TX' | 'UT' | 'VA' | 'VI' | 'VT' | 'WA' | 'WI' | 'WV' | 'WY'

The state associated with the lead

zipstring

The zip code associated with the lead

desired_num_bedroomsnumber double

The desired number of bedrooms

desired_num_bathroomsstring

The desired number of bathrooms

desired_lease_term_in_monthsnumber double

The desired lease term in months of the lead

number_of_occupantsnumber double

The number of occupants for the lead

notesstring

Notes associated with the lead

phone_1string

Primary phone number associated with the lead

phone_1_type'FAX' | 'HOME' | 'MOBILE' | 'OTHER' | 'WORK'

Type of the primary phone number

phone_2string

Secondary phone number associated with the lead

phone_2_type'FAX' | 'HOME' | 'MOBILE' | 'OTHER' | 'WORK'

Type of the secondary phone number

applicant_status'APPLICANT' | 'CO_APPLICANT' | 'OCCUPANT'

The applicant status of the lead. This is optional and defaults to APPLICANT.

Response

Successful response

Changes

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