MRIApplicants

Create Applicant: MRI

Create an applicant in MRI. This will create a prospect record in MRI with the applicant type. | Method | |---| | /mriapiservices/api.asp?$api=MRI_S-PMRM_GuestCardsBySiteID |

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
last_namestringRequired
The last name associated with the applicant
address_type_idstringOptional
The Propexo unique identifier for the address type
first_namestringOptional
The first name associated with the applicant
email_1stringOptional
The primary email address associated with the applicant
address_1stringOptional
The first address line associated with the applicant
address_2stringOptional
The second address line associated with the applicant
citystringOptional
The city associated with the applicant
stateenumOptional
The state associated with the applicant
zipstringOptional
The zip code associated with the applicant
target_move_in_datestringOptional
The target move in date associated with the applicant
desired_num_bedroomsdoubleOptional
The desired number of bedrooms
desired_num_bathroomsstringOptional
The desired number of bathrooms
desired_lease_term_in_monthsdoubleOptional
The desired lease term in months of the applicant
number_of_occupantsdoubleOptional
The number of occupants for the applicant
notesstringOptional<=30 characters
Notes associated with the applicant
phone_1stringOptional
Primary phone number associated with the applicant
phone_1_typeenumOptional
Type of the primary phone number
Allowed values:
phone_2stringOptional
Secondary phone number associated with the applicant
phone_2_typeenumOptional
Type of the secondary phone number
Allowed values:
applicant_statusenumOptional
The status of the applicant. This is optional and defaults to ACTIVE.
Allowed values:

Response

Successful response
metaobject
resultobject

Errors