Update Paddock
Renaming a paddock, or changing its area, land use or crop, writes a record on its timeline — "Renamed from North Block · Area set to 90 ha — was 84 ha" — composed on the server, because three write surfaces edit a paddock and only the server sees before and after atomically. An update that changes none of those four fields writes nothing.
Archive and restore are this endpoint: archived: true hides the paddock from the map and the lists while its records stay on the property; archived: false brings it back. There is no /archive route. Archiving writes no record.
block_id moves the paddock between blocks: a live block of the same property puts it in that block, null takes it out to the home block. It writes no record. To regroup several paddocks at once use updateBlock with paddock_ids.
The owning property cannot be changed — a farm relationship sent here is ignored, so a paddock can never be re-parented and take its records with it. boundary is not accepted; see updatePaddockBoundary.
Requires organization edit rights.
Request
- Base URL: https://api.purplegrain.com/api/v1
- URL: https://api.purplegrain.com/api/v1/paddocks/{id}
- Auth: HTTP bearer
Path parameters
Id of the record
Query parameters
Comma-separated snake_case relationship paths to embed (JSON:API included array, or inlined for application/json). Never embedded by default; unknown paths ignored; dot notation selects children; max 10 paths. Allowed paths: farm, farm.organization.
Request body
Response
Updated
Example response
{
"data": {
"type": "paddock"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.