Skip to main content
POST
Create an annotation

Authorizations

Authorization
string
header
required

API token for authentication

Body

application/json
workspace_id
string
required
Example:

"ws_1234567890"

annotated_at
string<date-time>
required

The moment to mark, as an RFC3339 instant.

Example:

"2026-08-15T09:00:00Z"

title
string
required
Maximum string length: 100
Example:

"Pricing page redesign"

timezone
string

IANA timezone the moment was entered in, kept for display. Defaults to the workspace timezone, then to UTC.

Example:

"Asia/Tokyo"

description
string
Maximum string length: 500
Example:

"Rolled out to all visitors after the A/B test."

color
string
default:#3b82f6
Pattern: ^#[0-9A-Fa-f]{6}$
Example:

"#3b82f6"

source
enum<string>
default:manual

Only manual is accepted. Sending broadcast is rejected rather than quietly downgraded: it would be claiming the slot of an automatic row.

Available options:
manual

Response

Annotation created

annotation
object