Update Applicant: Propertyware
Update Applicant: Propertyware
| Method |
|---|
| updateApplicant |
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
applicant_id
The ID of the resource.
Request
This endpoint expects an object.
integration_id
The Propexo unique identifier for the integration
x_property_id
The external ID of the property from the integration vendor
address_1
First line of the street address for the applicant. This maps to the addressLine1 property of the Applicant's primary address
address_2
Second line of the street address for the applicant. This maps to the addressLine2 property of the Applicant's primary address.
city
City of the applicant's primary address. This maps to the city property of the Applicant's primary address.
date_of_birth
Date of birth of the applicant. This maps to the birthDate property of the Applicant object.
email_1
The primary email address for the applicant. This value maps to the email property of the Applicant object
first_name
The first name of the applicant. This value maps to the firstName property of the Applicant object.
last_name
The last name of the applicant. This value maps to the lastName property of the Applicant object
originating_lead_source_id
The ID of the lead source. This maps to the originatingLeadSourceId property of the Application object.
phone_1
Applicant's primary phone number. This maps to the phoneNumber property of the Applicant object.
phone_1_type
The type of the applicant's primary phone number. The value passed in here must be one of 'HOME', 'WORK', 'MOBILE', FAX'. This maps to the phoneNumberTypeId property of the Applicant object.
Allowed values:
phone_2
Applicant's secondary phone number. This maps to the phoneNumber property of the Applicant object.
phone_2_type
The type of the applicant's secondary phone number. The value passed in here must be one of 'HOME', 'WORK', 'MOBILE', FAX'. This maps to the phoneNumberTypeId property of the Applicant object.
Allowed values:
state
State of the resident's primary address. This maps to the stateCode property of the Applicant's primary address.
x_unit_id
The external ID of the unit from the integration vendor
zip
Zip/Postal Code of the resident’s primary address. This maps to the postalCode property of the Applicant’s primary address.
custom_dataDeprecated
Deprecated: Field is no longer applicable
Response
Successful response
meta
result
