For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
How It WorksKnowledge BaseOnboardingVideo TutorialsPMS GuidanceAPI ReferenceRelease Notes
    • Overview
    • PMS Generic APIs
    • CRM Generic APIs
    • PMS APIs
        • GETGet all applicants
        • GETGet an applicant by ID
        • POSTCreate Applicant: MRI
        • PUTUpdate Applicant: MRI
    • CRM APIs
    • Download OpenAPI Spec
Dashboard
LogoLogo
MRIApplicants

Update Applicant: MRI

PUT
/v1/applicants/mri/:applicant_id
PUT
/v1/applicants/mri/:applicant_id
$curl -X PUT https://api.propexo.com/v1/applicants/mri/applicant_id \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json" \
> -d '{}'
1{
2 "meta": {
3 "job_id": "job-7890abc123"
4 },
5 "result": {
6 "applicant_id": "applicant-456def789",
7 "address_type_id": "addrtype-123xyz456",
8 "first_name": "Emily",
9 "last_name": "Johnson",
10 "email_1": "emily.johnson@example.com",
11 "address_1": "123 Maple Street",
12 "address_2": "Apt 4B",
13 "city": "Springfield",
14 "state": "CA",
15 "zip": "90210",
16 "target_move_in_date": "2024-01-15T09:30:00Z",
17 "desired_num_bedrooms": 2,
18 "desired_num_bathrooms": "1.5",
19 "desired_lease_term_in_months": 12,
20 "number_of_occupants": 3,
21 "notes": "Prefers quiet neighborhood",
22 "phone_1": "555-123-4567",
23 "phone_1_type": "MOBILE",
24 "phone_2": "555-987-6543",
25 "phone_2_type": "WORK",
26 "applicant_status": "APPLICANT"
27 }
28}
Update Applicant: MRI | Method | |---| | /mriapiservices/api.asp?$api=MRI_S-PMRM_GuestCardsBySiteID |
Was this page helpful?
Previous

Get all appointments

Next
Built with

Update Applicant: MRI

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

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

applicant_idstringRequired
The Propexo unique identifier for the applicant

Request

This endpoint expects an object.
address_type_idstringOptional
The Propexo unique identifier for the address type. This is required when updating the address
first_namestringOptional
The first name associated with the applicant
last_namestringOptional
The last 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 for 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

400
Bad Request Error