Create Applicant: Buildium

Interface	Method
Applicants	POST /applicants

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.

Create Applicant: Buildium | Interface | Method | |---|---| | Applicants | POST /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>

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

400

Bad Request Error

$	curl -X POST https://api.propexo.com/v1/applicants/buildium/ \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"integration_id": "buildium-12345",
>	"first_name": "Emily",
>	"last_name": "Johnson"
>	}'

1	{
2	"meta": {
3	"job_id": "job-98765"
4	},
5	"result": {
6	"integration_id": "buildium-12345",
7	"unit_id": "unit-54321",
8	"first_name": "Emily",
9	"last_name": "Johnson",
10	"email_1": "emily.johnson@example.com",
11	"phone_1": "+1-555-123-4567",
12	"phone_1_type": "MOBILE",
13	"phone_2": "+1-555-765-4321",
14	"phone_2_type": "HOME",
15	"custom_data": {},
16	"send_rental_application_email": true
17	}
18	}