Endpoint#
| Property | Value |
|---|
| Type | mutation |
| Method | POST |
| Path | /api/external/v1/kpis/delete_kpi |
| Handler | OperatelyWeb.Api.Kpis.DeleteKpi |
Authentication#
- Requires a valid API token.
- Requires a write-enabled token.
- Read-only tokens return
403.
| Field | Type | Required | Nullable | Default |
|---|
kpi_id | id primitive (encoded as string) | Yes | No | - |
Outputs#
| Field | Type | Required | Nullable |
|---|
kpi | kpi object | Yes | No |
cURL Example#
Copiedcurl --request POST \
--url "https://app.operately.com/api/external/v1/kpis/delete_kpi" \
--header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
--header "Content-Type: application/json" \
--data '{"kpi_id":"value"}'
Response Example#
{
"kpi": {
"__typename": "value",
"cadence": "value",
"champion": "<person>",
"entries": [
"<kpi_entry>"
],
"id": "value",
"inserted_at": "2026-01-01T09:30:00Z",
"latest_entry": "<kpi_entry>",
"name": "value",
"space_id": "value",
"unit": "value",
"updated_at": "2026-01-01T09:30:00Z"
}
}