Buildium Upload File
buildium_upload_fileUpload a local file to Buildium by handling the two-step presigned URL flow, eliminating failed PUT attempts when using the API directly.
Instructions
Upload a local file to Buildium, handling both steps of its upload flow.
Bytes do not travel through the Buildium API. Buildium issues a short-lived AWS presigned PUT URL, and the file is sent there directly. Doing that by hand with buildium_call_endpoint does not work — it would post the metadata and hand you a URL it cannot then PUT to. Use this instead.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| title | Yes | The file's title in Buildium. In 'fixtures' write mode it must start with the fixture prefix (see buildium_health). | |
| entity_id | No | The ID of that record. | |
| file_path | Yes | Path to the file on this machine. Hidden files, *.env files and this server's own configuration are refused. | |
| category_id | Yes | File category, from GET /v1/files/categories. Buildium rejects the upload without a real one. | |
| description | No | Optional description stored with the file. | |
| entity_type | No | What the file is attached to: Rental, Lease, Tenant, Vendor, Association, RentalOwner, RentalUnit, and so on. | Rental |
| upload_path | No | For a file belonging to a bill, check or task history, that resource's own uploads path, e.g. "/v1/bills/123/files/uploads". Only Buildium's seven upload endpoints are accepted. | /v1/files/uploads |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||