Declare crop + sowing date, root depth cap, or manual depth.

PUT /modules/{id}/crop

• Scope crop:write
• API key x-api-key
• Base URL https://api.hub.akuasense.com/v1

Side effect: clears the per-depth weights entered by hand (back to automatic computation).

Two exclusive modes: crop (cropId + plantingDate, plus zrCapCm if needed) or manual (manualZrCm). The declaration replaces the active crop; the previous one is closed, never erased.

Path parameters

• id integer required

Headers

• Idempotency-Key string

  Replays the same 2xx response (24 h)

Request body

• cropId integer

  Crop: code from GET /reference/crops. Exclusive with manualZrCm.

• plantingDate string date

  Planting or sowing date. Required with cropId.

• manualZrCm number

  Manual mode: root depth in cm, > 0. Exclusive with cropId.

• zrCapCm number

  Root depth cap in cm (crop mode only): Zr = min(species Zr, zrCapCm). For a plot where a water table, a plough pan or bedrock truncates rooting.

• notes string

Response

201

Declaration recorded

• success boolean always present
• row object always present
  Show 2 attributes Hide attributes

  • id integer always present

    The declaration created: id of GET /modules/{id}/crop.

  • timestamp_start string date-time always present

Errors

• 400

  Entry refused

  invalid_idinvalid_body
• 401

  Not authenticated

• 403

  Insufficient scope/role, or outside your company

PUT /modules/{id}/crop

cURL JavaScript Python

curl -X PUT https://api.hub.akuasense.com/v1/modules/1/crop \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "cropId": 75,
    "plantingDate": "2022-02-25"
  }'

const response = await fetch(
  'https://api.hub.akuasense.com/v1/modules/1/crop',
  {
    method: 'PUT',
    headers: {
      'x-api-key': 'YOUR_API_KEY',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      "cropId": 75,
      "plantingDate": "2022-02-25"
    }),
  },
);
const data = await response.json();

import requests

response = requests.put(
    "https://api.hub.akuasense.com/v1/modules/1/crop",
    headers={"x-api-key": "YOUR_API_KEY"},
    json={
        "cropId": 75,
        "plantingDate": "2022-02-25",
    },
)
data = response.json()

Response

201 400 401 403

{
  "success": true,
  "row": {
    "id": 29,
    "timestamp_start": "2026-08-25T17:41:03.111Z"
  }
}

application/json

{
  "type": "string",
  "title": "string",
  "status": 400,
  "detail": "string",
  "code": "invalid_id"
}

application/problem+json · example generated from the schema

{
  "type": "string",
  "title": "string",
  "status": 401,
  "detail": "string",
  "code": "string"
}

application/problem+json · example generated from the schema

{
  "type": "string",
  "title": "string",
  "status": 403,
  "detail": "string",
  "code": "string"
}

application/problem+json · example generated from the schema