Web Analytics

Update an annotation

POST https://demo.notifuse.com/api/annotations.update

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.

Authorizations

Authorization string header required

Bearer authentication header of the form Bearer <token>, where <token> is your API key.

Body application/json

workspace_id string required
  • Example: ws_1234567890
id string required
  • Example: 3f2504e04f8911d39a0c0305e82c3301
annotated_at string<date-time> required
  • Example: 2026-08-15T09:00:00Z
timezone string

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

  • Example: Asia/Tokyo
title string required
  • Maximum length: 100
  • Example: Pricing page redesign
description string
  • Maximum length: 500
color string

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

  • Example: #3b82f6

Response

200 Annotation updated object
annotation object
Show child attributes
id string required

Server-generated identifier (a UUID with its dashes removed).

  • Example: 3f2504e04f8911d39a0c0305e82c3301
annotated_at string<date-time> required

The moment the annotation marks, as a real instant.

  • Example: 2026-08-15T09:00:00Z
timezone string required

IANA timezone the moment was entered in. This is display intent only — annotated_at already fixes the instant, and filtering never uses this field. It is what lets "9am in Tokyo" render back as 9am instead of the reader's local equivalent.

  • Example: Asia/Tokyo
title string required

Counted in characters, not bytes.

  • Maximum length: 100
  • Example: Pricing page redesign
description string

Optional longer note. Counted in characters, not bytes.

  • Maximum length: 500
  • Example: Rolled out to all visitors after the A/B test.
color string required

Six-digit hex colour used for the marker on the charts.

  • Example: #3b82f6
source string required

Who wrote the row. manual is anything typed by an operator or posted to this API; broadcast rows are written automatically when a broadcast starts sending. There is deliberately no API source — see the note on annotations.create.

  • Available options: manual, broadcast
  • Example: manual
source_id string

The entity that caused an automatic annotation (a broadcast id today). Always absent on manual rows, and never settable through the API. An annotation outlives the entity it points at: deleting a broadcast leaves its annotation, because the send did happen.

  • Example: bcast_1234567890
created_at string<date-time> required
updated_at string<date-time> required
400 Bad request - unparseable body, validation failed, or the instance runs in demo mode. object
error string required

Error message

401 Unauthorized - invalid or missing authentication token object
error string required

Error message

403 Forbidden - missing required permission object
error string required

Error message

404 No annotation with that ID in this workspace object
error string required

Error message

500 Internal server error object
error string required

Error message