Kpis API: Add kpi annotation

Endpoint#

Property	Value
Type	mutation
Method	POST
Path	/api/external/v1/kpis/add_kpi_annotation
Handler	OperatelyWeb.Api.Kpis.AddKpiAnnotation

Authentication#

• Requires a valid API token.
• Requires a write-enabled token.
• Read-only tokens return 403.

Inputs#

Field	Type	Required	Nullable	Default
kpi_id	id primitive (encoded as string)	Yes	No	-
date	date	Yes	No	-
title	string	Yes	No	-

Outputs#

Field	Type	Required	Nullable
annotation	kpi_annotation object	Yes	No

cURL Example#

Copied

curl --request POST \
  --url "https://app.operately.com/api/external/v1/kpis/add_kpi_annotation" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{"date":"2026-01-01", "kpi_id":"value", "title":"value"}'

Response Example#

{
  "annotation": {
    "__typename": "value",
    "created_by": "<person>",
    "date": "2026-01-01",
    "id": "value",
    "inserted_at": "2026-01-01T09:30:00Z",
    "title": "value",
    "updated_at": "2026-01-01T09:30:00Z"
  }
}