Paddocks

Create Paddock

A name is a valid paddock — everything else arrives later, and the map lists a paddock with no ring as "by name" rather than as incomplete.

Names are unique per property, case-insensitively, across live AND archived paddocks: reusing the name of one that was archived is rejected here, where a name is being typed, rather than stranding the archived paddock with no way to be restored.

boundary is not accepted — the ring is written through updatePaddockBoundary. Requires organization edit rights.

post/paddocks

Request

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

Query parameters

includestring
Example:farm.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; dot notation selects children; max 10 paths. Allowed paths: farm, farm.organization.

Request body

Response

Created

Example response

{
  "data": {
    "type": "paddock"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.