PUpurplegrain
Properties

Update Property

Changed on

Rename the property or change its labels (location, size, place_label), its pic and state, reef_catchment, and its map point (centroid_lat / centroid_lon, both or neither). The owner cannot be changed. pic is one code of 8 letters or digits, stored uppercase; blank clears it.

boundary, area_ha and area_source are not accepted — see updatePropertyBoundary. Requires edit rights on the owner. Assistants and API keys cannot widen visibility to link or public. Setting it to private, or leaving it unchanged, is allowed.

patch/properties/{id}

Request

  • Base URL
    https://api.purplegrain.com/api/v1
  • URL
    https://api.purplegrain.com/api/v1/properties/{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; a path outside the allowed list is refused with 400 unknown_include (see the 400 response); max 10 paths. Allowed paths: organization.

Request body

Response

Updated

Example response

{
  "data": {
    "type": "property",
    "blocks": [
      {
        "name": "Racecourse block",
        "hull": {
          "type": "Polygon"
        }
      }
    ]
  },
  "_meta": {
    "onboarding": {
      "skill": "pg-onboarding@1"
    }
  }
}

Changes

  • e32f34ba218bRevision changes
    • info

      added the optional property // to the response with the status

  • 143d65e52617Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status