Spoar
Annotations

Change an annotation

PATCH
/v2/projects/{project}/annotations/{annotation}

Changes the fields sent and leaves the rest; null clears endDate, note or url.

Authorization

AuthorizationBearer <token>

An API token from POST /v2/tokens (at_live_...), or a project's secret key (sk_...) for server-side ingest.

In: header

Path Parameters

project*string

The project id, as listed by GET /v2/projects.

Length1 <= length
annotation*string

The annotation id (ann_...).

Request Body

Only the fields sent are changed; null clears endDate, note or url. Send at least one.

TypeScript Definitions

Use the request body type in TypeScript.

Only the fields sent are changed; null clears endDate, note or url. Send at least one.

Properties1 <= properties

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v2/projects/string/annotations/string" \  -H "Content-Type: application/json" \  -d '{    "endDate": null,    "kind": "incident"  }'
{  "data": {    "id": "ann_0192f0c4-3b1e-7d2a-9c4f-1a2b3c4d5e6f",    "project": "skriuw",    "title": "API outage",    "date": "2026-09-30T14:00:00.000Z",    "endDate": "2026-09-30T16:15:00.000Z",    "kind": "incident",    "note": "Database failover; ingest kept running.",    "url": null,    "createdAt": "2026-09-30T17:00:00.000Z",    "updatedAt": "2026-09-30T17:00:00.000Z"  }}