Farms

Update Farm

Rename the property or change its labels (location, size, place_label) and its map point (centroid_lat / centroid_lon, both or neither). The owner cannot be changed.

boundary, area_ha and area_source are not accepted — see updateFarmBoundary. Requires edit rights on the owner.

put/farms/{id}

Request

  • Base URL: https://api.purplegrain.com/api/v1
  • URL: https://api.purplegrain.com/api/v1/farms/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Id of the record

Query parameters

includestring
Example:organization

Comma-separated snake_case relationship paths to embed (JSON:API included array, or inlined for application/json). Never embedded by default; unknown paths ignored; max 10 paths. Allowed paths: organization.

Request body

Response

Updated

Example response

{
  "data": {
    "type": "farm",
    "blocks": [
      {
        "name": "Racecourse block",
        "hull": {
          "type": "Polygon"
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.