Update an annotation

PATCH /annotations/{id}

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

chart_type, type and unit are frozen at creation. ⚠️ content, style and text write BRAND-NEW content: text alone wipes the style — send both. Moving a wilting-point line moves the threshold of its alert. A drawing that is not in vwc cannot become a threshold (THRESHOLD_REQUIRES_VWC).

Path parameters

id string uuid required

Headers

Idempotency-Key string

Replays the same 2xx response (24 h)

Request body

p1 array of any

A point of the curve, [instant, value]: the instant in milliseconds since 1 January 1970 UTC, the value in the annotation’s unit (unit; for moisture, % VWC by default).
p2 array of any

A point of the curve, [instant, value]: the instant in milliseconds since 1 January 1970 UTC, the value in the annotation’s unit (unit; for moisture, % VWC by default).
content object

Style and text: { style, text }. Replaces the whole content.
style object

Shorthand, written into content.style.
text string

Shorthand, written into content.text.

Response

200

Annotation updated

id string uuid always present
module_id integer always present
probe_id any nullable always present

Deprecated: always null.
chart_type string always present

Hub curve the annotation belongs to. humidity: the summary curve, weighted moisture — this is the one carrying the agronomic thresholds. humidity-detail: moisture per depth. humidity-heatmap: heat map. temperature: temperature. tensio: tensiometer probe (tension is still accepted on input).

Values: humidityhumidity-detailhumidity-heatmaptemperaturetensio
type string always present

Shape of the drawing, as the hub’s tools draw it: h-line (horizontal line), v-line (vertical), segment, ray (half-line), infinite (full line), arrow, h-free, rect (area), text. Older annotations carry line.
p1 array of any always present

A point of the curve, [instant, value]: the instant in milliseconds since 1 January 1970 UTC, the value in the annotation’s unit (unit; for moisture, % VWC by default).
p2 array of any nullable always present

Second point, for drawings that have two.
unit string nullable always present

Unit of the points’ height (p1, p2), that is, the view of the curve the annotation belongs to: it is only shown in that unit. humidity and humidity-detail curves only: vwc — volumetric water content, %, the reference unit, the one used by the alert and the water status —, vwc_max — share of soil saturation, % —, mm. null on the other curves, which have a single unit.

Values: vwcvwc_maxmmnull
content object always present

Style and text of the drawing: { style, text }.
user_id string always present

Author: userId of a member (GET /company/users).
created_at string date-time always present
updated_at string date-time always present
style object

Copy of content.style, present when there is one.
text string

Copy of content.text, present when there is one.

Errors

400
Entry refused

THRESHOLD_REQUIRES_VWC
401
Not authenticated
403
Insufficient scope/role, or outside your company
404
Annotation not found

not_found

PATCH /annotations/{id}

curl -X PATCH https://api.hub.akuasense.com/v1/annotations/c98af727-6006-4f97-a498-ffe04b997b93 \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "p1": [
      1781208270784.069,
      11
    ],
    "p2": [
      1781208270784.069,
      11
    ]
  }'

const response = await fetch(
  'https://api.hub.akuasense.com/v1/annotations/c98af727-6006-4f97-a498-ffe04b997b93',
  {
    method: 'PATCH',
    headers: {
      'x-api-key': 'YOUR_API_KEY',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      "p1": [
        1781208270784.069,
        11
      ],
      "p2": [
        1781208270784.069,
        11
      ]
    }),
  },
);
const data = await response.json();

import requests

response = requests.patch(
    "https://api.hub.akuasense.com/v1/annotations/c98af727-6006-4f97-a498-ffe04b997b93",
    headers={"x-api-key": "YOUR_API_KEY"},
    json={
        "p1": [
            1781208270784.069,
            11,
        ],
        "p2": [
            1781208270784.069,
            11,
        ],
    },
)
data = response.json()

Response

{
  "id": "c98af727-6006-4f97-a498-ffe04b997b93",
  "module_id": 145,
  "probe_id": null,
  "chart_type": "humidity",
  "type": "h-line",
  "p1": [
    1781208270784.069,
    11
  ],
  "p2": [
    1781208270784.069,
    11
  ],
  "unit": "vwc",
  "content": {
    "style": {
      "fill": "threshold2",
      "stroke": "var(--destructive)",
      "lineDash": "dashed",
      "lineWidth": 2
    }
  },
  "user_id": "cmf8x2k4q0002js08h4m2c8kv",
  "created_at": "2026-06-18T19:51:08.446Z",
  "updated_at": "2026-06-18T19:51:29.699Z",
  "style": {
    "fill": "threshold2",
    "stroke": "var(--destructive)",
    "lineDash": "dashed",
    "lineWidth": 2
  }
}

application/json

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

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

{
  "type": "string",
  "title": "string",
  "status": 404,
  "detail": "string",
  "code": "not_found"
}

application/problem+json · example generated from the schema