Sign in
Web Analytics

Update an annotation

Edits an annotation's moment, timezone and presentation. Requires the web_analytics write permission.

Automatic annotations are editable — an operator may want to reword a broadcast's title — but their origin is not: source and source_id are reloaded from storage and carried forward, so an edit can neither promote a manual row to a system one nor take over another broadcast's slot.

post/api/annotations.update

Request body

workspace_idstring required
idstring required
annotated_atstring date-time required
timezonestring

Falls back to the annotation's stored timezone when omitted.

titlestring required
descriptionstring
colorstring

Falls back to the annotation's stored colour when omitted.

Example request

{
  "workspace_id": "ws_1234567890",
  "id": "3f2504e04f8911d39a0c0305e82c3301",
  "annotated_at": "2026-08-15T09:00:00Z",
  "timezone": "Asia/Tokyo",
  "title": "Pricing page redesign",
  "color": "#3b82f6"
}

Response

Annotation updated

Example response

{
  "annotation": {
    "id": "3f2504e04f8911d39a0c0305e82c3301",
    "annotated_at": "2026-08-15T09:00:00Z",
    "timezone": "Asia/Tokyo",
    "title": "Pricing page redesign",
    "description": "Rolled out to all visitors after the A/B test.",
    "color": "#3b82f6",
    "source": "manual",
    "source_id": "bcast_1234567890"
  }
}

Changes