Update a threshold

PATCH /alerts/{id}

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

Only the fields sent are changed.

Path parameters

• id string uuid required

Headers

• Idempotency-Key string

  Replays the same 2xx response (24 h)

Request body

• threshold number

  Threshold, in % volumetric moisture.

• hysteresis number

  Resolution margin, in percentage points.

• reminderTime string

  Local time of the daily reminder (HH:MM:SS).

• isActive boolean

  false disables the alert, true re-enables it.

Response

200

Alert updated

• id string uuid always present
• companyId integer always present
• moduleId integer nullable always present

  Module being watched.

• parcelId integer nullable always present

  Parcel. ⚠️ Only a module’s measurements are evaluated: an alert with no moduleId never fires.

• annotationId string uuid nullable always present

  The “wilting point” line the alert was born from (source: annotation). Moving the line moves the threshold; deleting it disables the alert.

• threshold string always present

  Threshold, in % volumetric moisture.

• hysteresis string always present

  Resolution margin, in percentage points: the alert resolves at threshold + hysteresis.

• reminderTime string always present

  LOCAL time of the daily reminder (HH:MM:SS), in the company’s time zone (timezone of GET /company).

• source string always present

  manual: created directly (POST /alerts). annotation: born from a “wilting point” line.

  Values: manualannotation
• isActive boolean always present

  false: disabled, no longer evaluated.

• createdBy string always present

  Creator: userId of a member.

• createdAt string date-time always present
• updatedAt string date-time always present

Errors

• 400

  Invalid body

• 401

  Not authenticated

• 403

  Insufficient scope/role, or outside your company

PATCH /alerts/{id}

cURL JavaScript Python

curl -X PATCH https://api.hub.akuasense.com/v1/alerts/6f1d0b9e-2c4a-4e8b-9d3f-7a5c1e2b8d40 \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "threshold": 10
  }'

const response = await fetch(
  'https://api.hub.akuasense.com/v1/alerts/6f1d0b9e-2c4a-4e8b-9d3f-7a5c1e2b8d40',
  {
    method: 'PATCH',
    headers: {
      'x-api-key': 'YOUR_API_KEY',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      "threshold": 10
    }),
  },
);
const data = await response.json();

import requests

response = requests.patch(
    "https://api.hub.akuasense.com/v1/alerts/6f1d0b9e-2c4a-4e8b-9d3f-7a5c1e2b8d40",
    headers={"x-api-key": "YOUR_API_KEY"},
    json={
        "threshold": 10,
    },
)
data = response.json()

Response

200 400 401 403

{
  "id": "6f1d0b9e-2c4a-4e8b-9d3f-7a5c1e2b8d40",
  "companyId": 8,
  "moduleId": 145,
  "parcelId": null,
  "annotationId": null,
  "threshold": "10",
  "hysteresis": "5",
  "reminderTime": "07:30:00",
  "source": "manual",
  "isActive": true,
  "createdBy": "cmf8x2k4q0002js08h4m2c8kv",
  "createdAt": "2026-09-11T09:02:14.318Z",
  "updatedAt": "2026-09-11T09:05:41.027Z"
}

application/json

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

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