https://demo.notifuse.com/api/annotations.create Creates a manual annotation. Requires the web_analytics write permission.
source is always stored as manual and source_id is always empty: only the platform writes automatic rows, so there is no way to attach a caller-supplied key to one. This endpoint is therefore not idempotent — a retried call (a CI job re-running a deploy marker, for instance) writes a second annotation. De-duplicate on the caller's side, or delete the extra row.
Omitted color and timezone are filled in server-side: the default colour, and the workspace timezone falling back to UTC.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your API key.
Body application/json
- Example: ws_1234567890
The moment to mark, as an RFC3339 instant.
- Example: 2026-08-15T09:00:00Z
IANA timezone the moment was entered in, kept for display. Defaults to the workspace timezone, then to UTC.
- Example: Asia/Tokyo
- Maximum length: 100
- Example: Pricing page redesign
- Maximum length: 500
- Example: Rolled out to all visitors after the A/B test.
- Default: #3b82f6
- Example: #3b82f6
Only manual is accepted. Sending broadcast is rejected rather than quietly downgraded: it would be claiming the slot of an automatic row.
- Default: manual
- Available options: manual
Response
201 Annotation created object
Show child attributes
Server-generated identifier (a UUID with its dashes removed).
- Example: 3f2504e04f8911d39a0c0305e82c3301
The moment the annotation marks, as a real instant.
- Example: 2026-08-15T09:00:00Z
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
Counted in characters, not bytes.
- Maximum length: 100
- Example: Pricing page redesign
Optional longer note. Counted in characters, not bytes.
- Maximum length: 500
- Example: Rolled out to all visitors after the A/B test.
Six-digit hex colour used for the marker on the charts.
- Example: #3b82f6
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
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
400 Bad request - unparseable body, validation failed, or the instance runs in demo mode, where every mutating endpoint is closed. object
Error message
401 Unauthorized - invalid or missing authentication token object
Error message
403 Forbidden - missing required permission object
Error message
500 Internal server error object
Error message