Buildium Upload File
buildium_upload_fileUpload a local file to Buildium by handling its two-step presigned URL flow, including required category, entity, and upload path.
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 — call_endpoint would post the metadata and hand you a URL it cannot then PUT to. Use this instead.
file_path: path to the file on this machine title: the file's title in Buildium. In 'fixtures' write mode this must start with the fixture prefix (see buildium_health). category_id: from GET /v1/files/categories — required, and Buildium rejects the upload without a real one. entity_type: what the file is attached to — Rental, Lease, Tenant, Vendor, Association, RentalOwner, RentalUnit, and so on. entity_id: the ID of that record. upload_path: for files belonging to a bill, check, or task history, pass that resource's own uploads path, e.g. "/v1/bills/123/files/uploads". Only Buildium's seven upload-request endpoints are accepted here, in every mode.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| title | Yes | ||
| entity_id | No | ||
| file_path | Yes | ||
| category_id | Yes | ||
| description | No | ||
| entity_type | No | Rental | |
| upload_path | No | /v1/files/uploads |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||