Create Applicant File (File Upload): Yardi REST

Beta

POST

/v1/applicants/yardi_rest/:applicant_id/file-upload

POST

/v1/applicants/yardi_rest/:applicant_id/file-upload

curl -X POST https://api.propexo.com/v1/applicants/yardi_rest/applicant_id/file-upload \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "intg-9f8b7c6d5e4a3b2c",
  "attachment": {
    "file_type_id": "ft-123abc456def7890",
    "file_data": "JVBERi0xLjQKJcfs...",
    "file_extension": "pdf",
    "description": "Signed rental application form"
  }
}'

{
  "meta": {
    "job_id": "job-20240615-001234"
  },
  "result": {
    "integration_id": "intg-9f8b7c6d5e4a3b2c",
    "applicant_id": "app-5a4b3c2d1e0f9876",
    "attachment": {
      "file_type_id": "ft-123abc456def7890",
      "file_extension": "pdf",
      "description": "Signed rental application form",
      "file_data": "JVBERi0xLjQKJcfs...",
      "should_upload_to_tenant": true
    }
  }
}

Attach a file to an Applicant.

Interface	Method
ILS Guest Card	/ItfProspect/ImportGuestDocument

Notice

Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync.

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.

integration_idstringRequired

The Propexo unique identifier for the integration

attachmentobjectRequired

The file to attach to the Applicant

Response

Successful response

metaobject

resultobject

Errors

400

Bad Request Error