Farms

Create Farm

A name makes a property. It belongs to the business named by the organization relationship, or — with no organization — to the signed-in user's personal account (the user relationship may name them explicitly). centroid_lat / centroid_lon give a property with no outline yet a point for the map to open on — send both or neither.

boundary, area_ha and area_source are not accepted here: write the outline with updateFarmBoundary, which measures the area. Requires edit rights on the owner: a business's edit roles, or the person.

post/farms

Request

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

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

Created

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.