Skip to main content
POST
Update an annotation

Authorizations

Authorization
string
header
required

API token for authentication

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"

title
string
required
Maximum string length: 100
Example:

"Pricing page redesign"

timezone
string

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

Example:

"Asia/Tokyo"

description
string
Maximum string length: 500
color
string

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

Pattern: ^#[0-9A-Fa-f]{6}$
Example:

"#3b82f6"

Response

Annotation updated

annotation
object