Buildium Call Endpoint
buildium_call_endpointPerform write operations (POST, PUT, PATCH, DELETE) on Buildium API endpoints. Use for creating, updating, or deleting records with built-in guardrails for safe writes.
Instructions
Call any Buildium endpoint: the tool for writes.
For reads use buildium_get, which is read-only and so can be approved once.
Write guardrails apply — see buildium_health for the active mode. In the default 'fixtures' mode, every name in a create payload must carry the fixture prefix, nested ones included; a create whose payload has no name field at all is allowed against the sandbox but refused against production, since nothing on it could carry the prefix. Updates and deletes only work on records created this session, and off the sandbox so do creates under an existing record, such as a lease renewal.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | JSON request body. Usually an object; a few endpoints, such as custom field values, take a list. buildium_describe_endpoint shows which. | |
| path | Yes | Buildium API path, e.g. "/v1/vendors" or "/v1/leases/12345". | |
| query | No | Query-string parameters, e.g. {"statuses": "Active"}. | |
| fields | No | Keep only these top-level fields in each record, e.g. ["Id", "Name"]. Buildium records are large and carry tax IDs and addresses you may not need. | |
| method | Yes | POST, PUT, PATCH or DELETE. GET also works, but buildium_get is the tool for reads. | |
| confirm | No | Must be true for DELETE. | |
| all_pages | No | GET only; see buildium_get. | |
| count_only | No | GET only; see buildium_get. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||