Create Resident File (File Upload): Yardi REST

Beta

POST

/v1/residents/yardi_rest/:resident_id/file-upload/

POST

/v1/residents/yardi_rest/:resident_id/file-upload/

curl -X POST https://api.propexo.com/v1/residents/yardi_rest/resident_id/file-upload/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "intg-7890abcd1234",
  "attachment": {
    "file_type_id": "ftype-4567efgh8901",
    "file_data": "JVBERi0xLjQKJcfs...",
    "file_extension": "pdf",
    "description": "Signed lease agreement for apartment 12B"
  }
}'

{
  "meta": {
    "job_id": "job-20240615-xyz123"
  },
  "result": {
    "integration_id": "intg-7890abcd1234",
    "resident_id": "res-1234abcd5678",
    "attachment": {
      "file_type_id": "ftype-4567efgh8901",
      "file_extension": "pdf",
      "description": "Signed lease agreement for apartment 12B",
      "file_data": "JVBERi0xLjQKJcfs..."
    }
  }
}

Create Resident File (File Upload): Yardi REST

Interface	Method
Common Data	/ItfResidentData/ImportTenantDocument

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

resident_idstringRequired

The Propexo unique identifier for the resident

Request

This endpoint expects an object.

integration_idstringRequired

The Propexo unique identifier for the integration

attachmentobjectRequired

PDF to attach to the Resident

Response

Successful response

metaobject

resultobject

Errors

400

Bad Request Error