Skip to main content
POST

Authentication

Requires a key with the fields:write scope.

Path parameters

id
string
required
Farm UUID.

Request body

name
string
required
1–200 characters.
area
number | string
required
Positive number in the farm’s areaUnit.
description
string
Up to 2,000 characters.
boundaries
object
GeoJSON Polygon ({ type: "Polygon", coordinates: number[][][] }).
soilType
string
Up to 100 characters.
soilPh
number | string
Soil pH.
status
string
default:"active"
One of active, fallow, preparing, planted.
notes
string
Up to 5,000 characters.

Response

Returns the created field wrapped under data. See List fields for the full field reference.

Errors

StatusWhen
400 VALIDATION_ERRORBody validation failed (details carries per-field messages)
401Missing, malformed, expired, or revoked API key
403 INSUFFICIENT_SCOPEKey lacks fields:write scope
404 NOT_FOUNDFarm doesn’t exist or is not owned by the user
429 RATE_LIMIT_EXCEEDEDPer-user rate limit reached
5xxServer error