Create Applicant: Buildium

Create Applicant: Buildium | Interface | Method | |---|---| | Applicants | POST /applicants |

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
first_namestringRequired
The first name associated with the applicant
last_namestringRequired
The last name associated with the applicant
unit_idstringOptional
The Propexo unique identifier for the unit
send_rental_application_emailbooleanOptionalDefaults to false
Whether to send the new applicant an email with a link to the online application form
email_1stringOptionalformat: "email"
The primary email address 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:
custom_dataobjectOptionalDeprecated

Deprecated: Field is no longer applicable

Response

Successful response
metaobject
resultobject

Errors