Applicants

Create Applicant: Buildium

Create Applicant: Buildium

InterfaceMethod
ApplicantsPOST /applicants

<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/applicants/buildium/

Request

  • Base URL: https://api.propexo.com
  • URL: https://api.propexo.com/v1/applicants/buildium/
  • Auth: HTTP bearer

Request body

integration_idstring required

The Propexo unique identifier for the integration

unit_idstring

The Propexo unique identifier for the unit

first_namestring required

The first name associated with the applicant

last_namestring required

The last name associated with the applicant

send_rental_application_emailboolean

Whether to send the new applicant an email with a link to the online application form

email_1string email

The primary email address associated with the applicant

phone_1string

Primary phone number associated with the applicant

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

Type of the primary phone number

phone_2string

Secondary phone number associated with the applicant

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

Type of the secondary phone number

custom_dataV1ApplicantsBuildiumPostInputCustomData

Deprecated: Field is no longer applicable

Response

Successful response

Changes

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