---
title: "Update Farm Boundary"
method: PUT
path: "/farms/{id}/boundary"
tags: ["Farms"]
---

# Update Farm Boundary

`PUT /farms/{id}/boundary`

## Request

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

Save (or clear) the property outline, and with it the geocoded map
label and the point the map opens on.

A dedicated endpoint rather than attributes on `updateFarm`, because it
is the single place three rules are enforced:

* **A typed area is never overwritten by a drawn one.**
  `area_source: "drawn"` recomputes `area_ha` from the ring;
  `area_source: "typed"` saves the ring and leaves `area_ha` exactly as
  it is. A request that names no source keeps the property's own, so
  omitting the field can never clobber a typed number; a property that
  has never had one gets `drawn`.
* **Geometry is repaired before it is measured.** Rings are validated
  (at least 4 positions, closed, finite, latitude within ±90 and
  longitude within ±180), repaired with `ST_MakeValid`, wound
  counter-clockwise and stored as a MultiPolygon — so a self-crossing
  ring cannot report a plausible-but-wrong hectare figure. The geometry
  read back may therefore be reordered or split into parts.
* **A saved ring always leaves the map a point to open on.** When the
  property has no centroid and the request names none, one is derived
  from the ring. An existing centroid is never moved.

Area is computed by PostGIS as `ST_Area(geography)` in hectares.

**Provenance.** `boundary_source` (traced | grid | gps | imported) is
the client's claim about how the ring was captured and travels with it;
`boundary_captured_by` is stamped server-side from the acting user and
is never accepted from the request. Both are cleared with the ring. A
property boundary writes no diary row — records attach to paddocks and
mobs, not to a property — and it is never distance-guarded the way a
paddock ring is: the property's own point may have been geocoded to the
town, and the ring is what corrects it. Requires edit rights on the
owner.

## Path parameters

- `id` string, required

## Query parameters

- `include` string

## Request body

- FarmBoundaryModelAttributes: Flat attributes-adapter request body (Content-Type application/json) for the property boundary. The same fields hoisted directly under `data` (no nested `attributes` envelope). Equivalent JSON:API (nested) shape: `FarmBoundaryModel` sent as application/vnd.api+json.
  - `data` object, required
    - `boundary` array[], nullable: The property outline: an array of rings, each ring an array of `[longitude, latitude]` pairs in RFC 7946 order — **longitude first** — with at least 4 positions and the first position repeated last. Not a GeoJSON object. Omit the key to leave the stored geometry untouched; send `null` to clear it.
      - array[]: One closed exterior ring.
        - number[]: [longitude, latitude]
    - `area_source` 'typed' | 'drawn', nullable: `drawn` recomputes `area_ha` from the ring; `typed` leaves `area_ha` untouched. Omitted, the property's own source stands.
    - `boundary_source` 'traced' | 'grid' | 'gps' | 'imported', nullable: How the ring being saved was captured. Provenance describes THIS ring: omitted alongside a new `boundary`, the stored source is reset to null rather than carried over from the ring it replaced; sent without a `boundary`, it corrects the stored ring's source in place. Cleared with the ring. `boundary_captured_by` is not accepted — the server stamps it from the acting user.
    - `place_label` string, nullable: The geocoded label shown under the property name on the map.
    - `centroid_lat` number, nullable: Latitude of the point the map opens on. Send both `centroid_lat` and `centroid_lon`, or neither.
    - `centroid_lon` number, nullable: Longitude of the point the map opens on. Send both `centroid_lat` and `centroid_lon`, or neither.

## Response `200`

The property with its saved boundary.

- FarmsShowResponseAttributes
  - `data` FarmModelAttributes: Single farm in attributes-adapter shape (Accept application/json).
    - `id` string
    - `type` string
    - `slug` string: Unique within its parent (a property per owner; a paddock or mob per property); generated from the name and renamed with it. The old slug keeps resolving. See `resolveLink`.
    - `visibility` 'private' | 'link' | 'public': Who can see the property and, through it, its paddocks, mobs and scoped task lists. `private` (default) is members only; `link` is anyone with the share token (`?share=`); `public` is anyone and search engines.
    - `web_path` string: The property's address on the web, e.g. `/organizations/hillcrest/properties/yarrabee`. Present on a property read directly.
    - `url` string: The whole link to hand someone; for a property shared by link it carries `?share=<token>`. Present on a property read directly.
    - `can_edit` boolean: Whether the caller may change the property. From the session's role, never the address. Present on a property read directly.
    - `share_token` string, nullable: The token behind `visibility=link`. Returned only to callers who can change who sees the property.
    - `name` string
    - `location` string, nullable
    - `size` string, nullable
    - `place_label` string, nullable: The geocoded label shown under the property name on the map, e.g. "1180 Kywong Road, Currawarna NSW 2650".
    - `centroid_lat` number, nullable: Latitude of the point the map opens on. Present exactly when `centroid_lon` is.
    - `centroid_lon` number, nullable: Longitude of the point the map opens on. Present exactly when `centroid_lat` is.
    - `boundary` array[], nullable: The property outline: an array of rings, each ring an array of `[longitude, latitude]` pairs in RFC 7946 order — **longitude first** — with at least 4 positions and the first repeated last. Not a GeoJSON object (see `FarmBoundaryModel`).
      - array[]: One closed exterior ring.
        - number[]: [longitude, latitude]
    - `boundary_captured_at` string, date-time, nullable: When the boundary was last saved. Null while the property has no ring.
    - `boundary_source` 'traced' | 'grid' | 'gps' | 'imported', nullable: How the ring was captured — traced over imagery, placed on the grid with no imagery, walked with the phone's GPS, or read from a KML/shapefile. Null for a ring saved before provenance was recorded or by a caller that named no source. Written with the ring and cleared with it.
    - `boundary_captured_by` string, nullable: Id of the user who saved the ring, stamped server-side from the request's actor and never accepted from a client. Null when a machine token saved it, and null while the property has no ring.
    - `area_ha` number, nullable: Property area in hectares. Measured from the boundary when `area_source` is `drawn`; the farmer's own number when it is `typed`.
    - `area_source` 'typed' | 'drawn', nullable: Where `area_ha` came from. A `typed` area is never overwritten by a drawn one.
    - `paddock_count` integer: How many LIVE paddocks the property has. Archived paddocks are not counted.
    - `mob_count` integer: How many LIVE mobs the property has. Archived mobs are not counted.
    - `blocks` PropertyBlock[]: The property's live blocks. Empty when every paddock is in the home block.
      - `id` string, uuid
      - `name` string
      - `kind` 'outblock' | 'irrigation_farm' | 'management'
      - `block_number` string, nullable: An optional number the business uses for the block, such as "Farm 89".
      - `paddock_ids` string[]: The ids of the live paddocks in the block, ordered by paddock name. Each of those paddocks has this block's id as its `block_id`.
      - `area_ha` number, nullable: The sum of the member paddocks' areas, in hectares. Null when no member has an area.
      - `hull` object, nullable: The convex hull of the member paddocks' boundaries as a GeoJSON geometry (usually a Polygon) in [lng, lat]. Null when no member has a boundary. For the map's dashed outline; not a boundary of its own.
        - `type` string
        - `coordinates` unknown[]
          - unknown
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `organization` object: Present when include=organization
    - `user` object, nullable: The person who owns a personal property (linkage only); null on a business's farm.
  - `meta` PaginationMeta
    - `current_page` number
    - `next_page` number, nullable
    - `prev_page` number, nullable

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `422`: A ring with fewer than 4 positions, an unclosed ring, a coordinate out of range, geometry that cannot be repaired into a polygon, a half-written centroid pair, or an unknown `boundary_source`

---

[API](https://skmtc.dev/purplegrain/apis/purple-grain-api.md) · [All operations](https://skmtc.dev/purplegrain/apis/purple-grain-api/llms.txt) · [OpenAPI document](https://skmtc.dev/purplegrain/apis/purple-grain-api/revisions/a9136f78e9fb?raw)